Inheritance diagram for ilRepositorySearchGUI:

Collaboration diagram for ilRepositorySearchGUI:

Public Member Functions
	__construct ()

	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 (string $a_title)

	getTitle ()

	enableSearchableCheck (bool $a_status)

	isSearchableCheckEnabled ()

	setPrivacyMode (int $privacy_mode)

	getPrivacyMode ()

	getSearchType ()

	getRoleCallback ()

	setString (string $a_str)

	getString ()

	executeCommand ()

	__clearSession ()

	cancel ()

	start ()

	addRole ()

	addUser ()

	setCallback (object $class, string $method, array $a_add_options=[], string $default_option='')

	setRoleCallback (object $class, string $method, array $a_add_options=[], string $default_option='')

	setPermissionQueryCallback (object $class, string $method)

	showSearch ()

	showSearchSelected ()

	initFormSearch (?ilObjUser $user=null)

	show ()

	appendSearch ()

	performSearch ()

	__performUserSearch ()

	__performGroupSearch ()

	__performRoleSearch ()

	__parseQueryString (string $a_string, bool $a_combination_or=true, bool $a_ignore_length=false)

	__loadQueries ()

	__setSearchType ()

	__updateResults ()

	__appendToStoredResults (array $a_usr_ids)

	__storeEntries (ilSearchResult $new_res)

	showSearchResults ()

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

	allowObjectSelection (bool $a_value=false)

	setUserLimitations (bool $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 (object $parent_object, ?ilToolbarGUI $toolbar=null, array $a_options=[], bool $a_sticky=false)
	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') ) More...

Protected Member Functions
	initUserTypeFromQuery ()

	initUserTypeFromPost ()

	doUserAutoComplete ()

	addUserFromAutoComplete ()

	showClipboard ()

	addFromClipboard ()

	removeFromClipboard ()

	emptyClipboard ()

	handleMultiCommand ()

	__performCourseSearch ()

	addNewSearchButton ()

	showSearchUserTable (array $a_usr_ids, string $a_parent_cmd)

	showSearchRoleTable (array $a_obj_ids)

	showSearchGroupTable (array $a_obj_ids)

	showSearchCourseTable (array $a_obj_ids)

	listUsers (array $selected_entries=[])

	storedUserList ()

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

Protected Attributes
array	$add_options = []

string	$default_option = ''

bool	$object_selection = false

bool	$searchable_check = true

string	$search_title = ''

bool	$user_limitations = true

bool	$stored = false

array	$callback = []

array	$role_callback = []

ilSearchResult	$result_obj

ilSearchSettings	$settings

ilPropertyFormGUI	$form = null

	$user_filter = null

ilTree	$tree

Renderer	$ui_renderer

Factory	$ui_factory

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilObjUser	$user = null

ilRbacReview	$rbacreview

ilTabsGUI	$tabs

ilLanguage	$lng

Private Attributes
array	$search_results = []

string	$search_type = 'usr'

string	$string = ''

int	$privacy_mode = ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING

GlobalHttpState	$http

RefineryFactory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilRepositorySearchGUI::__construct ( )

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

References $DIC, __loadQueries(), __setSearchType(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), setTitle(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

     {
         global $DIC;
 
 
 
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->tree = $DIC->repositoryTree();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->ui_factory = $DIC->ui()->factory();
         $this->lng = $DIC->language();
         $this->rbacreview = $DIC->rbac()->review();
         $this->refinery = $DIC->refinery();
         $this->http = $DIC->http();
         $this->user = $DIC->user();
         $this->tabs = $DIC->tabs();
 
         $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();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __appendToStoredResults()

ilRepositorySearchGUI::__appendToStoredResults ( array $a_usr_ids )

Returns: int[]

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

References ilSession\get(), and ilSession\set().

Referenced by listUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __clearSession()

ilRepositorySearchGUI::__clearSession ( )

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

References ilSession\clear().

Referenced by start().

                                     : void
     {
         ilSession::clear('rep_search');
         ilSession::clear('append_results');
         ilSession::clear('rep_query');
         ilSession::clear('rep_search_type');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __loadQueries()

ilRepositorySearchGUI::__loadQueries ( )

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

References ILIAS\FileDelivery\http(), and ilSession\set().

Referenced by __construct().

                                    : void
     {
         if ($this->http->wrapper()->post()->has('rep_query')) {
             ilSession::set(
                 'rep_query',
                 $this->http->request()->getParsedBody()['rep_query']
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __parseQueryString()

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

Returns: ilQueryParser|string

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performCourseSearch()

ilRepositorySearchGUI::__performCourseSearch ( )

protected

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

References __parseQueryString(), __storeEntries(), and ilSession\get().

Referenced by performSearch().

                                               : bool
     {
         $rep_query = ilSession::get('rep_query');
         $query_string = $rep_query['crs']['title'] ?? '';
         if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
             $this->tpl->setOnScreenMessage('info', $query_parser, true);
             return false;
         }
 
         $object_search = new ilLikeObjectSearch($query_parser);
         $object_search->setFilter(array('crs'));
         $this->__storeEntries($object_search->performSearch());
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performGroupSearch()

ilRepositorySearchGUI::__performGroupSearch ( )

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

References __parseQueryString(), __storeEntries(), and ilSession\get().

Referenced by performSearch().

                                           : bool
     {
         $rep_query = ilSession::get('rep_query');
         $query_string = $rep_query['grp']['title'] ?? '';
         if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
             $this->tpl->setOnScreenMessage('info', $query_parser, true);
             return false;
         }
 
         $object_search = new ilLikeObjectSearch($query_parser);
         $object_search->setFilter(array('grp'));
         $this->__storeEntries($object_search->performSearch());
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performRoleSearch()

ilRepositorySearchGUI::__performRoleSearch ( )

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

References __parseQueryString(), __storeEntries(), and ilSession\get().

Referenced by performSearch().

                                          : bool
     {
         $rep_query = ilSession::get('rep_query');
         $query_string = $rep_query['role']['title'] ?? '';
         if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
             $this->tpl->setOnScreenMessage('info', $query_parser, true);
             return false;
         }
 
         // Perform like search
         $object_search = new ilLikeObjectSearch($query_parser);
         $object_search->setFilter(array('role'));
         $this->__storeEntries($object_search->performSearch());
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __performUserSearch()

ilRepositorySearchGUI::__performUserSearch ( )

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

References __parseQueryString(), __storeEntries(), ilUserSearchOptions\_getSearchableFieldsInfo(), ilObjectSearchFactory\_getUserDefinedFieldSearchInstance(), ilObjectSearchFactory\_getUserSearchInstance(), ilUserSearchOptions\FIELD_TYPE_MULTI, ilUserSearchOptions\FIELD_TYPE_SELECT, ilUserSearchOptions\FIELD_TYPE_TEXT, ilUserSearchOptions\FIELD_TYPE_UDF_SELECT, ilUserSearchOptions\FIELD_TYPE_UDF_TEXT, ilSession\get(), ilObjectSearchFactory\getUserMultiFieldSearchInstance(), ilObjectSearchFactory\getUserOrgUnitAssignmentInstance(), and isSearchableCheckEnabled().

Referenced by performSearch().

                                          : bool
     {
         foreach (ilUserSearchOptions::_getSearchableFieldsInfo(!$this->isSearchableCheckEnabled()) as $info) {
             $name = $info['db'];
 
             $rep_query = ilSession::get('rep_query');
             $query_string = $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'] == ilUserSearchOptions::FIELD_TYPE_SELECT)))) {
                 $this->tpl->setOnScreenMessage('info', $query_parser);
                 return false;
             }
             switch ($info['type']) {
                 case ilUserSearchOptions::FIELD_TYPE_UDF_SELECT:
                     $query_parser = $this->__parseQueryString($query_string);
 
                     // no break
                 case ilUserSearchOptions::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 ilUserSearchOptions::FIELD_TYPE_SELECT:
 
                     if ($info['db'] == 'org_units') {
                         $user_search = ilObjectSearchFactory::getUserOrgUnitAssignmentInstance($query_parser);
                         $result_obj = $user_search->performSearch();
                         $this->__storeEntries($result_obj);
                         break;
                     }
                     $query_parser = $this->__parseQueryString($query_string, true, true);
 
                     // no break
                 case ilUserSearchOptions::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 ilUserSearchOptions::FIELD_TYPE_MULTI:
                     $multi_search = ilObjectSearchFactory::getUserMultiFieldSearchInstance($query_parser);
                     $multi_search->setFields(array($name));
                     $result_obj = $multi_search->performSearch();
                     $this->__storeEntries($result_obj);
                     break;
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __setSearchType()

ilRepositorySearchGUI::__setSearchType ( )

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

References ilSession\get(), ILIAS\FileDelivery\http(), and ilSession\set().

Referenced by __construct().

                                      : bool
     {
         // Update search type. Default to user search
         if ($this->http->wrapper()->post()->has('search_for')) {
             ilSession::set(
                 'rep_search_type',
                 $this->http->request()->getParsedBody()['search_for']
             );
         } elseif (!ilSession::get('rep_search_type')) {
             ilSession::set('rep_search_type', 'usr');
         }
         $this->search_type = (string) ilSession::get('rep_search_type');
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __storeEntries()

ilRepositorySearchGUI::__storeEntries ( ilSearchResult $new_res )

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

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

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

Here is the caller graph for this function:

◆ __updateResults()

ilRepositorySearchGUI::__updateResults ( )

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

References $search_type, ilSession\get(), and ilSession\set().

Referenced by performSearch().

                                      : bool
     {
         if (!ilSession::get('search_append')) {
             ilSession::set('rep_search', []);
         }
         $rep_search = ilSession::get('rep_search') ?? [];
         foreach ($this->search_results as $result) {
             $rep_search[$this->search_type][] = $result;
         }
         if (!$rep_search[$this->search_type]) {
             $rep_search[$this->search_type] = [];
         } else {
             $rep_search[$this->search_type] = array_unique($rep_search[$this->search_type]);
         }
         ilSession::set('rep_search', $rep_search);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addFromClipboard()

ilRepositorySearchGUI::addFromClipboard ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initUserTypeFromPost(), initUserTypeFromQuery(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                          : void
     {
         $user_type = $this->initUserTypeFromPost();
         if ($user_type === '') {
             $user_type = $this->initUserTypeFromQuery();
         }
         $this->ctrl->setParameter($this, 'user_type', $user_type);
 
         $users = [];
         if ($this->http->wrapper()->post()->has('uids')) {
             $users = $this->http->wrapper()->post()->retrieve(
                 'uids',
                 $this->refinery->kindlyTo()->dictOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         if (!count($users)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'showClipboard');
         }
         $class = $this->callback['class'];
         $method = $this->callback['method'];
         if (!$class->$method($users, $user_type)) {
             $this->ctrl->returnToParent($this);
         }
     }

Here is the call graph for this function:

◆ addNewSearchButton()

ilRepositorySearchGUI::addNewSearchButton ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

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

                                            : void
     {
         $toolbar = new ilToolbarGUI();
         $toolbar->addButton(
             $this->lng->txt('search_new'),
             $this->ctrl->getLinkTarget($this, 'showSearch')
         );
         $this->tpl->setVariable('ACTION_BUTTONS', $toolbar->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRole()

ilRepositorySearchGUI::addRole ( )

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

References $id, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupType(), ilParticipants\getDefaultMemberRole(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and showSearchResults().

                              : void
     {
         $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 = [];
         if ($this->http->wrapper()->post()->has('obj')) {
             $obj_ids = $this->http->wrapper()->post()->retrieve(
                 'obj',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
         $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($role_ids);
 
         $this->showSearchResults();
     }

Here is the call graph for this function:

◆ addUser()

ilRepositorySearchGUI::addUser ( )

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

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and showSearchResults().

                              : void
     {
         $class = $this->callback['class'];
         $method = $this->callback['method'];
 
         $users = [];
         if ($this->http->wrapper()->post()->has('user')) {
             $users = $this->http->wrapper()->post()->retrieve(
                 'user',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
 
         // call callback if that function does give a return value => show error message
         // listener redirects if everything is ok.
         $class->$method($users);
 
         $this->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 }.

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

References $user_filter.

                                                                       : void
     {
         $this->user_filter = $user_filter;
     }

◆ addUserFromAutoComplete()

ilRepositorySearchGUI::addUserFromAutoComplete ( )

protected

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

References $user_id, ilObjUser\_lookupId(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initUserTypeFromPost(), and ILIAS\Repository\refinery().

                                                 : void
     {
         $class = $this->callback['class'];
         $method = $this->callback['method'];
 
         $post_users = '';
         if ($this->http->wrapper()->post()->has('user_login')) {
             $post_users = $this->http->wrapper()->post()->retrieve(
                 'user_login',
                 $this->refinery->kindlyTo()->string()
             );
         }
 
         $users = explode(',', $post_users);
         $user_ids = array();
         foreach ($users as $user) {
             $user_id = ilObjUser::_lookupId($user);
             if ($user_id) {
                 $user_ids[] = $user_id;
             }
         }
 
         $user_type = $this->initUserTypeFromPost();
         if (!$class->$method($user_ids, $user_type)) {
             $this->ctrl->returnToParent($this);
         }
     }

Here is the call graph for this function:

◆ allowObjectSelection()

ilRepositorySearchGUI::allowObjectSelection ( bool $a_value = false )

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

                                                                : void
     {
         $this->object_selection = $a_value;
     }

◆ appendSearch()

ilRepositorySearchGUI::appendSearch ( )

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

References performSearch(), and ilSession\set().

                                   : void
     {
         ilSession::set('search_append', true);
         $this->performSearch();
     }

Here is the call graph for this function:

◆ cancel()

ilRepositorySearchGUI::cancel ( )

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ doUserAutoComplete()

ilRepositorySearchGUI::doUserAutoComplete ( )

protected

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

References ANONYMOUS_USER_ID, exit, getPrivacyMode(), getUserLimitations(), ILIAS\FileDelivery\http(), ilUserAutoComplete\MAX_ENTRIES, ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                            : ?string
     {
         // hide anonymout request
         if ($this->user->getId() == ANONYMOUS_USER_ID) {
             echo json_encode(new stdClass(), JSON_THROW_ON_ERROR);
             exit;
         }
         if (!$this->http->wrapper()->query()->has('autoCompleteField')) {
             $a_fields = [
                 'login',
                 'firstname',
                 'lastname',
                 'email'
             ];
             $result_field = 'login';
         } else {
             $auto_complete_field = $this->http->wrapper()->query()->retrieve(
                 'autoCompleteField',
                 $this->refinery->kindlyTo()->string()
             );
             $a_fields = [$auto_complete_field];
             $result_field = $auto_complete_field;
         }
         $auto = new ilUserAutoComplete();
         $auto->setPrivacyMode($this->getPrivacyMode());
 
         if ($this->http->wrapper()->query()->has('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(Closure::fromCallable($this->user_filter));
         }
 
         $query = '';
         if ($this->http->wrapper()->post()->has('term')) {
             $query = $this->http->wrapper()->post()->retrieve(
                 'term',
                 $this->refinery->kindlyTo()->string()
             );
         }
         if ($query === "") {
             if ($this->http->wrapper()->query()->has('term')) {
                 $query = $this->http->wrapper()->query()->retrieve(
                     'term',
                     $this->refinery->kindlyTo()->string()
                 );
             }
         }
         echo $auto->getList($query);
         exit;
     }

Here is the call graph for this function:

◆ emptyClipboard()

ilRepositorySearchGUI::emptyClipboard ( )

protected

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

References ILIAS\Repository\ctrl(), ilUserClipboard\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                        : void
     {
         $clip = ilUserClipboard::getInstance($this->user->getId());
         $clip->clear();
         $clip->save();
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ enableSearchableCheck()

ilRepositorySearchGUI::enableSearchableCheck ( bool $a_status )

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

                                                          : void
     {
         $this->searchable_check = $a_status;
     }

◆ executeCommand()

ilRepositorySearchGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl().

                                     : bool
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         switch ($next_class) {
             default:
                 if (!$cmd) {
                     $cmd = "showSearch";
                 }
                 $this->$cmd();
                 break;
         }
         return true;
     }

Here is the call graph for this function:

◆ fillAutoCompleteToolbar()

static ilRepositorySearchGUI::fillAutoCompleteToolbar	(	object	$parent_object,
		?ilToolbarGUI	$toolbar = `null`,
		array	$a_options = `[]`,
		bool	$a_sticky = `false`
	)

static

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') )

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

References $DIC, ilObject\_lookupObjId(), ILIAS\UI\Factory\button(), ilTree\checkForParentType(), ilObject\getId(), ilSubmitButton\getInstance(), ilUserClipboard\getInstance(), ILIAS\Repository\int(), ilLanguage\loadLanguageModule(), null, and ilLanguage\txt().

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

      : ilToolbarGUI {
         global $DIC;
 
         $ilToolbar = $DIC->toolbar();
         $lng = $DIC->language();
         $ilCtrl = $DIC->ctrl();
         $tree = $DIC->repositoryTree();
         $user = $DIC->user();
         $ui_factory = $DIC->ui()->factory();
         $ui_renderer = $DIC->ui()->renderer();
 
         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;
         }
 
         if (!isset($a_options['add_search'])) {
             $a_options['add_search'] = false;
         }
         if (!isset($a_options['add_from_container'])) {
             $a_options['add_from_container'] = null;
         }
 
         $ajax_url = $ilCtrl->getLinkTargetByClass(
             array(get_class($parent_object),'ilRepositorySearchGUI'),
             'doUserAutoComplete',
             '',
             true,
             false
         );
 
         $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 (isset($a_options['user_type']) && count((array) $a_options['user_type'])) {
             $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);
             }
         }
 
         $clip = ilUserClipboard::getInstance($user->getId());
 
         $add_button = ilSubmitButton::getInstance();
         $add_button->setCaption($a_options['submit_name'], false);
         $add_button->setCommand('addUserFromAutoComplete');
 
         if (!$a_sticky || $clip->hasContent()) {
             $toolbar->addButtonInstance($add_button);
         } else {
             $toolbar->addStickyItem($add_button);
         }
 
         if ($clip->hasContent()) {
             $clip_button = ilSubmitButton::getInstance();
             $clip_button->addCSSClass('btn btndefault');
             $lng->loadLanguageModule('user');
             $clip_button->setCaption($lng->txt('clipboard_add_from_btn'), false);
             $clip_button->setCommand('showClipboard');
 
             $toolbar->addButtonInstance($clip_button);
         }
 
         if ($a_options['add_search'] ||
             is_numeric($a_options['add_from_container'])) {
             $lng->loadLanguageModule("search");
 
             $toolbar->addSeparator();
 
             if ($a_options['add_search']) {
                 $button = $ui_factory->button()->standard(
                     $lng->txt('search_users'),
                     $ilCtrl->getLinkTargetByClass(strtolower(self::class), '')
                 );
                 $toolbar->addComponent($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 ($a_options['add_search']) {
                         $toolbar->addSpacer();
                     }
 
                     $ilCtrl->setParameterByClass('ilRepositorySearchGUI', "list_obj", ilObject::_lookupObjId($parent_container_ref_id));
 
                     $button = $ui_factory->button()->standard(
                         $lng->txt('search_add_members_from_container_' . $parent_container_type),
                         $ilCtrl->getLinkTargetByClass(array(get_class($parent_object),'ilRepositorySearchGUI'), 'listUsers')
                     );
                     $toolbar->addComponent($button);
                 }
             }
         }
 
         $toolbar->setFormAction(
             $ilCtrl->getFormActionByClass(
                 array(
                     get_class($parent_object),
                     'ilRepositorySearchGUI')
             )
         );
         return $toolbar;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrivacyMode()

ilRepositorySearchGUI::getPrivacyMode ( )

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

References $privacy_mode.

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

                                     : int
     {
         return $this->privacy_mode;
     }

Here is the caller graph for this function:

◆ getRoleCallback()

ilRepositorySearchGUI::getRoleCallback ( )

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

References $role_callback.

                                      : array
     {
         return $this->role_callback;
     }

◆ getSearchType()

ilRepositorySearchGUI::getSearchType ( )

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

References $search_type.

                                    : string
     {
         return $this->search_type;
     }

◆ getString()

ilRepositorySearchGUI::getString ( )

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

References $string.

                                : string
     {
         return $this->string;
     }

◆ getTitle()

ilRepositorySearchGUI::getTitle ( )

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

References $search_title.

Referenced by initFormSearch().

                               : string
     {
         return $this->search_title;
     }

Here is the caller graph for this function:

◆ getUserLimitations()

ilRepositorySearchGUI::getUserLimitations ( )

allow user limitations like inactive and access limitations

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

References $user_limitations.

Referenced by doUserAutoComplete(), and showSearchUserTable().

                                         : bool
     {
         return $this->user_limitations;
     }

Here is the caller graph for this function:

◆ handleMultiCommand()

ilRepositorySearchGUI::handleMultiCommand ( )

protected

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

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and showSearchResults().

                                            : void
     {
         $class = $this->callback['class'];
         $method = $this->callback['method'];
 
         $post_user = (array) ($this->http->request()->getParsedBody()['user'] ?? []);
         $post_selected_command = '';
         if (
             $this->http->wrapper()->post()->has('table_top_cmd') &&
             $this->http->wrapper()->post()->has('selectedCommand_2')
         ) {
             $post_selected_command = $this->http->wrapper()->post()->retrieve(
                 'selectedCommand_2',
                 $this->refinery->kindlyTo()->string()
             );
         } elseif ($this->http->wrapper()->post()->has('selectedCommand')) {
             $post_selected_command = $this->http->wrapper()->post()->retrieve(
                 'selectedCommand',
                 $this->refinery->kindlyTo()->string()
             );
         }
         // Redirects if everything is ok
         if (!$class->$method($post_user, $post_selected_command)) {
             $this->showSearchResults();
         }
     }

Here is the call graph for this function:

◆ initFormSearch()

ilRepositorySearchGUI::initFormSearch ( ?ilObjUser $user = null )

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

Referenced by showSearch().

                                                            : void
     {
         $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
         foreach (ilUserSearchOptions::_getSearchableFieldsInfo(!$this->isSearchableCheckEnabled()) as $info) {
             switch ($info['type'] ?? ilUserSearchOptions::FIELD_TYPE_UDF_UNDEFINED) {
                 case ilUserSearchOptions::FIELD_TYPE_UDF_SELECT:
                 case ilUserSearchOptions::FIELD_TYPE_SELECT:
 
                     $sel = new ilSelectInputGUI($info['lang'], "rep_query[usr][" . $info['db'] . "]");
                     $sel->setOptions($info['values']);
                     $users->addSubItem($sel);
                     break;
 
                 case ilUserSearchOptions::FIELD_TYPE_MULTI:
                 case ilUserSearchOptions::FIELD_TYPE_UDF_TEXT:
                 case ilUserSearchOptions::FIELD_TYPE_TEXT:
 
                     if (isset($info['autoComplete']) and $info['autoComplete']) {
                         $this->ctrl->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($this->ctrl->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,
                 $this->form
             );
             $orgu->getExplorerGUI()->setSelectableTypes(["orgu"]);
             $orgu->getExplorerGUI()->setTypeWhiteList(["root", "orgu"]);
             $orgu->getExplorerGUI()->setRootId(ilObjOrgUnit::getRootOrgRefId());
             $orgu->getExplorerGUI()->setAjax(false);
             $orgus->addSubItem($orgu);
             $kind->addOption($orgus);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserTypeFromPost()

ilRepositorySearchGUI::initUserTypeFromPost ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by addFromClipboard(), addUserFromAutoComplete(), and showClipboard().

                                              : string
     {
         if ($this->http->wrapper()->post()->has('user_type')) {
             return $this->http->wrapper()->post()->retrieve(
                 'user_type',
                 $this->refinery->kindlyTo()->string()
             );
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserTypeFromQuery()

ilRepositorySearchGUI::initUserTypeFromQuery ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by addFromClipboard(), removeFromClipboard(), and showClipboard().

                                               : string
     {
         if ($this->http->wrapper()->query()->has('user_type')) {
             return $this->http->wrapper()->query()->retrieve(
                 'user_type',
                 $this->refinery->kindlyTo()->string()
             );
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSearchableCheckEnabled()

ilRepositorySearchGUI::isSearchableCheckEnabled ( )

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

References $searchable_check.

Referenced by __performUserSearch(), and initFormSearch().

                                               : bool
     {
         return $this->searchable_check;
     }

Here is the caller graph for this function:

◆ listUsers()

ilRepositorySearchGUI::listUsers ( array $selected_entries = [] )

protected

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

References __appendToStoredResults(), ilObject\_getAllReferences(), ilObject\_lookupType(), addNewSearchButton(), ILIAS\Repository\filter(), ilSession\get(), ilOrgUnitUserAssignmentQueries\getInstance(), ilUserFilter\getInstance(), ilParticipants\getInstanceByObjId(), ilParticipants\hasParticipantListAccess(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSession\set(), showSearchResults(), and showSearchUserTable().

Referenced by performSearch(), and storedUserList().

                                                               : bool
     {
         // get parameter is used e.g. in exercises to provide
         // "add members of course" link
         if (
             $this->http->wrapper()->post()->has('obj') &&
             !count($selected_entries)
         ) {
             $selected_entries = $this->http->wrapper()->post()->retrieve(
                 'obj',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
         if (
             $this->http->wrapper()->query()->has('list_obj') &&
             !count($selected_entries)
         ) {
             $selected_entries[] = $this->http->wrapper()->query()->retrieve(
                 'list_obj',
                 $this->refinery->kindlyTo()->int()
             );
         }
         if (!count($selected_entries)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->showSearchResults();
             return false;
         }
         $rep_search = ilSession::get('rep_search') ?? [];
         $rep_search['objs'] = $selected_entries;
         ilSession::set('rep_search', $rep_search);
 
         // Get all members
         $members = array();
         foreach ($selected_entries as $obj_id) {
             $type = ilObject::_lookupType($obj_id);
             switch ($type) {
                 case 'crs':
                 case 'grp':
                     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':
                     $assigned = [];
                     if (is_callable($this->user_filter)) {
                         $assigned = call_user_func_array(
                             $this->user_filter,
                             [
                                 $this->rbacreview->assignedUsers($obj_id)
                             ]
                         );
                     } else {
                         $assigned = $this->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($members);
         $this->__appendToStoredResults($members);
 
         $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'components/ILIAS/Search');
 
         $this->addNewSearchButton();
         $rep_search = ilSession::get('rep_search');
         $this->showSearchUserTable($rep_search['usr'] ?? [], 'storedUserList');
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSearch()

ilRepositorySearchGUI::performSearch ( )

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

References $message, $ref_id, $res, __performCourseSearch(), __performGroupSearch(), __performRoleSearch(), __performUserSearch(), __updateResults(), ilObject\_lookupObjId(), ilSession\clear(), ILIAS\Repository\filter(), ilUserFilter\getInstance(), getPrivacyMode(), ILIAS\FileDelivery\http(), listUsers(), ILIAS\Repository\lng(), ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING, ROOT_FOLDER_ID, ILIAS\Repository\settings(), show(), showSearch(), start(), and ilUtil\stripSlashes().

Referenced by appendSearch().

                                    : bool
     {
         // 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 false;
         }
         $found_query = false;
 
         $post_rep_query = (array) ($this->http->request()->getParsedBody()['rep_query'] ?? []);
         $post_search_for = (string) ($this->http->request()->getParsedBody()['search_for'] ?? '');
         if (isset($post_rep_query[$post_search_for])) {
             foreach ((array) $post_rep_query[$post_search_for] as $field => $value) {
                 if (trim(ilUtil::stripSlashes($value))) {
                     $found_query = true;
                     break;
                 }
             }
         }
         if ($this->http->wrapper()->post()->has('rep_query_orgu')) {
             $found_query = true;
         }
         if (!$found_query) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_search_string'));
             $this->start();
             return false;
         }
 
         $post_cmd = (array) ($this->http->request()->getParsedBody()['cmd'] ?? []);
         // unset search_append if called directly
         if (isset($post_cmd['performSearch'])) {
             ilSession::clear('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_rep_query_orgu = (array) ($this->http->request()->getParsedBody()['rep_query_orgu'] ?? []);
                 $selected_objects = array_map(
                     function ($ref_id) {
                         return ilObject::_lookupObjId((int) $ref_id);
                     },
                     $post_rep_query_orgu
                 );
                 return $this->listUsers($selected_objects);
             default:
                 echo 'not defined';
         }
 
         $this->result_obj->setRequiredPermission('read');
         $this->result_obj->addObserver($this, 'searchResultFilterListener');
         $this->result_obj->filter(ROOT_FOLDER_ID, true);
 
         // 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();
             }
 
             $this->search_results = array_intersect(
                 $result_ids,
                 ilUserFilter::getInstance()->filter($result_ids)
             );
         } else {
             $this->search_results = array();
             foreach ($this->result_obj->getResults() as $res) {
                 $this->search_results[] = $res['obj_id'];
             }
         }
 
         if (!count($this->search_results)) {
             $this->tpl->setOnScreenMessage('failure', $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());
             $this->tpl->setOnScreenMessage('info', $message);
             return true;
         }
         // show results
         $this->show();
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromClipboard()

ilRepositorySearchGUI::removeFromClipboard ( )

protected

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

References ILIAS\Repository\ctrl(), ilUserClipboard\getInstance(), ILIAS\FileDelivery\http(), initUserTypeFromQuery(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                             : void
     {
         $users = [];
         if ($this->http->wrapper()->post()->has('uids')) {
             $users = $this->http->wrapper()->post()->retrieve(
                 'uids',
                 $this->refinery->kindlyTo()->listOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
 
         $this->ctrl->setParameter($this, 'user_type', $this->initUserTypeFromQuery());
         if (!count($users)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'showClipboard');
         }
 
         $clip = ilUserClipboard::getInstance($this->user->getId());
         $clip->delete($users);
         $clip->save();
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
         $this->ctrl->redirect($this, 'showClipboard');
     }

Here is the call graph for this function:

◆ searchResultFilterListener()

ilRepositorySearchGUI::searchResultFilterListener	(	int	$a_ref_id,
		array	$a_data
	)

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

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

References ANONYMOUS_USER_ID.

                                                                             : bool
     {
         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 1376 of file class.ilRepositorySearchGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and showSearchResults().

                                      : bool
     {
         // get parameter is used e.g. in exercises to provide
         // "add members of course"
         $selected_entries = [];
         if ($this->http->wrapper()->post()->has('obj')) {
             $selected_entries = $this->http->wrapper()->post()->retrieve(
                 'obj',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
         if (
             $this->http->wrapper()->query()->has('list_obj') &&
             !count($selected_entries)
         ) {
             $selected_entries[] = $this->http->wrapper()->query()->retrieve(
                 'list_obj',
                 $this->refinery->kindlyTo()->int()
             );
         }
 
         if (!count($selected_entries)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->showSearchResults();
             return false;
         }
         $this->ctrl->setParameter($this->callback["class"], "obj", implode(";", $selected_entries));
         $this->ctrl->redirect($this->callback["class"], $this->callback["method"]);
         return true;
     }

Here is the call graph for this function:

◆ setCallback()

ilRepositorySearchGUI::setCallback	(	object	$class,
		string	$method,
		array	$a_add_options = `[]`,
		string	$default_option = `''`
	)

Parameters

string[] $a_add_options

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

References $default_option.

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

◆ setPermissionQueryCallback()

ilRepositorySearchGUI::setPermissionQueryCallback	(	object	$class,
		string	$method
	)

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

                                                                              : void
     {
     }

◆ setPrivacyMode()

ilRepositorySearchGUI::setPrivacyMode ( int $privacy_mode )

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

References $privacy_mode.

                                                      : void
     {
         $this->privacy_mode = $privacy_mode;
     }

◆ setRoleCallback()

ilRepositorySearchGUI::setRoleCallback	(	object	$class,
		string	$method,
		array	$a_add_options = `[]`,
		string	$default_option = `''`
	)

Parameters

string[] $a_add_options

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

References $default_option.

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

◆ setString()

ilRepositorySearchGUI::setString ( string $a_str )

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

References ilSession\get(), and ilSession\set().

                                             : void
     {
         $search = ilSession::get('search');
         $search['string'] = $this->string = $a_str;
         ilSession::set('search', $search);
     }

Here is the call graph for this function:

◆ setTitle()

ilRepositorySearchGUI::setTitle ( string $a_title )

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

Referenced by __construct().

                                              : void
     {
         $this->search_title = $a_title;
     }

Here is the caller graph for this function:

◆ setUserLimitations()

ilRepositorySearchGUI::setUserLimitations ( bool $a_limitations )

allow user limitations like inactive and access limitations

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

                                                            : void
     {
         $this->user_limitations = $a_limitations;
     }

◆ show()

ilRepositorySearchGUI::show ( )

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

References showSearchResults().

Referenced by performSearch().

                           : void
     {
         $this->showSearchResults();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showClipboard()

ilRepositorySearchGUI::showClipboard ( )

protected

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

References ILIAS\Repository\ctrl(), initUserTypeFromPost(), initUserTypeFromQuery(), ILIAS\Repository\lng(), ilTable2GUI\setFormAction(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

                                       : void
     {
         $user_type = $this->initUserTypeFromQuery();
         if ($user_type === '') {
             $user_type = $this->initUserTypeFromPost();
         }
         $this->ctrl->setParameter($this, 'user_type', $user_type);
         $this->tabs->clearTargets();
         $this->tabs->setBackTarget(
             $this->lng->txt('back'),
             $this->ctrl->getParentReturn($this)
         );
 
         $clip = new ilUserClipboardTableGUI($this, 'showClipboard', $this->user->getId());
         $clip->setFormAction($this->ctrl->getFormAction($this));
         $clip->init();
         $clip->parse();
 
         $this->tpl->setContent($clip->getHTML());
     }

Here is the call graph for this function:

◆ showSearch()

ilRepositorySearchGUI::showSearch ( )

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

References ILIAS\Repository\form(), getPrivacyMode(), initFormSearch(), and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

Referenced by performSearch(), and start().

                                 : void
     {
         // 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());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSearchCourseTable()

ilRepositorySearchGUI::showSearchCourseTable ( array $a_obj_ids )

protected

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

Referenced by showSearchResults().

                                                               : void
     {
         $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
         $table->parseObjectIds($a_obj_ids);
 
         $this->tpl->setVariable('RES_TABLE', $table->getHTML());
     }

Here is the caller graph for this function:

◆ showSearchGroupTable()

ilRepositorySearchGUI::showSearchGroupTable ( array $a_obj_ids )

protected

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

Referenced by showSearchResults().

                                                              : void
     {
         $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
         $table->parseObjectIds($a_obj_ids);
 
         $this->tpl->setVariable('RES_TABLE', $table->getHTML());
     }

Here is the caller graph for this function:

◆ showSearchResults()

ilRepositorySearchGUI::showSearchResults ( )

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

References addNewSearchButton(), ilSession\get(), showSearchCourseTable(), showSearchGroupTable(), showSearchRoleTable(), and showSearchUserTable().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSearchRoleTable()

ilRepositorySearchGUI::showSearchRoleTable ( array $a_obj_ids )

protected

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

Referenced by showSearchResults().

                                                             : void
     {
         $table = new ilRepositoryObjectResultTableGUI($this, 'showSearchResults', $this->object_selection);
         $table->parseObjectIds($a_obj_ids);
 
         $this->tpl->setVariable('RES_TABLE', $table->getHTML());
     }

Here is the caller graph for this function:

◆ showSearchSelected()

ilRepositorySearchGUI::showSearchSelected ( )

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

References addNewSearchButton(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and showSearchUserTable().

                                         : void
     {
         $selected = [];
         if ($this->http->wrapper()->query()->has('selected_id')) {
             $selected = $this->http->wrapper()->query()->retrieve(
                 'selected_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'components/ILIAS/Search');
         $this->addNewSearchButton();
         $this->showSearchUserTable([$selected], 'showSearchResults');
     }

Here is the call graph for this function:

◆ showSearchUserTable()

ilRepositorySearchGUI::showSearchUserTable	(	array	$a_usr_ids,
		string	$a_parent_cmd
	)

protected

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

References $default_option, ILIAS\Repository\ctrl(), getUserLimitations(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilSession\set().

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

                                                                                   : void
     {
         $base_class = '';
         if ($this->http->wrapper()->query()->has('baseClass')) {
             $base_class = $this->http->wrapper()->query()->retrieve(
                 'baseClass',
                 $this->refinery->kindlyTo()->string()
             );
         }
 
         // String value of 'baseClass' is in lower case
         $is_in_admin = ($base_class === strtolower(ilAdministrationGUI::class));
 
         if ($is_in_admin) {
             // remember link target to admin search gui (this)
             ilSession::set('usr_search_link', $this->ctrl->getLinkTarget($this, 'show'));
         }
 
         $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'),
                 $this->default_option
             );
         } 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());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

ilRepositorySearchGUI::start ( )

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

References __clearSession(), and showSearch().

Referenced by performSearch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storedUserList()

ilRepositorySearchGUI::storedUserList ( )

protected

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

References ilSession\get(), and listUsers().

                                        : bool
     {
         $rep_search = ilSession::get('rep_search');
         $objects = $rep_search['objs'] ?? [];
         $this->listUsers($objects);
         return true;
     }