Inheritance diagram for ilRepositorySearchGUI:

Collaboration diagram for ilRepositorySearchGUI:

Public Member Functions
	__construct ()
	Constructor @access public. More...

	addUserAccessFilterCallable (callable $user_filter)
	Closure for filtering users e.g $rep_search_gui->addUserAccessFilterCallable(function($user_ids) use($ref_id,$rbac_perm,$pos_perm)) { // filter users return $filtered_users }. More...

	setTitle ($a_title)
	Set form title. More...

	getTitle ()
	Get search form title. More...

	enableSearchableCheck ($a_status)
	En/disable the validation of the searchable flag. More...

	isSearchableCheckEnabled ()

	setPrivacyMode ($privacy_mode)

	getPrivacyMode ()

	setString ($a_str)
	Set/get search string @access public. More...

	getString ()

	executeCommand ()
	Control @access public. More...

	__clearSession ()

	cancel ()

	start ()

	addRole ()

	addUser ()

	setCallback (&$class, $method, $a_add_options=array())

	setRoleCallback (&$class, $method, $a_add_options=array())

	setPermissionQueryCallback ($class, $method)
	Set callback method for user permission access queries. More...

	showSearch ()

	showSearchSelected ()
	submit from autocomplete More...

	initFormSearch (ilObjUser $user=null)

	show ()

	appendSearch ()

	performSearch ()
	Perform a search. More...

	__performUserSearch ()

	__performGroupSearch ()
	Search groups. More...

	__performRoleSearch ()
	Search roles. More...

&	__parseQueryString ($a_string, $a_combination_or=true, $a_ignore_length=false)
	parse query string, using query parser instance More...

	__loadQueries ()

	__setSearchType ()

	__updateResults ()

	__appendToStoredResults ($a_usr_ids)

	__storeEntries (&$new_res)

	showSearchResults ()

	searchResultFilterListener ($a_ref_id, $a_data)
	Listener called from ilSearchResult Id is obj_id for role, usr Id is ref_id for crs grp. More...

	allowObjectSelection ($a_value=false)
	Toggle object selection status. More...

	setUserLimitations ($a_limitations)
	allow user limitations like inactive and access limitations More...

	getUserLimitations ()
	allow user limitations like inactive and access limitations More...

Static Public Member Functions
static	fillAutoCompleteToolbar ($parent_object, ilToolbarGUI $toolbar=null, $a_options=array(), $a_sticky=false)
	fill toolbar with More...

Data Fields
	$search_type = 'usr'

Protected Member Functions
	doUserAutoComplete ()
	Do auto completion. More...

	addUserFromAutoComplete ()
	Add user from auto complete input. More...

	showClipboard ()

	addFromClipboard ()
	add users from clipboard More...

	removeFromClipboard ()
	Remove from clipboard. More...

	emptyClipboard ()
	Remove from clipboard. More...

	handleMultiCommand ()
	Handle multi command. More...

	__performCourseSearch ()
	Search courses. More...

	addNewSearchButton ()
	Add new search button. More...

	showSearchUserTable ($a_usr_ids, $a_parent_cmd)
	Show usr table. More...

	showSearchRoleTable ($a_obj_ids)
	Show usr table. More...

	showSearchGroupTable ($a_obj_ids)

	showSearchCourseTable ($a_obj_ids)

	listUsers ()
	List users of course/group/roles. More...

	storedUserList ()
	Called from table sort. More...

	selectObject ()
	Return selection of course/group/roles to calling script. More...

Protected Attributes
	$add_options = array()

	$object_selection = false

	$searchable_check = true

	$search_title = ''

	$user_limitations = true

	$user_filter = null

	$tree

	$ui_renderer

	$ui_factory

Private Attributes
	$search_results = array()

	$privacy_mode = ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING

Detailed Description

Definition at line 43 of file class.ilRepositorySearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepositorySearchGUI::__construct ( )

Constructor @access public.

Definition at line 84 of file class.ilRepositorySearchGUI.php.

    {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $tree = $DIC['tree'];
        $ui_renderer = $DIC["ui.renderer"];
        $ui_factory = $DIC["ui.factory"];
 
        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;
        $this->tree = $tree;
        $this->ui_renderer = $ui_renderer;
        $this->ui_factory = $ui_factory;
 
        $this->lng = $lng;
        $this->lng->loadLanguageModule('search');
        $this->lng->loadLanguageModule('crs');
 
        $this->setTitle($this->lng->txt('add_members_header'));
 
        $this->__setSearchType();
        $this->__loadQueries();
 
        $this->result_obj = new ilSearchResult();
        $this->result_obj->setMaxHits(1000000);
        $this->settings = new ilSearchSettings();
    }

References $DIC, $ilCtrl, $lng, $tpl, $tree, $ui_factory, $ui_renderer, __loadQueries(), __setSearchType(), settings(), and setTitle().

Here is the call graph for this function:

Member Function Documentation

◆ __appendToStoredResults()

ilRepositorySearchGUI::__appendToStoredResults ( $a_usr_ids )

Definition at line 1083 of file class.ilRepositorySearchGUI.php.

    {
        if (!$_SESSION['search_append']) {
            return $_SESSION['rep_search']['usr'] = $a_usr_ids;
        }
        $_SESSION['rep_search']['usr'] = array();
        foreach ($a_usr_ids as $usr_id) {
            $_SESSION['rep_search']['usr'][] = $usr_id;
        }
        return $_SESSION['rep_search']['usr'] ? array_unique($_SESSION['rep_search']['usr']) : array();
    }

References $_SESSION.

Referenced by listUsers().

Here is the caller graph for this function:

◆ __clearSession()

ilRepositorySearchGUI::__clearSession ( )

Definition at line 418 of file class.ilRepositorySearchGUI.php.

    {
        unset($_SESSION['rep_search']);
        unset($_SESSION['append_results']);
        unset($_SESSION['rep_query']);
        unset($_SESSION['rep_search_type']);
    }

References $_SESSION.

Referenced by start().

Here is the caller graph for this function:

◆ __loadQueries()

ilRepositorySearchGUI::__loadQueries ( )

Definition at line 1039 of file class.ilRepositorySearchGUI.php.

    {
        if (is_array($_POST['rep_query'])) {
            $_SESSION['rep_query'] = $_POST['rep_query'];
        }
    }

References $_POST, and $_SESSION.

Referenced by __construct().

Here is the caller graph for this function:

◆ __parseQueryString()

& ilRepositorySearchGUI::__parseQueryString	(	$a_string,
		$a_combination_or = `true`,
		$a_ignore_length = `false`
	)

parse query string, using query parser instance

Returns: object of query parser or error message if an error occured @access public

Definition at line 1019 of file class.ilRepositorySearchGUI.php.

    {
        $query_parser = new ilQueryParser(ilUtil::stripSlashes($a_string));
        $query_parser->setCombination($a_combination_or ? QP_COMBINATION_OR : QP_COMBINATION_AND);
        $query_parser->setMinWordLength(1);
        
        // #17502
        if (!(bool) $a_ignore_length) {
            $query_parser->setGlobalMinLength(3); // #14768
        }
        
        $query_parser->parse();
 
        if (!$query_parser->validate()) {
            return $query_parser->getMessage();
        }
        return $query_parser;
    }

References QP_COMBINATION_AND, QP_COMBINATION_OR, and ilUtil\stripSlashes().

Referenced by __performCourseSearch(), __performGroupSearch(), __performRoleSearch(), and __performUserSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performCourseSearch()

ilRepositorySearchGUI::__performCourseSearch ( )

protected

Search courses.

Returns

Definition at line 973 of file class.ilRepositorySearchGUI.php.

    {
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
        $query_string = $_SESSION['rep_query']['crs']['title'];
        if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
            ilUtil::sendInfo($query_parser, true);
            return false;
        }
 
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFilter(array('crs'));
        $this->__storeEntries($object_search->performSearch());
 
        return true;
    }

References $_SESSION, __parseQueryString(), __storeEntries(), and ilUtil\sendInfo().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performGroupSearch()

ilRepositorySearchGUI::__performGroupSearch ( )

Search groups.

Returns

Definition at line 951 of file class.ilRepositorySearchGUI.php.

    {
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
        $query_string = $_SESSION['rep_query']['grp']['title'];
        if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
            ilUtil::sendInfo($query_parser, true);
            return false;
        }
 
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFilter(array('grp'));
        $this->__storeEntries($object_search->performSearch());
 
        return true;
    }

References $_SESSION, __parseQueryString(), __storeEntries(), and ilUtil\sendInfo().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performRoleSearch()

ilRepositorySearchGUI::__performRoleSearch ( )

Search roles.

Returns

Definition at line 995 of file class.ilRepositorySearchGUI.php.

    {
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
        $query_string = $_SESSION['rep_query']['role']['title'];
        if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
            ilUtil::sendInfo($query_parser, true);
            return false;
        }
        
        // Perform like search
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFilter(array('role'));
        $this->__storeEntries($object_search->performSearch());
 
        return true;
    }

References $_SESSION, __parseQueryString(), __storeEntries(), and ilUtil\sendInfo().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performUserSearch()

ilRepositorySearchGUI::__performUserSearch ( )

Definition at line 881 of file class.ilRepositorySearchGUI.php.

    {
        include_once 'Services/Search/classes/class.ilUserSearchOptions.php';
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
 
        foreach (ilUserSearchOptions::_getSearchableFieldsInfo(!$this->isSearchableCheckEnabled()) as $info) {
            $name = $info['db'];
            $query_string = $_SESSION['rep_query']['usr'][$name];
 
            // continue if no query string is given
            if (!$query_string) {
                continue;
            }
        
            if (!is_object($query_parser = $this->__parseQueryString($query_string, true, ($info['type'] == FIELD_TYPE_SELECT)))) {
                ilUtil::sendInfo($query_parser);
                return false;
            }
            switch ($info['type']) {
                case FIELD_TYPE_UDF_SELECT:
                    // Do a phrase query for select fields
                    $query_parser = $this->__parseQueryString('"' . $query_string . '"');
                            
                    // no break
                case FIELD_TYPE_UDF_TEXT:
                    $udf_search = ilObjectSearchFactory::_getUserDefinedFieldSearchInstance($query_parser);
                    $udf_search->setFields(array($name));
                    $result_obj = $udf_search->performSearch();
 
                    // Store entries
                    $this->__storeEntries($result_obj);
                    break;
 
                case FIELD_TYPE_SELECT:
                    
                    if ($info['db'] == 'org_units') {
                        $user_search = ilObjectSearchFactory::getUserOrgUnitAssignmentInstance($query_parser);
                        $result_obj = $user_search->performSearch();
                        $this->__storeEntries($result_obj);
                        break;
                    }
                    
                    // Do a phrase query for select fields
                    $query_parser = $this->__parseQueryString('"' . $query_string . '"', true, true);
 
                    // no break
                case FIELD_TYPE_TEXT:
                    $user_search = &ilObjectSearchFactory::_getUserSearchInstance($query_parser);
                    $user_search->setFields(array($name));
                    $result_obj = $user_search->performSearch();
 
                    // store entries
                    $this->__storeEntries($result_obj);
                    break;
                
                case FIELD_TYPE_MULTI:
                    $multi_search = ilObjectSearchFactory::getUserMultiFieldSearchInstance($query_parser);
                    $multi_search->setFields(array($name));
                    $result_obj = $multi_search->performSearch();
                    $this->__storeEntries($result_obj);
                    break;
                
            }
        }
    }

References $_SESSION, $name, __parseQueryString(), __storeEntries(), ilUserSearchOptions\_getSearchableFieldsInfo(), ilObjectSearchFactory\_getUserDefinedFieldSearchInstance(), ilObjectSearchFactory\_getUserSearchInstance(), FIELD_TYPE_MULTI, FIELD_TYPE_SELECT, FIELD_TYPE_TEXT, FIELD_TYPE_UDF_SELECT, FIELD_TYPE_UDF_TEXT, ilObjectSearchFactory\getUserMultiFieldSearchInstance(), ilObjectSearchFactory\getUserOrgUnitAssignmentInstance(), isSearchableCheckEnabled(), and ilUtil\sendInfo().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __setSearchType()

ilRepositorySearchGUI::__setSearchType ( )

Definition at line 1047 of file class.ilRepositorySearchGUI.php.

    {
        // Update search type. Default to user search
        if ($_POST['search_for']) {
            #echo 1;
            $_SESSION['rep_search_type'] = $_POST['search_for'];
        }
        if (!$_POST['search_for'] and !$_SESSION['rep_search_type']) {
            #echo 2;
            $_SESSION['rep_search_type'] = 'usr';
        }
        
        $this->search_type = $_SESSION['rep_search_type'];
        #echo $this->search_type;
 
        return true;
    }

References $_POST, and $_SESSION.

Referenced by __construct().

Here is the caller graph for this function:

◆ __storeEntries()

ilRepositorySearchGUI::__storeEntries ( & $new_res )

Definition at line 1095 of file class.ilRepositorySearchGUI.php.

    {
        if ($this->stored == false) {
            $this->result_obj->mergeEntries($new_res);
            $this->stored = true;
            return true;
        } else {
            $this->result_obj->intersectEntries($new_res);
            return true;
        }
    }

Referenced by __performCourseSearch(), __performGroupSearch(), __performRoleSearch(), and __performUserSearch().

Here is the caller graph for this function:

◆ __updateResults()

ilRepositorySearchGUI::__updateResults ( )

Definition at line 1066 of file class.ilRepositorySearchGUI.php.

    {
        if (!$_SESSION['search_append']) {
            $_SESSION['rep_search'] = array();
        }
        foreach ($this->search_results as $result) {
            $_SESSION['rep_search'][$this->search_type][] = $result;
        }
        if (!$_SESSION['rep_search'][$this->search_type]) {
            $_SESSION['rep_search'][$this->search_type] = array();
        } else {
            // remove duplicate entries
            $_SESSION['rep_search'][$this->search_type] = array_unique($_SESSION['rep_search'][$this->search_type]);
        }
        return true;
    }

References $_SESSION, $result, and $search_type.

Referenced by performSearch().

Here is the caller graph for this function:

◆ addFromClipboard()

ilRepositorySearchGUI::addFromClipboard ( )

protected

add users from clipboard

Definition at line 526 of file class.ilRepositorySearchGUI.php.

    {
        $GLOBALS['DIC']['ilCtrl']->setParameter($this, 'user_type', (int) $_REQUEST['user_type']);
        $users = (array) $_POST['uids'];
        if (!count($users)) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $GLOBALS['DIC']['ilCtrl']->redirect($this, 'showClipboard');
        }
        $class = $this->callback['class'];
        $method = $this->callback['method'];
        $user_type = isset($_REQUEST['user_type']) ? $_REQUEST['user_type'] : 0;
 
        if (!$class->$method($users, $user_type)) {
            $GLOBALS['DIC']['ilCtrl']->returnToParent($this);
        }
    }

References $_POST, $GLOBALS, and ilUtil\sendFailure().

Here is the call graph for this function:

◆ addNewSearchButton()

ilRepositorySearchGUI::addNewSearchButton ( )

protected

Add new search button.

Returns

Definition at line 1111 of file class.ilRepositorySearchGUI.php.

    {
        include_once './Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
        $toolbar = new ilToolbarGUI();
        $toolbar->addButton(
            $this->lng->txt('search_new'),
            $this->ctrl->getLinkTarget($this, 'showSearch')
        );
        $this->tpl->setVariable('ACTION_BUTTONS', $toolbar->getHTML());
    }

Referenced by listUsers(), showSearchResults(), and showSearchSelected().

Here is the caller graph for this function:

◆ addRole()

ilRepositorySearchGUI::addRole ( )

Definition at line 441 of file class.ilRepositorySearchGUI.php.

    {
        $class = $this->role_callback['class'];
        $method = $this->role_callback['method'];
 
        // call callback if that function does give a return value => show error message
        // listener redirects if everything is ok.
        $obj_ids = (array) $_POST['obj'];
        $role_ids = array();
        foreach ($obj_ids as $id) {
            $obj_type = ilObject::_lookupType($id);
            if ($obj_type == "crs" || $obj_type == "grp") {
                $refs = ilObject::_getAllReferences($id);
                $ref_id = end($refs);
                $mem_role = ilParticipants::getDefaultMemberRole($ref_id);
                $role_ids[] = $mem_role;
            } else {
                $role_ids[] = $id;
            }
        }
        $class->$method((array) $role_ids);
 
        $this->showSearchResults();
    }

References $_POST, ilObject\_getAllReferences(), ilObject\_lookupType(), ilParticipants\getDefaultMemberRole(), and showSearchResults().

Here is the call graph for this function:

◆ addUser()

ilRepositorySearchGUI::addUser ( )

Reimplemented in ilStudyProgrammeRepositorySearchGUI.

Definition at line 466 of file class.ilRepositorySearchGUI.php.

    {
        $class = $this->callback['class'];
        $method = $this->callback['method'];
        
        // call callback if that function does give a return value => show error message
        // listener redirects if everything is ok.
        $class->$method((array) $_POST['user']);
 
        $this->showSearchResults();
    }

References $_POST, and showSearchResults().

Here is the call graph for this function:

◆ addUserAccessFilterCallable()

ilRepositorySearchGUI::addUserAccessFilterCallable ( callable $user_filter )

Closure for filtering users e.g $rep_search_gui->addUserAccessFilterCallable(function($user_ids) use($ref_id,$rbac_perm,$pos_perm)) { // filter users return $filtered_users }.

Parameters

callable $user_filter

Definition at line 124 of file class.ilRepositorySearchGUI.php.

    {
        $this->user_filter = $user_filter;
    }

References $user_filter.

◆ addUserFromAutoComplete()

ilRepositorySearchGUI::addUserFromAutoComplete ( )

protected

Add user from auto complete input.

Definition at line 481 of file class.ilRepositorySearchGUI.php.

    {
        $class = $this->callback['class'];
        $method = $this->callback['method'];
 
        $users = explode(',', $_POST['user_login']);
        $user_ids = array();
        foreach ($users as $user) {
            $user_id = ilObjUser::_lookupId($user);
            if ($user_id) {
                $user_ids[] = $user_id;
            }
        }
 
        $user_type = isset($_REQUEST['user_type']) ? $_REQUEST['user_type'] : 0;
 
        if (!$class->$method($user_ids, $user_type)) {
            $GLOBALS['DIC']['ilCtrl']->returnToParent($this);
        }
    }

References $_POST, $GLOBALS, and ilObjUser\_lookupId().

Here is the call graph for this function:

◆ allowObjectSelection()

ilRepositorySearchGUI::allowObjectSelection ( $a_value = false )

Toggle object selection status.

Parameters

bool $a_value

Definition at line 1353 of file class.ilRepositorySearchGUI.php.

    {
        $this->object_selection = (bool) $a_value;
    }

◆ appendSearch()

ilRepositorySearchGUI::appendSearch ( )

Definition at line 774 of file class.ilRepositorySearchGUI.php.

    {
        $_SESSION['search_append'] = true;
        $this->performSearch();
    }

References $_SESSION, and performSearch().

Here is the call graph for this function:

◆ cancel()

ilRepositorySearchGUI::cancel ( )

Definition at line 426 of file class.ilRepositorySearchGUI.php.

    {
        $this->ctrl->returnToParent($this);
    }

◆ doUserAutoComplete()

ilRepositorySearchGUI::doUserAutoComplete ( )

protected

Do auto completion.

Returns: void

Definition at line 339 of file class.ilRepositorySearchGUI.php.

    {
        // hide anonymout request
        if ($GLOBALS['DIC']['ilUser']->getId() == ANONYMOUS_USER_ID) {
            include_once './Services/JSON/classes/class.ilJsonUtil.php';
            return ilJsonUtil::encode(new stdClass());
            exit;
        }
        
        
        if (!isset($_GET['autoCompleteField'])) {
            $a_fields = array('login','firstname','lastname','email');
            $result_field = 'login';
        } else {
            $a_fields = array((string) $_GET['autoCompleteField']);
            $result_field = (string) $_GET['autoCompleteField'];
        }
 
        include_once './Services/User/classes/class.ilUserAutoComplete.php';
        $auto = new ilUserAutoComplete();
        $auto->setPrivacyMode($this->getPrivacyMode());
 
        if (($_REQUEST['fetchall'])) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }
 
        $auto->setMoreLinkAvailable(true);
        $auto->setSearchFields($a_fields);
        $auto->setResultField($result_field);
        $auto->enableFieldSearchableCheck(true);
        $auto->setUserLimitations($this->getUserLimitations());
        if (is_callable($this->user_filter)) {          // #0024249
            $auto->addUserAccessFilterCallable($this->user_filter);
        }
 
        echo $auto->getList($_REQUEST['term']);
        exit();
    }

References $_GET, $GLOBALS, ilJsonUtil\encode(), exit, getPrivacyMode(), getUserLimitations(), and ilUserAutoComplete\MAX_ENTRIES.

Here is the call graph for this function:

◆ emptyClipboard()

ilRepositorySearchGUI::emptyClipboard ( )

protected

Remove from clipboard.

Definition at line 567 of file class.ilRepositorySearchGUI.php.

    {
        include_once './Services/User/classes/class.ilUserClipboard.php';
        $clip = ilUserClipboard::getInstance($GLOBALS['DIC']['ilUser']->getId());
        $clip->clear();
        $clip->save();
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->returnToParent($this);
    }

References $GLOBALS, and ilUserClipboard\getInstance().

Here is the call graph for this function:

◆ enableSearchableCheck()

ilRepositorySearchGUI::enableSearchableCheck ( $a_status )

En/disable the validation of the searchable flag.

Parameters

bool $a_status

Definition at line 151 of file class.ilRepositorySearchGUI.php.

    {
        $this->searchable_check = $a_status;
    }

◆ executeCommand()

ilRepositorySearchGUI::executeCommand ( )

Control @access public.

Definition at line 396 of file class.ilRepositorySearchGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->ctrl->setReturn($this, '');
 
        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = "showSearch";
                }
                $this->$cmd();
                break;
        }
        return true;
    }

References $DIC.

◆ fillAutoCompleteToolbar()

static ilRepositorySearchGUI::fillAutoCompleteToolbar	(		$parent_object,
		ilToolbarGUI	$toolbar = `null`,
			$a_options = `array()`,
			$a_sticky = `false`
	)

static

fill toolbar with

Parameters

ilToolbarGUI	$toolbar
	array	options: all are optional e.g. array( auto_complete_name = $lng->txt('user'), auto_complete_size = 15, user_type = array(ilCourseParticipants::CRS_MEMBER,ilCourseParticpants::CRS_TUTOR), submit_name = $lng->txt('add') )

Returns: ilToolbarGUI

Reimplemented in ilStudyProgrammeRepositorySearchGUI.

Definition at line 195 of file class.ilRepositorySearchGUI.php.

    {
        global $DIC;
 
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $tree = $DIC['tree'];
 
        if (!$toolbar instanceof ilToolbarGUI) {
            $toolbar = $ilToolbar;
        }
        
        // Fill default options
        if (!isset($a_options['auto_complete_name'])) {
            $a_options['auto_complete_name'] = $lng->txt('obj_user');
        }
        if (!isset($a_options['auto_complete_size'])) {
            $a_options['auto_complete_size'] = 15;
        }
        if (!isset($a_options['submit_name'])) {
            $a_options['submit_name'] = $lng->txt('btn_add');
        }
        if (!isset($a_options['user_type_default'])) {
            $a_options['user_type_default'] = null;
        }
        
        $ajax_url = $ilCtrl->getLinkTargetByClass(
            array(get_class($parent_object),'ilRepositorySearchGUI'),
            'doUserAutoComplete',
            '',
            true,
            false
        );
 
        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $ul = new ilTextInputGUI($a_options['auto_complete_name'], 'user_login');
        $ul->setDataSource($ajax_url);
        $ul->setSize($a_options['auto_complete_size']);
        if (!$a_sticky) {
            $toolbar->addInputItem($ul, true);
        } else {
            $toolbar->addStickyItem($ul, true);
        }
 
        if (count((array) $a_options['user_type'])) {
            include_once './Services/Form/classes/class.ilSelectInputGUI.php';
            $si = new ilSelectInputGUI("", "user_type");
            $si->setOptions($a_options['user_type']);
            $si->setValue($a_options['user_type_default']);
            if (!$a_sticky) {
                $toolbar->addInputItem($si);
            } else {
                $toolbar->addStickyItem($si);
            }
        }
        
        include_once './Services/User/classes/class.ilUserClipboard.php';
        $clip = ilUserClipboard::getInstance($GLOBALS['DIC']['ilUser']->getId());
        if ($clip->hasContent()) {
            include_once './Services/UIComponent/SplitButton/classes/class.ilSplitButtonGUI.php';
            $action_button = ilSplitButtonGUI::getInstance();
 
            include_once './Services/UIComponent/Button/classes/class.ilLinkButton.php';
            $add_button = ilSubmitButton::getInstance();
            $add_button->setCaption($a_options['submit_name'], false);
            $add_button->setCommand('addUserFromAutoComplete');
 
            $action_button->setDefaultButton($add_button);
 
            include_once './Services/UIComponent/Button/classes/class.ilLinkButton.php';
            $clip_button = ilSubmitButton::getInstance();
            $clip_button->addCSSClass('btn btndefault');
            $GLOBALS['DIC']->language()->loadLanguageModule('user');
            $clip_button->setCaption($GLOBALS['DIC']->language()->txt('clipboard_add_from_btn'), false);
            $clip_button->setCommand('showClipboard');
 
            $action_button->addMenuItem(new ilButtonToSplitButtonMenuItemAdapter($clip_button));
 
            $toolbar->addButtonInstance($action_button);
        } else {
            include_once "Services/UIComponent/Button/classes/class.ilSubmitButton.php";
            $button = ilSubmitButton::getInstance();
            $button->setCaption($a_options['submit_name'], false);
            $button->setCommand('addUserFromAutoComplete');
            if (!$a_sticky) {
                $toolbar->addButtonInstance($button);
            } else {
                $toolbar->addStickyItem($button);
            }
        }
        
        if ((bool) $a_options['add_search'] ||
            is_numeric($a_options['add_from_container'])) {
            $lng->loadLanguageModule("search");
            
            $toolbar->addSeparator();
                    
            if ((bool) $a_options['add_search']) {
                include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                $button = ilLinkButton::getInstance();
                $button->setCaption("search_users");
                $button->setUrl($ilCtrl->getLinkTargetByClass('ilRepositorySearchGUI', ''));
                $toolbar->addButtonInstance($button);
            }
 
            if (is_numeric($a_options['add_from_container'])) {
                $parent_ref_id = (int) $a_options['add_from_container'];
                $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "grp");
                $parent_container_type = "grp";
                if (!$parent_container_ref_id) {
                    $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "crs");
                    $parent_container_type = "crs";
                }
                if ($parent_container_ref_id) {
                    if ((bool) $a_options['add_search']) {
                        $toolbar->addSpacer();
                    }
                    
                    $ilCtrl->setParameterByClass('ilRepositorySearchGUI', "list_obj", ilObject::_lookupObjId($parent_container_ref_id));
                    
                    include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                    $button = ilLinkButton::getInstance();
                    $button->setCaption("search_add_members_from_container_" . $parent_container_type);
                    $button->setUrl($ilCtrl->getLinkTargetByClass(array(get_class($parent_object),'ilRepositorySearchGUI'), 'listUsers'));
                    $toolbar->addButtonInstance($button);
                }
            }
        }
        
        $toolbar->setFormAction(
            $ilCtrl->getFormActionByClass(
                array(
                    get_class($parent_object),
                    'ilRepositorySearchGUI')
            )
        );
        return $toolbar;
    }

References $DIC, $GLOBALS, $ilCtrl, $lng, $si, $tree, ilObject\_lookupObjId(), ilUserClipboard\getInstance(), ilLinkButton\getInstance(), ilSubmitButton\getInstance(), ilSplitButtonGUI\getInstance(), and language().

Referenced by ilOrgUnitStaffGUI\addOtherRolesToolbar(), ilOrgUnitStaffGUI\addStaffToolbar(), ilTestParticipantsGUI\addUserSearchControls(), ilObjBlogGUI\contributors(), ilSurveyParticipantsGUI\editRatersObject(), ilOrgUnitUserAssignmentGUI\index(), ilSurveyParticipantsGUI\listAppraiseesObject(), ilExerciseManagementGUI\membersObject(), ilBookingParticipantGUI\render(), ilLearningSequenceMembershipGUI\showParticipantsToolbar(), ilMembershipGUI\showParticipantsToolbar(), ilSkillProfileGUI\showUsers(), ilExSubmissionTeamGUI\submissionScreenTeamObject(), ilObjRoleGUI\userassignmentObject(), and ilIndividualAssessmentMembersGUI\view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrivacyMode()

ilRepositorySearchGUI::getPrivacyMode ( )

Returns: int

Definition at line 176 of file class.ilRepositorySearchGUI.php.

    {
        return $this->privacy_mode;
    }

References $privacy_mode.

Referenced by doUserAutoComplete(), performSearch(), and showSearch().

Here is the caller graph for this function:

◆ getString()

ilRepositorySearchGUI::getString ( )

Definition at line 387 of file class.ilRepositorySearchGUI.php.

    {
        return $this->string;
    }

◆ getTitle()

ilRepositorySearchGUI::getTitle ( )

Get search form title.

Returns: string

Definition at line 142 of file class.ilRepositorySearchGUI.php.

    {
        return $this->search_title;
    }

References $search_title.

Referenced by initFormSearch().

Here is the caller graph for this function:

◆ getUserLimitations()

ilRepositorySearchGUI::getUserLimitations ( )

allow user limitations like inactive and access limitations

Returns: bool

Definition at line 1392 of file class.ilRepositorySearchGUI.php.

    {
        return $this->user_limitations;
    }

References $user_limitations.

Referenced by doUserAutoComplete(), and showSearchUserTable().

Here is the caller graph for this function:

◆ handleMultiCommand()

ilRepositorySearchGUI::handleMultiCommand ( )

protected

Handle multi command.

Definition at line 581 of file class.ilRepositorySearchGUI.php.

    {
        $class = $this->callback['class'];
        $method = $this->callback['method'];
 
        // Redirects if everything is ok
        if (!$class->$method((array) $_POST['user'], $_POST['selectedCommand'])) {
            $this->showSearchResults();
        }
    }

References $_POST, and showSearchResults().

Here is the call graph for this function:

◆ initFormSearch()

ilRepositorySearchGUI::initFormSearch ( ilObjUser $user = null )

Definition at line 641 of file class.ilRepositorySearchGUI.php.

    {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
 
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'showSearch'));
        $this->form->setTitle($this->getTitle());
        $this->form->addCommandButton('performSearch', $this->lng->txt('search'));
        $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        
        
        $kind = new ilRadioGroupInputGUI($this->lng->txt('search_type'), 'search_for');
        $kind->setValue($this->search_type);
        $this->form->addItem($kind);
        
        // Users
        $users = new ilRadioOption($this->lng->txt('search_for_users'), 'usr');
            
        // UDF
        include_once 'Services/Search/classes/class.ilUserSearchOptions.php';
        foreach (ilUserSearchOptions::_getSearchableFieldsInfo(!$this->isSearchableCheckEnabled()) as $info) {
            switch ($info['type']) {
                case FIELD_TYPE_UDF_SELECT:
                case FIELD_TYPE_SELECT:
                        
                    $sel = new ilSelectInputGUI($info['lang'], "rep_query[usr][" . $info['db'] . "]");
                    $sel->setOptions($info['values']);
                    $users->addSubItem($sel);
                    break;
    
                case FIELD_TYPE_MULTI:
                case FIELD_TYPE_UDF_TEXT:
                case FIELD_TYPE_TEXT:
 
                    if (isset($info['autoComplete']) and $info['autoComplete']) {
                        $ilCtrl->setParameterByClass(get_class($this), 'autoCompleteField', $info['db']);
                        $ul = new ilTextInputGUI($info['lang'], "rep_query[usr][" . $info['db'] . "]");
                        $ul->setDataSourceSubmitOnSelection(true);
                        $ul->setDataSourceSubmitUrl(
                            $this->ctrl->getLinkTarget(
                                $this,
                                'showSearchSelected',
                                '',
                                false,
                                false
                                )
                        );
                        $ul->setDataSource($ilCtrl->getLinkTarget(
                            $this,
                            "doUserAutoComplete",
                            "",
                            true
                        ));
                        $ul->setSize(30);
                        $ul->setMaxLength(120);
                        
                        if ($user instanceof ilObjUser) {
                            switch ($info['db']) {
                                case 'firstname':
                                    $ul->setValue($user->getFirstname());
                                    break;
                                case 'lastname':
                                    $ul->setValue($user->getLastname());
                                    break;
                                case 'login':
                                    $ul->setValue($user->getLogin());
                                    break;
                            }
                        }
                        
                        
                        
                        $users->addSubItem($ul);
                    } else {
                        $txt = new ilTextInputGUI($info['lang'], "rep_query[usr][" . $info['db'] . "]");
                        $txt->setSize(30);
                        $txt->setMaxLength(120);
                        $users->addSubItem($txt);
                    }
                    break;
            }
        }
        $kind->addOption($users);
 
 
 
        // Role
        $roles = new ilRadioOption($this->lng->txt('search_for_role_members'), 'role');
        $role = new ilTextInputGUI($this->lng->txt('search_role_title'), 'rep_query[role][title]');
        $role->setSize(30);
        $role->setMaxLength(120);
        $roles->addSubItem($role);
        $kind->addOption($roles);
            
        // Course
        $groups = new ilRadioOption($this->lng->txt('search_for_crs_members'), 'crs');
        $group = new ilTextInputGUI($this->lng->txt('search_crs_title'), 'rep_query[crs][title]');
        $group->setSize(30);
        $group->setMaxLength(120);
        $groups->addSubItem($group);
        $kind->addOption($groups);
 
        // Group
        $groups = new ilRadioOption($this->lng->txt('search_for_grp_members'), 'grp');
        $group = new ilTextInputGUI($this->lng->txt('search_grp_title'), 'rep_query[grp][title]');
        $group->setSize(30);
        $group->setMaxLength(120);
        $groups->addSubItem($group);
        $kind->addOption($groups);
 
        // Orgus
        if (ilUserSearchOptions::_isEnabled("org_units")) {
            $orgus = new ilRadioOption($this->lng->txt('search_for_orgu_members'), 'orgu');
            $orgu = new ilRepositorySelector2InputGUI($this->lng->txt('select_orgu'), 'rep_query_orgu', true, get_class($this));
            $orgu->getExplorerGUI()->setSelectableTypes(["orgu"]);
            $orgu->getExplorerGUI()->setTypeWhiteList(["root", "orgu"]);
            $orgu->getExplorerGUI()->setRootId(ilObjOrgUnit::getRootOrgRefId());
            $orgu->getExplorerGUI()->setAjax(false);
            $orgus->addSubItem($orgu);
            $kind->addOption($orgus);
        }
    }

References $DIC, $ilCtrl, $txt, ilUserSearchOptions\_getSearchableFieldsInfo(), ilUserSearchOptions\_isEnabled(), FIELD_TYPE_MULTI, FIELD_TYPE_SELECT, FIELD_TYPE_TEXT, FIELD_TYPE_UDF_SELECT, FIELD_TYPE_UDF_TEXT, ilObjOrgUnit\getRootOrgRefId(), getTitle(), and isSearchableCheckEnabled().

Referenced by showSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSearchableCheckEnabled()

ilRepositorySearchGUI::isSearchableCheckEnabled ( )

Returns: bool

Definition at line 160 of file class.ilRepositorySearchGUI.php.

    {
        return $this->searchable_check;
    }

References $searchable_check.

Referenced by __performUserSearch(), and initFormSearch().

Here is the caller graph for this function:

◆ listUsers()

ilRepositorySearchGUI::listUsers ( )

protected

List users of course/group/roles.

Returns

Definition at line 1230 of file class.ilRepositorySearchGUI.php.

    {
        // get parameter is used e.g. in exercises to provide
        // "add members of course" link
        if ($_GET["list_obj"] != "" && !is_array($_POST['obj'])) {
            $_POST['obj'][0] = $_GET["list_obj"];
        }
        if (!is_array($_POST['obj']) or !$_POST['obj']) {
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $this->showSearchResults();
            return false;
        }
        
        $_SESSION['rep_search']['objs'] = $_POST['obj'];
        
        // Get all members
        $members = array();
        foreach ($_POST['obj'] as $obj_id) {
            $type = ilObject::_lookupType($obj_id);
            switch ($type) {
                case 'crs':
                case 'grp':
                    
                    include_once './Services/Membership/classes/class.ilParticipants.php';
                    if (ilParticipants::hasParticipantListAccess($obj_id)) {
                        $part = [];
                        if (is_callable($this->user_filter)) {
                            $part = call_user_func_array(
                                $this->user_filter,
                                [
                                    ilParticipants::getInstanceByObjId($obj_id)->getParticipants()
                                ]
                            );
                        } else {
                            $part = ilParticipants::getInstanceByObjId($obj_id)->getParticipants();
                        }
                        
                        $members = array_merge((array) $members, $part);
                    }
                    break;
                    
                case 'role':
                    global $DIC;
 
                    $rbacreview = $DIC['rbacreview'];
                    
                    $assigned = [];
                    if (is_callable($this->user_filter)) {
                        $assigned = call_user_func_array(
                            $this->user_filter,
                            [
                                $rbacreview->assignedUsers($obj_id)
                            ]
                        );
                    } else {
                        $assigned = $rbacreview->assignedUsers($obj_id);
                    }
                    
                    $members = array_merge($members, ilUserFilter::getInstance()->filter($assigned));
                    break;
                case 'orgu':
                    if ($ref_ids = ilObject::_getAllReferences($obj_id)) {
                        $assigned = ilOrgUnitUserAssignmentQueries::getInstance()
                            ->getUserIdsOfOrgUnit(array_shift($ref_ids));
                        if (is_callable($this->user_filter)) {
                            $assigned = call_user_func_array(
                                $this->user_filter,
                                [$assigned]
                            );
                        }
 
                        $members = array_merge(
                            $members,
                            $assigned
                        );
                    }
                    break;
            }
        }
        $members = array_unique((array) $members);
        $this->__appendToStoredResults($members);
        
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'Services/Search');
        
        $this->addNewSearchButton();
        $this->showSearchUserTable($_SESSION['rep_search']['usr'], 'storedUserList');
        return true;
    }

References $_GET, $_POST, $_SESSION, $DIC, $type, __appendToStoredResults(), ilObject\_getAllReferences(), ilObject\_lookupType(), addNewSearchButton(), ilOrgUnitUserAssignmentQueries\getInstance(), ilUserFilter\getInstance(), ilParticipants\getInstanceByObjId(), ilParticipants\hasParticipantListAccess(), ilUtil\sendFailure(), showSearchResults(), and showSearchUserTable().

Referenced by performSearch(), and storedUserList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilRepositorySearchGUI::performSearch ( )

Perform a search.

Returns

Definition at line 784 of file class.ilRepositorySearchGUI.php.

    {
        // only autocomplete input field, no search form if user privay should be respected
        // see bug 25481
        if ($this->getPrivacyMode() == ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING) {
            return "";
        }
        $found_query = false;
        foreach ((array) $_POST['rep_query'][$_POST['search_for']] as $field => $value) {
            if (trim(ilUtil::stripSlashes($value))) {
                $found_query = true;
                break;
            }
        }
        if (array_key_exists('rep_query_orgu', $_POST) && count($_POST['rep_query_orgu']) > 0) {
            $found_query = true;
        }
        if (!$found_query) {
            ilUtil::sendFailure($this->lng->txt('msg_no_search_string'));
            $this->start();
            return false;
        }
    
        // unset search_append if called directly
        if ($_POST['cmd']['performSearch']) {
            unset($_SESSION['search_append']);
        }
 
        switch ($this->search_type) {
            case 'usr':
                $this->__performUserSearch();
                break;
 
            case 'grp':
                $this->__performGroupSearch();
                break;
 
            case 'crs':
                $this->__performCourseSearch();
                break;
 
            case 'role':
                $this->__performRoleSearch();
                break;
            case 'orgu':
                $_POST['obj'] = array_map(
                    function ($ref_id) {
                        return (int) ilObject::_lookupObjId($ref_id);
                    },
                    $_POST['rep_query_orgu']
                );
                return $this->listUsers();
            default:
                echo 'not defined';
        }
        
        $this->result_obj->setRequiredPermission('read');
        $this->result_obj->addObserver($this, 'searchResultFilterListener');
        $this->result_obj->filter(ROOT_FOLDER_ID, QP_COMBINATION_OR);
        
        // User access filter
        if ($this->search_type == 'usr') {
            $callable_name = '';
            if (is_callable($this->user_filter, true, $callable_name)) {
                $result_ids = call_user_func_array($this->user_filter, [$this->result_obj->getResultIds()]);
            } else {
                $result_ids = $this->result_obj->getResultIds();
            }
            
            include_once './Services/User/classes/class.ilUserFilter.php';
            $this->search_results = array_intersect(
                $result_ids,
                ilUserFilter::getInstance()->filter($result_ids)
            );
        } else {
            $this->search_results = array();
            foreach ((array) $this->result_obj->getResults() as $res) {
                $this->search_results[] = $res['obj_id'];
            }
        }
 
        if (!count($this->search_results)) {
            ilUtil::sendFailure($this->lng->txt('search_no_match'));
            $this->showSearch();
            return true;
        }
        $this->__updateResults();
        if ($this->result_obj->isLimitReached()) {
            $message = sprintf($this->lng->txt('search_limit_reached'), $this->settings->getMaxHits());
            ilUtil::sendInfo($message);
            return true;
        }
        // show results
        $this->show();
        return true;
    }

References $_POST, $_SESSION, $message, $res, __performCourseSearch(), __performGroupSearch(), __performRoleSearch(), __performUserSearch(), __updateResults(), ilObject\_lookupObjId(), ilUserFilter\getInstance(), getPrivacyMode(), listUsers(), ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING, QP_COMBINATION_OR, ilUtil\sendFailure(), ilUtil\sendInfo(), show(), showSearch(), start(), and ilUtil\stripSlashes().

Referenced by appendSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromClipboard()

ilRepositorySearchGUI::removeFromClipboard ( )

protected

Remove from clipboard.

Definition at line 546 of file class.ilRepositorySearchGUI.php.

    {
        $GLOBALS['DIC']['ilCtrl']->setParameter($this, 'user_type', (int) $_REQUEST['user_type']);
        $users = (array) $_POST['uids'];
        if (!count($users)) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $GLOBALS['DIC']['ilCtrl']->redirect($this, 'showClipboard');
        }
 
        include_once './Services/User/classes/class.ilUserClipboard.php';
        $clip = ilUserClipboard::getInstance($GLOBALS['DIC']['ilUser']->getId());
        $clip->delete($users);
        $clip->save();
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'showClipboard');
    }

References $_POST, $GLOBALS, ilUserClipboard\getInstance(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ searchResultFilterListener()

ilRepositorySearchGUI::searchResultFilterListener	(	$a_ref_id,
		$a_data
	)

Listener called from ilSearchResult Id is obj_id for role, usr Id is ref_id for crs grp.

Parameters

int	$a_id
array	$a_data

Returns

Definition at line 1338 of file class.ilRepositorySearchGUI.php.

    {
        if ($a_data['type'] == 'usr') {
            if ($a_data['obj_id'] == ANONYMOUS_USER_ID) {
                return false;
            }
        }
        return true;
    }

◆ selectObject()

ilRepositorySearchGUI::selectObject ( )

protected

Return selection of course/group/roles to calling script.

Definition at line 1361 of file class.ilRepositorySearchGUI.php.

    {
        // get parameter is used e.g. in exercises to provide
        // "add members of course" link
        if ($_GET["list_obj"] != "" && !is_array($_POST['obj'])) {
            $_POST['obj'][0] = $_GET["list_obj"];
        }
        if (!is_array($_POST['obj']) or !$_POST['obj']) {
            ilUtil::sendFailure($this->lng->txt('select_one'));
            $this->showSearchResults();
            return false;
        }
 
        $this->ctrl->setParameter($this->callback["class"], "obj", implode(";", $_POST["obj"]));
        $this->ctrl->redirect($this->callback["class"], $this->callback["method"]);
    }

References $_GET, $_POST, ilUtil\sendFailure(), and showSearchResults().

Here is the call graph for this function:

◆ setCallback()

ilRepositorySearchGUI::setCallback	(	&	$class,
			$method,
			$a_add_options = `array()`
	)

Definition at line 592 of file class.ilRepositorySearchGUI.php.

    {
        $this->callback = array('class' => $class,'method' => $method);
        $this->add_options = $a_add_options ? $a_add_options : array();
    }

◆ setPermissionQueryCallback()

ilRepositorySearchGUI::setPermissionQueryCallback	(	$class,
		$method
	)

Set callback method for user permission access queries.

Definition at line 607 of file class.ilRepositorySearchGUI.php.

608 {

609 }

◆ setPrivacyMode()

ilRepositorySearchGUI::setPrivacyMode ( $privacy_mode )

Parameters

int $privacy_mode

Definition at line 168 of file class.ilRepositorySearchGUI.php.

    {
        $this->privacy_mode = $privacy_mode;
    }

References $privacy_mode.

◆ setRoleCallback()

ilRepositorySearchGUI::setRoleCallback	(	&	$class,
			$method,
			$a_add_options = `array()`
	)

Definition at line 598 of file class.ilRepositorySearchGUI.php.

    {
        $this->role_callback = array('class' => $class,'method' => $method);
        $this->add_options = $a_add_options ? $a_add_options : array();
    }

◆ setString()

ilRepositorySearchGUI::setString ( $a_str )

Set/get search string @access public.

Definition at line 383 of file class.ilRepositorySearchGUI.php.

    {
        $_SESSION['search']['string'] = $this->string = $a_str;
    }

References $_SESSION.

◆ setTitle()

ilRepositorySearchGUI::setTitle ( $a_title )

Set form title.

Parameters

string $a_title

Definition at line 133 of file class.ilRepositorySearchGUI.php.

    {
        $this->search_title = $a_title;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setUserLimitations()

ilRepositorySearchGUI::setUserLimitations ( $a_limitations )

allow user limitations like inactive and access limitations

Parameters

bool $a_limitations

Definition at line 1383 of file class.ilRepositorySearchGUI.php.

    {
        $this->user_limitations = (bool) $a_limitations;
    }

◆ show()

ilRepositorySearchGUI::show ( )

Definition at line 769 of file class.ilRepositorySearchGUI.php.

    {
        $this->showSearchResults();
    }

References showSearchResults().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showClipboard()

ilRepositorySearchGUI::showClipboard ( )

protected

Definition at line 502 of file class.ilRepositorySearchGUI.php.

    {
        $GLOBALS['DIC']['ilCtrl']->setParameter($this, 'user_type', (int) $_REQUEST['user_type']);
        
        ilLoggerFactory::getLogger('crs')->dump($_REQUEST);
        
        $GLOBALS['DIC']['ilTabs']->clearTargets();
        $GLOBALS['DIC']['ilTabs']->setBackTarget(
            $GLOBALS['DIC']['lng']->txt('back'),
            $GLOBALS['DIC']['ilCtrl']->getParentReturn($this)
        );
        
        include_once './Services/User/classes/class.ilUserClipboardTableGUI.php';
        $clip = new ilUserClipboardTableGUI($this, 'showClipboard', $GLOBALS['DIC']['ilUser']->getId());
        $clip->setFormAction($GLOBALS['DIC']['ilCtrl']->getFormAction($this));
        $clip->init();
        $clip->parse();
        
        $GLOBALS['DIC']['tpl']->setContent($clip->getHTML());
    }

References $GLOBALS, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

◆ showSearch()

ilRepositorySearchGUI::showSearch ( )

Definition at line 611 of file class.ilRepositorySearchGUI.php.

    {
        // only autocomplete input field, no search form if user privay should be respected
        // see bug 25481
        if ($this->getPrivacyMode() == ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING) {
            return;
        }
        $this->initFormSearch();
        $this->tpl->setContent($this->form->getHTML());
    }

References getPrivacyMode(), initFormSearch(), and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

Referenced by performSearch(), and start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSearchCourseTable()

ilRepositorySearchGUI::showSearchCourseTable ( $a_obj_ids )

protected

Returns

Parameters

array $a_obj_ids

Definition at line 1216 of file class.ilRepositorySearchGUI.php.

    {
        include_once './Services/Search/classes/class.ilRepositoryObjectResultTableGUI.php';
        
        $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
        $table->parseObjectIds($a_obj_ids);
        
        $this->tpl->setVariable('RES_TABLE', $table->getHTML());
    }

Referenced by showSearchResults().

Here is the caller graph for this function:

◆ showSearchGroupTable()

ilRepositorySearchGUI::showSearchGroupTable ( $a_obj_ids )

protected

Returns

Parameters

array $a_obj_ids

Definition at line 1201 of file class.ilRepositorySearchGUI.php.

    {
        include_once './Services/Search/classes/class.ilRepositoryObjectResultTableGUI.php';
        
        $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
        $table->parseObjectIds($a_obj_ids);
        
        $this->tpl->setVariable('RES_TABLE', $table->getHTML());
    }

Referenced by showSearchResults().

Here is the caller graph for this function:

◆ showSearchResults()

ilRepositorySearchGUI::showSearchResults ( )

Definition at line 1122 of file class.ilRepositorySearchGUI.php.

    {
        $counter = 0;
        $f_result = array();
        
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'Services/Search');
        $this->addNewSearchButton();
        
        switch ($this->search_type) {
            case "usr":
                $this->showSearchUserTable($_SESSION['rep_search']['usr'], 'showSearchResults');
                break;
 
            case 'grp':
                $this->showSearchGroupTable($_SESSION['rep_search']['grp']);
                break;
 
            case 'crs':
                $this->showSearchCourseTable($_SESSION['rep_search']['crs']);
                break;
 
            case 'role':
                $this->showSearchRoleTable($_SESSION['rep_search']['role']);
                break;
        }
    }

References $_SESSION, addNewSearchButton(), showSearchCourseTable(), showSearchGroupTable(), showSearchRoleTable(), and showSearchUserTable().

Referenced by addRole(), addUser(), handleMultiCommand(), listUsers(), selectObject(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSearchRoleTable()

ilRepositorySearchGUI::showSearchRoleTable ( $a_obj_ids )

protected

Show usr table.

Returns

Parameters

object $a_usr_ids

Definition at line 1186 of file class.ilRepositorySearchGUI.php.

    {
        include_once './Services/Search/classes/class.ilRepositoryObjectResultTableGUI.php';
        
        $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
        $table->parseObjectIds($a_obj_ids);
        
        $this->tpl->setVariable('RES_TABLE', $table->getHTML());
    }

Referenced by showSearchResults().

Here is the caller graph for this function:

◆ showSearchSelected()

ilRepositorySearchGUI::showSearchSelected ( )

submit from autocomplete

Definition at line 625 of file class.ilRepositorySearchGUI.php.

    {
        $selected = (int) $_REQUEST['selected_id'];
        
        #include_once './Services/Object/classes/class.ilObjectFactory.php';
        #$factory = new ilObjectFactory();
        #$user = $factory->getInstanceByObjId($selected);
        
        #$this->initFormSearch($user);
        #$this->tpl->setContent($this->form->getHTML());
        
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'Services/Search');
        $this->addNewSearchButton();
        $this->showSearchUserTable(array($selected), 'showSearchResults');
    }

References addNewSearchButton(), and showSearchUserTable().

Here is the call graph for this function:

◆ showSearchUserTable()

ilRepositorySearchGUI::showSearchUserTable	(	$a_usr_ids,
		$a_parent_cmd
	)

protected

Show usr table.

Returns

Parameters

object $a_usr_ids

Definition at line 1154 of file class.ilRepositorySearchGUI.php.

    {
        $is_in_admin = ($_REQUEST['baseClass'] == 'ilAdministrationGUI');
        if ($is_in_admin) {
            // remember link target to admin search gui (this)
            $_SESSION["usr_search_link"] = $this->ctrl->getLinkTarget($this, 'show');
        }
        
        include_once './Services/Search/classes/class.ilRepositoryUserResultTableGUI.php';
        
        $table = new ilRepositoryUserResultTableGUI($this, $a_parent_cmd, $is_in_admin);
        if (count($this->add_options)) {
            $table->addMultiItemSelectionButton(
                'selectedCommand',
                $this->add_options,
                'handleMultiCommand',
                $this->lng->txt('execute')
            );
        } else {
            $table->addMultiCommand('addUser', $this->lng->txt('btn_add'));
        }
        $table->setUserLimitations($this->getUserLimitations());
        $table->parseUserIds($a_usr_ids);
        
        $this->tpl->setVariable('RES_TABLE', $table->getHTML());
    }

References $_SESSION, and getUserLimitations().

Referenced by listUsers(), showSearchResults(), and showSearchSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

ilRepositorySearchGUI::start ( )

Definition at line 431 of file class.ilRepositorySearchGUI.php.

    {
        // delete all session info
        $this->__clearSession();
        $this->showSearch();
 
        return true;
    }

References __clearSession(), and showSearch().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storedUserList()

ilRepositorySearchGUI::storedUserList ( )

protected

Called from table sort.

Returns

Definition at line 1323 of file class.ilRepositorySearchGUI.php.

    {
        $_POST['obj'] = $_SESSION['rep_search']['objs'];
        $this->listUsers();
        return true;
    }

References $_POST, $_SESSION, and listUsers().

Here is the call graph for this function:

Field Documentation

◆ $add_options

ilRepositorySearchGUI::$add_options = array()

protected

Definition at line 47 of file class.ilRepositorySearchGUI.php.

◆ $object_selection

ilRepositorySearchGUI::$object_selection = false

protected

Definition at line 48 of file class.ilRepositorySearchGUI.php.

◆ $privacy_mode

ilRepositorySearchGUI::$privacy_mode = ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING

private

Definition at line 64 of file class.ilRepositorySearchGUI.php.

Referenced by getPrivacyMode(), and setPrivacyMode().

◆ $search_results

ilRepositorySearchGUI::$search_results = array()

private

Definition at line 45 of file class.ilRepositorySearchGUI.php.

◆ $search_title

ilRepositorySearchGUI::$search_title = ''

protected

Definition at line 51 of file class.ilRepositorySearchGUI.php.

Referenced by getTitle().

◆ $search_type

ilRepositorySearchGUI::$search_type = 'usr'

Definition at line 53 of file class.ilRepositorySearchGUI.php.

Referenced by __updateResults().

◆ $searchable_check

ilRepositorySearchGUI::$searchable_check = true

protected

Definition at line 50 of file class.ilRepositorySearchGUI.php.

Referenced by isSearchableCheckEnabled().

◆ $tree

ilRepositorySearchGUI::$tree

protected

Definition at line 70 of file class.ilRepositorySearchGUI.php.

Referenced by __construct(), ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar(), and fillAutoCompleteToolbar().

◆ $ui_factory

ilRepositorySearchGUI::$ui_factory

protected

Definition at line 78 of file class.ilRepositorySearchGUI.php.

Referenced by __construct().

◆ $ui_renderer

ilRepositorySearchGUI::$ui_renderer

protected

Definition at line 74 of file class.ilRepositorySearchGUI.php.

Referenced by __construct().

◆ $user_filter

ilRepositorySearchGUI::$user_filter = null

protected

Definition at line 59 of file class.ilRepositorySearchGUI.php.

Referenced by addUserAccessFilterCallable().

◆ $user_limitations

ilRepositorySearchGUI::$user_limitations = true

protected

Definition at line 54 of file class.ilRepositorySearchGUI.php.

Referenced by getUserLimitations().

The documentation for this class was generated from the following file:

Services/Search/classes/class.ilRepositorySearchGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __appendToStoredResults()

◆ __clearSession()

◆ __loadQueries()

◆ __parseQueryString()

◆ __performCourseSearch()

◆ __performGroupSearch()

◆ __performRoleSearch()

◆ __performUserSearch()

◆ __setSearchType()

◆ __storeEntries()

◆ __updateResults()

◆ addFromClipboard()

◆ addNewSearchButton()

◆ addRole()

◆ addUser()

◆ addUserAccessFilterCallable()

◆ addUserFromAutoComplete()

◆ allowObjectSelection()

◆ appendSearch()

◆ cancel()

◆ doUserAutoComplete()

◆ emptyClipboard()

◆ enableSearchableCheck()

◆ executeCommand()

◆ fillAutoCompleteToolbar()

◆ getPrivacyMode()

◆ getString()

◆ getTitle()

◆ getUserLimitations()

◆ handleMultiCommand()

◆ initFormSearch()

◆ isSearchableCheckEnabled()

◆ listUsers()

◆ performSearch()

◆ removeFromClipboard()

◆ searchResultFilterListener()

◆ selectObject()

◆ setCallback()

◆ setPermissionQueryCallback()

◆ setPrivacyMode()

◆ setRoleCallback()

◆ setString()

◆ setTitle()

◆ setUserLimitations()

◆ show()

◆ showClipboard()

◆ showSearch()

◆ showSearchCourseTable()

◆ showSearchGroupTable()

◆ showSearchResults()

◆ showSearchRoleTable()

◆ showSearchSelected()

◆ showSearchUserTable()

◆ start()

◆ storedUserList()

Field Documentation

◆ $add_options

◆ $object_selection

◆ $privacy_mode

◆ $search_results

◆ $search_title

◆ $search_type

◆ $searchable_check

◆ $tree

◆ $ui_factory

◆ $ui_renderer

◆ $user_filter

◆ $user_limitations