ilRepositorySearchGUI Class Reference

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 37 of file class.ilRepositorySearchGUI.php.

Constructor & Destructor Documentation

__construct()

ilRepositorySearchGUI::__construct

(

)

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

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

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().

Here is the call graph for this function:

Member Function Documentation

__appendToStoredResults()

ilRepositorySearchGUI::__appendToStoredResults

(

array

$a_usr_ids

)

Returns

int[]

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

                                                             : 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'];
    }

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

Here is the call graph for this function:

__clearSession()

ilRepositorySearchGUI::__clearSession

(

)

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

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

References ilSession\clear().

Here is the call graph for this function:

__loadQueries()

ilRepositorySearchGUI::__loadQueries

(

)

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

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

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

Referenced by __construct().

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 1053 of file class.ilRepositorySearchGUI.php.

    {
        $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;
    }

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

Here is the call graph for this function:

__performCourseSearch()

ilRepositorySearchGUI::__performCourseSearch ( )

protected

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

                                              : 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;
    }

References ilSession\get().

Here is the call graph for this function:

__performGroupSearch()

ilRepositorySearchGUI::__performGroupSearch

(

)

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

                                          : 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;
    }

References ilSession\get().

Here is the call graph for this function:

__performRoleSearch()

ilRepositorySearchGUI::__performRoleSearch

(

)

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

                                         : 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;
    }

References ilSession\get().

Here is the call graph for this function:

__performUserSearch()

ilRepositorySearchGUI::__performUserSearch

(

)

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

                                         : 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;
    }

References $name, 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(), and ilObjectSearchFactory\getUserOrgUnitAssignmentInstance().

Here is the call graph for this function:

__setSearchType()

ilRepositorySearchGUI::__setSearchType

(

)

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

                                     : 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;
    }

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

Referenced by __construct().

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 1138 of file class.ilRepositorySearchGUI.php.

                                                           : 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;
        }
    }

__updateResults()

ilRepositorySearchGUI::__updateResults

(

)

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

                                     : 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;
    }

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

Here is the call graph for this function:

addFromClipboard()

ilRepositorySearchGUI::addFromClipboard ( )

protected

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

                                         : 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);
        }
    }

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

Here is the call graph for this function:

addNewSearchButton()

ilRepositorySearchGUI::addNewSearchButton ( )

protected

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

addRole()

ilRepositorySearchGUI::addRole

(

)

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

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

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

Here is the call graph for this function:

addUser()

ilRepositorySearchGUI::addUser

(

)

Reimplemented in ilStudyProgrammeRepositorySearchGUI.

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

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

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

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 140 of file class.ilRepositorySearchGUI.php.

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

References $user_filter.

addUserFromAutoComplete()

ilRepositorySearchGUI::addUserFromAutoComplete ( )

protected

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

                                                : 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);
        }
    }

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

Here is the call graph for this function:

allowObjectSelection()

ilRepositorySearchGUI::allowObjectSelection

(

bool

$a_value = false

)

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

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

appendSearch()

ilRepositorySearchGUI::appendSearch

(

)

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

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

References ilSession\set().

Here is the call graph for this function:

cancel()

ilRepositorySearchGUI::cancel

(

)

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

doUserAutoComplete()

ilRepositorySearchGUI::doUserAutoComplete ( )

protected

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

                                           : ?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;
    }

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

Here is the call graph for this function:

emptyClipboard()

ilRepositorySearchGUI::emptyClipboard ( )

protected

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

                                       : 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);
    }

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

Here is the call graph for this function:

enableSearchableCheck()

ilRepositorySearchGUI::enableSearchableCheck

(

bool

$a_status

)

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

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

executeCommand()

ilRepositorySearchGUI::executeCommand

(

)

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

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

References ILIAS\Repository\ctrl().

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 194 of file class.ilRepositorySearchGUI.php.

     : ilToolbarGUI {
        global $DIC;
 
        $ilToolbar = $DIC->toolbar();
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $tree = $DIC->repositoryTree();
        $user = $DIC->user();
 
        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());
        if ($clip->hasContent()) {
            $action_button = ilSplitButtonGUI::getInstance();
 
            $add_button = ilSubmitButton::getInstance();
            $add_button->setCaption($a_options['submit_name'], false);
            $add_button->setCommand('addUserFromAutoComplete');
 
            $action_button->setDefaultButton($add_button);
 
            $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');
 
            $action_button->addMenuItem(new ilButtonToSplitButtonMenuItemAdapter($clip_button));
 
            $toolbar->addButtonInstance($action_button);
        } else {
            $button = ilSubmitButton::getInstance();
            $button->setCaption($a_options['submit_name'], false);
            $button->setCommand('addUserFromAutoComplete');
            if (!$a_sticky) {
                $toolbar->addButtonInstance($button);
            } else {
                $toolbar->addStickyItem($button);
            }
        }
 
        if ($a_options['add_search'] ||
            is_numeric($a_options['add_from_container'])) {
            $lng->loadLanguageModule("search");
 
            $toolbar->addSeparator();
 
            if ($a_options['add_search']) {
                $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 ($a_options['add_search']) {
                        $toolbar->addSpacer();
                    }
 
                    $ilCtrl->setParameterByClass('ilRepositorySearchGUI', "list_obj", ilObject::_lookupObjId($parent_container_ref_id));
 
                    $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;
    }

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

Here is the caller graph for this function:

getPrivacyMode()

ilRepositorySearchGUI::getPrivacyMode

(

)

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

                                    : int
    {
        return $this->privacy_mode;
    }

References $privacy_mode.

getRoleCallback()

ilRepositorySearchGUI::getRoleCallback

(

)

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

                                     : array
    {
        return $this->role_callback;
    }

References $role_callback.

getSearchType()

ilRepositorySearchGUI::getSearchType

(

)

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

                                   : string
    {
        return $this->search_type;
    }

References $search_type.

getString()

ilRepositorySearchGUI::getString

(

)

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

                               : string
    {
        return $this->string;
    }

getTitle()

ilRepositorySearchGUI::getTitle

(

)

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

                              : string
    {
        return $this->search_title;
    }

References $search_title.

getUserLimitations()

ilRepositorySearchGUI::getUserLimitations

(

)

allow user limitations like inactive and access limitations

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

                                        : bool
    {
        return $this->user_limitations;
    }

handleMultiCommand()

ilRepositorySearchGUI::handleMultiCommand ( )

protected

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

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

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

Here is the call graph for this function:

initFormSearch()

ilRepositorySearchGUI::initFormSearch

(

ilObjUser

$user = null

)

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

                                                          : 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);
        }
    }

References $txt, ilUserSearchOptions\_getSearchableFieldsInfo(), ilUserSearchOptions\_isEnabled(), ILIAS\Repository\ctrl(), ilUserSearchOptions\FIELD_TYPE_MULTI, ilUserSearchOptions\FIELD_TYPE_SELECT, ilUserSearchOptions\FIELD_TYPE_TEXT, ilUserSearchOptions\FIELD_TYPE_UDF_SELECT, ilUserSearchOptions\FIELD_TYPE_UDF_TEXT, ilUserSearchOptions\FIELD_TYPE_UDF_UNDEFINED, ILIAS\Repository\form(), ilObjUser\getFirstname(), ilObjUser\getLastname(), ilObjUser\getLogin(), ilObjOrgUnit\getRootOrgRefId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

initUserTypeFromPost()

ilRepositorySearchGUI::initUserTypeFromPost ( )

protected

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

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

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

Here is the call graph for this function:

initUserTypeFromQuery()

ilRepositorySearchGUI::initUserTypeFromQuery ( )

protected

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

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

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

Here is the call graph for this function:

isSearchableCheckEnabled()

ilRepositorySearchGUI::isSearchableCheckEnabled

(

)

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

                                              : bool
    {
        return $this->searchable_check;
    }

References $searchable_check.

listUsers()

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

protected

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

                                                              : 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', 'Services/Search');
 
        $this->addNewSearchButton();
        $rep_search = ilSession::get('rep_search');
        $this->showSearchUserTable($rep_search['usr'] ?? [], 'storedUserList');
        return true;
    }

References $type, ilObject\_getAllReferences(), ilObject\_lookupType(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilSession\get(), ilOrgUnitUserAssignmentQueries\getInstance(), ilUserFilter\getInstance(), ilParticipants\getInstanceByObjId(), ilParticipants\hasParticipantListAccess(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilSession\set().

Here is the call graph for this function:

performSearch()

ilRepositorySearchGUI::performSearch

(

)

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

                                   : 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;
    }

References $message, $ref_id, $res, ilObject\_lookupObjId(), ilSession\clear(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilUserFilter\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING, ROOT_FOLDER_ID, show(), and ilUtil\stripSlashes().

Here is the call graph for this function:

removeFromClipboard()

ilRepositorySearchGUI::removeFromClipboard ( )

protected

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

                                            : 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');
    }

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

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 1362 of file class.ilRepositorySearchGUI.php.

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

References ANONYMOUS_USER_ID.

selectObject()

ilRepositorySearchGUI::selectObject ( )

protected

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

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

                                     : 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;
    }

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

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 644 of file class.ilRepositorySearchGUI.php.

     : 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 670 of file class.ilRepositorySearchGUI.php.

                                                                             : void
    {
    }

setPrivacyMode()

ilRepositorySearchGUI::setPrivacyMode

(

int

$privacy_mode

)

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

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

References $privacy_mode.

setRoleCallback()

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

Parameters

string[]

$a_add_options

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

     : 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 396 of file class.ilRepositorySearchGUI.php.

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

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

Here is the call graph for this function:

setTitle()

ilRepositorySearchGUI::setTitle

(

string

$a_title

)

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

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

Referenced by __construct().

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 1414 of file class.ilRepositorySearchGUI.php.

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

show()

ilRepositorySearchGUI::show

(

)

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

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

showClipboard()

ilRepositorySearchGUI::showClipboard ( )

protected

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

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

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

Here is the call graph for this function:

showSearch()

ilRepositorySearchGUI::showSearch

(

)

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

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

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

Here is the call graph for this function:

showSearchCourseTable()

ilRepositorySearchGUI::showSearchCourseTable ( array  $a_obj_ids )

protected

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

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

showSearchGroupTable()

ilRepositorySearchGUI::showSearchGroupTable ( array  $a_obj_ids )

protected

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

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

showSearchResults()

ilRepositorySearchGUI::showSearchResults

(

)

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

                                       : void
    {
        $counter = 0;
        $f_result = array();
 
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.rep_search_result.html', 'Services/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;
        }
    }

References ilSession\get().

Here is the call graph for this function:

showSearchRoleTable()

ilRepositorySearchGUI::showSearchRoleTable ( array  $a_obj_ids )

protected

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

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

showSearchSelected()

ilRepositorySearchGUI::showSearchSelected

(

)

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

                                        : 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', 'Services/Search');
        $this->addNewSearchButton();
        $this->showSearchUserTable([$selected], 'showSearchResults');
    }

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

Here is the call graph for this function:

showSearchUserTable()

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

protected

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

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

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

Here is the call graph for this function:

start()

ilRepositorySearchGUI::start

(

)

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

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

storedUserList()

ilRepositorySearchGUI::storedUserList ( )

protected

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

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

References ilSession\get().

Here is the call graph for this function:

Field Documentation

$add_options

array ilRepositorySearchGUI::$add_options = []

protected

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

$callback

array ilRepositorySearchGUI::$callback = []

protected

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

$ctrl

ilCtrl ilRepositorySearchGUI::$ctrl

protected

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

$default_option

string ilRepositorySearchGUI::$default_option = ''

protected

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

$form

ilPropertyFormGUI ilRepositorySearchGUI::$form = null

protected

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

$http

GlobalHttpState ilRepositorySearchGUI::$http

private

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

$lng

ilLanguage ilRepositorySearchGUI::$lng

protected

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

$object_selection

bool ilRepositorySearchGUI::$object_selection = false

protected

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

$privacy_mode

int ilRepositorySearchGUI::$privacy_mode = ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING

private

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

Referenced by getPrivacyMode(), and setPrivacyMode().

$rbacreview

ilRbacReview ilRepositorySearchGUI::$rbacreview

protected

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

$refinery

RefineryFactory ilRepositorySearchGUI::$refinery

private

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

Referenced by ilStudyProgrammeRepositorySearchGUI\addUser().

$result_obj

ilSearchResult ilRepositorySearchGUI::$result_obj

protected

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

$role_callback

array ilRepositorySearchGUI::$role_callback = []

protected

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

Referenced by getRoleCallback().

$search_results

array ilRepositorySearchGUI::$search_results = []

private

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

$search_title

string ilRepositorySearchGUI::$search_title = ''

protected

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

Referenced by getTitle().

$search_type

string ilRepositorySearchGUI::$search_type = 'usr'

private

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

Referenced by getSearchType().

$searchable_check

bool ilRepositorySearchGUI::$searchable_check = true

protected

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

Referenced by isSearchableCheckEnabled().

$settings

ilSearchSettings ilRepositorySearchGUI::$settings

protected

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

$stored

bool ilRepositorySearchGUI::$stored = false

protected

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

$string

string ilRepositorySearchGUI::$string = ''

private

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

$tabs

ilTabsGUI ilRepositorySearchGUI::$tabs

protected

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

$tpl

ilGlobalTemplateInterface ilRepositorySearchGUI::$tpl

protected

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

$tree

ilTree ilRepositorySearchGUI::$tree

protected

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

$ui_factory

Factory ilRepositorySearchGUI::$ui_factory

protected

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

$ui_renderer

Renderer ilRepositorySearchGUI::$ui_renderer

protected

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

$user

ilObjUser ilRepositorySearchGUI::$user = null

protected

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

$user_filter

ilRepositorySearchGUI::$user_filter = null

protected

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

Referenced by addUserAccessFilterCallable().

$user_limitations

bool ilRepositorySearchGUI::$user_limitations = true

protected

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

---

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

• Services/Search/classes/class.ilRepositorySearchGUI.php