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 ()
	Constructor public. More...
	addUserAccessFilterCallable (callable $user_filter)
	Closure for filtering users e.g $rep_search_gui->addUserAccessFilterCallable(function($user_ids) use($ref_id,$rbac_perm,$pos_perm)) { // filter users return $filtered_users }. More...
	setTitle ($a_title)
	Set form title. More...
	getTitle ()
	Get search form title. More...
	enableSearchableCheck ($a_status)
	En/disable the validation of the searchable flag. More...
	isSearchableCheckEnabled ()
	setPrivacyMode ($privacy_mode)
	getPrivacyMode ()
	setString ($a_str)
	Set/get search string public. More...
	getString ()
	executeCommand ()
	Control public. More...
	__clearSession ()
	cancel ()
	start ()
	addUser ()
	setCallback (&$class, $method, $a_add_options=array())
	setPermissionQueryCallback ($class, $method)
	Set callback method for user permission access queries. More...
	showSearch ()
	showSearchSelected ()
	submit from autocomplete More...
	initFormSearch (ilObjUser $user=null)
	show ()
	appendSearch ()
	performSearch ()
	Perform a search. More...
	__performUserSearch ()
	__performGroupSearch ()
	Search groups. More...
	__performRoleSearch ()
	Search roles. More...
&	__parseQueryString ($a_string, $a_combination_or=true, $a_ignore_length=false)
	parse query string, using query parser instance More...
	__loadQueries ()
	__setSearchType ()
	__updateResults ()
	__appendToStoredResults ($a_usr_ids)
	__storeEntries (&$new_res)
	showSearchResults ()
	searchResultFilterListener ($a_ref_id, $a_data)
	Listener called from ilSearchResult Id is obj_id for role, usr Id is ref_id for crs grp. More...
	allowObjectSelection ($a_value=false)
	Toggle object selection status. More...
	setUserLimitations ($a_limitations)
	allow user limitations like inactive and access limitations More...
	getUserLimitations ()
	allow user limitations like inactive and access limitations More...

Static Public Member Functions
static	fillAutoCompleteToolbar ($parent_object, ilToolbarGUI $toolbar=null, $a_options=array(), $a_sticky=false)
	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 ($parent_object, ilToolbarGUI $toolbar=null, $a_options=array(), $a_sticky=false)
	fill toolbar with More...

Additional Inherited Members
Data Fields inherited from ilRepositorySearchGUI
	$search_type = 'usr'
Protected Member Functions inherited from ilRepositorySearchGUI
	doUserAutoComplete ()
	Do auto completion. More...
	addUserFromAutoComplete ()
	Add user from auto complete input. More...
	showClipboard ()
	addFromClipboard ()
	add users from clipboard More...
	removeFromClipboard ()
	Remove from clipboard. More...
	emptyClipboard ()
	Remove from clipboard. More...
	handleMultiCommand ()
	Handle multi command. More...
	__performCourseSearch ()
	Search courses. More...
	addNewSearchButton ()
	Add new search button. More...
	showSearchUserTable ($a_usr_ids, $a_parent_cmd)
	Show usr table. More...
	showSearchRoleTable ($a_obj_ids)
	Show usr table. More...
	showSearchGroupTable ($a_obj_ids)
	showSearchCourseTable ($a_obj_ids)
	listUsers ()
	List users of course/group/roles. More...
	storedUserList ()
	Called from table sort. More...
	selectObject ()
	Return selection of course/group/roles to calling script. More...
Protected Attributes inherited from ilRepositorySearchGUI
	$add_options = array()
	$object_selection = false
	$searchable_check = true
	$search_title = ''
	$user_limitations = true
	$user_filter = null

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.

Author

Richard Klees

Version

$Id$

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

Member Function Documentation

addUser()

ilStudyProgrammeRepositorySearchGUI::addUser

(

)

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

References $_POST.

    {
        $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['user']);
        
        // Removed this from overwritten class, as we do not want to show the
        // results again...
        //$this->showSearchResults();
    }

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 33 of file class.ilStudyProgrammeRepositorySearchGUI.php.

References $DIC, $ilCtrl, $lng, $si, ilObject\_lookupObjId(), array, ilSubmitButton\getInstance(), and ilLinkButton\getInstance().

Referenced by ilObjStudyProgrammeMembersGUI\initSearchGUI().

    {
        global $DIC;
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $tree = $DIC['tree'];

        if (!$toolbar instanceof ilToolbarGUI) {
            $toolbar = $ilToolbar;
        }
        
        // Fill default options
        if (!isset($a_options['auto_complete_name'])) {
            $a_options['auto_complete_name'] = $lng->txt('obj_user');
        }
        if (!isset($a_options['auto_complete_size'])) {
            $a_options['auto_complete_size'] = 15;
        }
        if (!isset($a_options['submit_name'])) {
            $a_options['submit_name'] = $lng->txt('btn_add');
        }
        
        $ajax_url = $ilCtrl->getLinkTargetByClass(
            array(get_class($parent_object),'ilStudyProgrammeRepositorySearchGUI'),
            'doUserAutoComplete',
            '',
            true,
            false
        );

        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $ul = new ilTextInputGUI($a_options['auto_complete_name'], 'user_login');
        $ul->setDataSource($ajax_url);
        $ul->setSize($a_options['auto_complete_size']);
        if (!$a_sticky) {
            $toolbar->addInputItem($ul, true);
        } else {
            $toolbar->addStickyItem($ul, true);
        }

        if (count((array) $a_options['user_type'])) {
            include_once './Services/Form/classes/class.ilSelectInputGUI.php';
            $si = new ilSelectInputGUI("", "user_type");
            $si->setOptions($a_options['user_type']);
            if (!$a_sticky) {
                $toolbar->addInputItem($si);
            } else {
                $toolbar->addStickyItem($si);
            }
        }
        
        include_once "Services/UIComponent/Button/classes/class.ilSubmitButton.php";
        $button = ilSubmitButton::getInstance();
        $button->setCaption($a_options['submit_name'], false);
        $button->setCommand('addUserFromAutoComplete');
        if (!$a_sticky) {
            $toolbar->addButtonInstance($button);
        } else {
            $toolbar->addStickyItem($button);
        }

        if ((bool) $a_options['add_search'] ||
            is_numeric($a_options['add_from_container'])) {
            $lng->loadLanguageModule("search");
            
            $toolbar->addSeparator();
                    
            if ((bool) $a_options['add_search']) {
                include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                $button = ilLinkButton::getInstance();
                $button->setCaption("search_users");
                $button->setUrl($ilCtrl->getLinkTargetByClass('ilStudyProgrammeRepositorySearchGUI', ''));
                $toolbar->addButtonInstance($button);
            }

            if (is_numeric($a_options['add_from_container'])) {
                $parent_ref_id = (int) $a_options['add_from_container'];
                $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "grp");
                $parent_container_type = "grp";
                if (!$parent_container_ref_id) {
                    $parent_container_ref_id = $tree->checkForParentType($parent_ref_id, "crs");
                    $parent_container_type = "crs";
                }
                if ($parent_container_ref_id) {
                    if ((bool) $a_options['add_search']) {
                        $toolbar->addSpacer();
                    }
                    
                    $ilCtrl->setParameterByClass('ilStudyProgrammeRepositorySearchGUI', "list_obj", ilObject::_lookupObjId($parent_container_ref_id));
                    
                    include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                    $button = ilLinkButton::getInstance();
                    $button->setCaption("search_add_members_from_container_" . $parent_container_type);
                    $button->setUrl($ilCtrl->getLinkTargetByClass(array(get_class($parent_object),'ilStudyProgrammeRepositorySearchGUI'), 'listUsers'));
                    $toolbar->addButtonInstance($button);
                }
            }
        }
        
        $toolbar->setFormAction(
            $ilCtrl->getFormActionByClass(
                array(
                    get_class($parent_object),
                    'ilStudyProgrammeRepositorySearchGUI')
            )
        );
        return $toolbar;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeRepositorySearchGUI.php