ilStudyProgrammeRepositorySearchGUI Class Reference

Custom repository search gui class for study programme to make it possible to get a handle on users selected in the repository search gui. More...

Inheritance diagram for ilStudyProgrammeRepositorySearchGUI:

Collaboration diagram for ilStudyProgrammeRepositorySearchGUI:

Public Member Functions
	addUser ()
Public Member Functions inherited from ilRepositorySearchGUI
	__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 ( $parent_object, ?ilToolbarGUI $toolbar=null, $a_options=array(), $a_sticky=false)
	This is just the same as in the parent class, except for the hardcoded class name. More...
Static Public Member Functions inherited from ilRepositorySearchGUI
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...

Additional Inherited Members
Protected Member Functions inherited from ilRepositorySearchGUI
	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 inherited from ilRepositorySearchGUI
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

Detailed Description

Custom repository search gui class for study programme to make it possible to get a handle on users selected in the repository search gui.

@ilCtrl_Calls ilStudyProgrammeRepositorySearchGUI: ilPropertyFormGUI

Definition at line 27 of file class.ilStudyProgrammeRepositorySearchGUI.php.

Member Function Documentation

addUser()

ilStudyProgrammeRepositorySearchGUI::addUser

(

)

Reimplemented from ilRepositorySearchGUI.

Definition at line 29 of file class.ilStudyProgrammeRepositorySearchGUI.php.

                             : void
    {
        global $DIC;
        $post_wrapper = $DIC->http()->wrapper()->post();
        $refinery = $DIC->refinery();
        $class = $this->callback['class'];
        $method = $this->callback['method'];
 
        // call callback if that function does give a return value => show error message
        // listener redirects if everything is ok.
        $class->$method($post_wrapper->retrieve('user', $refinery->kindlyTo()->listOf($refinery->kindlyTo()->string())));
        // Removed this from overwritten class, as we do not want to show the
        // results again...
        //$this->showSearchResults();
    }

References $DIC, and ilRepositorySearchGUI\$refinery.

fillAutoCompleteToolbar()

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

static

This is just the same as in the parent class, except for the hardcoded class name.

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

     : ilToolbarGUI {
        global $DIC;
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $tree = $DIC['tree'];
        $ui_factory = $DIC['ui.factory'];
 
        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');
        }
 
        $ajax_url = $ilCtrl->getLinkTargetByClass(
            array(get_class($parent_object),'ilStudyProgrammeRepositorySearchGUI'),
            '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 (count($a_options['user_type'] ?? [])) {
            $si = new ilSelectInputGUI("", "user_type");
            $si->setOptions($a_options['user_type']);
            if (!$a_sticky) {
                $toolbar->addInputItem($si);
            } else {
                $toolbar->addStickyItem($si);
            }
        }
 
        $button = $ui_factory->button()->standard($a_options['submit_name'], '#')
        ->withOnLoadCode(
            fn($id) => "
                document.getElementById('$id').addEventListener('click',
                function() {
                    let frm = this.closest('form');
                    frm.action = frm.action + '&cmd=addUserFromAutoComplete';
                    frm.submit();
                    return false;
                });
            "
        );
        $toolbar->addComponent($button);
 
        if ((bool) $a_options['add_search'] ||
            is_numeric($a_options['add_from_container'])) {
            $lng->loadLanguageModule("search");
 
            $toolbar->addSeparator();
 
            if ((bool) $a_options['add_search']) {
                $link = $ui_factory->link()->standard(
                    $lng->txt('search_users'),
                    $ilCtrl->getLinkTargetByClass('ilStudyProgrammeRepositorySearchGUI', '')
                );
                $toolbar->addComponent($link);
            }
 
            if (isset($a_options['add_from_container']) && is_numeric($a_options['add_from_container'])) {
                $parent_ref_id = (int) $a_options['add_from_container'];
                $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "grp");
                $parent_container_type = "grp";
                if (!$parent_container_ref_id) {
                    $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "crs");
                    $parent_container_type = "crs";
                }
                if ($parent_container_ref_id) {
                    if ((bool) $a_options['add_search']) {
                        $toolbar->addSpacer();
                    }
 
                    $ilCtrl->setParameterByClass(
                        'ilStudyProgrammeRepositorySearchGUI',
                        "list_obj",
                        ilObject::_lookupObjId($parent_container_ref_id)
                    );
 
                    $link = $ui_factory->link()->standard(
                        $lng->txt('search_add_members_from_container_' . $parent_container_type),
                        $ilCtrl->getLinkTargetByClass(
                            [get_class($parent_object),'ilStudyProgrammeRepositorySearchGUI'],
                            'listUsers'
                        )
                    );
                    $toolbar->addComponent($link);
                }
            }
        }
 
        $toolbar->setFormAction(
            $ilCtrl->getFormActionByClass(
                array(
                    get_class($parent_object),
                    'ilStudyProgrammeRepositorySearchGUI')
            )
        );
        return $toolbar;
    }

Referenced by ilObjStudyProgrammeMembersGUI\initSearchGUI().

Here is the caller graph for this function:

---

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

• components/ILIAS/StudyProgramme/classes/class.ilStudyProgrammeRepositorySearchGUI.php