ilSearchControllerGUI Class Reference

Inheritance diagram for ilSearchControllerGUI:

Collaboration diagram for ilSearchControllerGUI:

Public Member Functions
	__construct ()
	Constructor @access public. More...
	getLastClass ()
	setLastClass (string $a_class)
	setCmdClass (string $a_cmd_class)
	executeCommand ()

Data Fields
const	TYPE_USER_SEARCH = -1

Protected Attributes
ilObjUser	$user
ilCtrl	$ctrl
ILIAS	$ilias
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilRbacSystem	$system
GlobalHttpState	$http
Factory	$refinery

Detailed Description

Definition at line 35 of file class.ilSearchControllerGUI.php.

Constructor & Destructor Documentation

__construct()

ilSearchControllerGUI::__construct

(

)

Constructor @access public.

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->ilias = $DIC['ilias'];
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->system = $DIC->rbac()->system();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->user = $DIC->user();
    }

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

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilSearchControllerGUI::executeCommand

(

)

Definition at line 101 of file class.ilSearchControllerGUI.php.

                                    : void
    {
        // Check hacks
        if (!$this->system->checkAccess('search', ilSearchSettings::_getSearchSettingRefId())) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        }
        $forward_class = $this->ctrl->getNextClass($this) ? $this->ctrl->getNextClass($this) : $this->getLastClass();
        switch ($forward_class) {
            case 'illucenesearchgui':
                $this->setLastClass('illucenesearchgui');
                $this->setCmdClass(ilLuceneSearchGUI::class);
                $this->ctrl->forwardCommand(new ilLuceneSearchGUI());
                break;
 
            case 'illuceneadvancedsearchgui':
                $this->setLastClass('illuceneadvancedsearchgui');
                $this->setCmdClass(ilLuceneAdvancedSearchGUI::class);
                $this->ctrl->forwardCommand(new ilLuceneAdvancedSearchGUI());
                break;
 
            case 'illuceneusersearchgui':
                if ($this->user->getId() === ANONYMOUS_USER_ID) {
                    $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
                }
                $this->setLastClass('illuceneusersearchgui');
                $this->setCmdClass(ilLuceneUserSearchGUI::class);
                $this->ctrl->forwardCommand(new ilLuceneUserSearchGUI());
                break;
 
            case 'iladvancedsearchgui':
                // Remember last class
                $this->setLastClass('iladvancedsearchgui');
                $this->setCmdClass(ilAdvancedSearchGUI::class);
                $this->ctrl->forwardCommand(new ilAdvancedSearchGUI());
                break;
 
            case 'ilsearchgui':
                // Remember last class
                $this->setLastClass('ilsearchgui');
                // no break
            default:
                $search_gui = new ilSearchGUI();
                $this->setCmdClass(ilSearchGUI::class);
                $this->ctrl->forwardCommand($search_gui);
                break;
        }
        $this->tpl->printToStdout();
    }

References ilSearchSettings\_getSearchSettingRefId(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), getLastClass(), ILIAS\Repository\lng(), setCmdClass(), setLastClass(), and ILIAS\Repository\user().

Here is the call graph for this function:

getLastClass()

ilSearchControllerGUI::getLastClass

(

)

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

                                  : string
    {
        if (ilSearchSettings::getInstance()->enabledLucene()) {
            $default = 'illucenesearchgui';
        } else {
            $default = 'ilsearchgui';
        }
 
        $root_id = 0;
        if ($this->http->wrapper()->post()->has('root_id')) {
            $root_id = $this->http->wrapper()->post()->retrieve(
                'root_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($root_id == self::TYPE_USER_SEARCH) {
            $default = 'illuceneusersearchgui';
        }
 
        $this->setLastClass($default);
        return ilSession::get('search_last_class') ?? $default;
    }

References ilSession\get(), ilSearchSettings\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and setLastClass().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

setCmdClass()

ilSearchControllerGUI::setCmdClass

(

string

$a_cmd_class

)

Definition at line 94 of file class.ilSearchControllerGUI.php.

                                                    : void
    {
        if ($this->ctrl->getNextClass($this) === '') {
            $this->ctrl->setCmdClass($a_cmd_class);
        }
    }

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

setLastClass()

ilSearchControllerGUI::setLastClass

(

string

$a_class

)

Definition at line 89 of file class.ilSearchControllerGUI.php.

                                                 : void
    {
        ilSession::set('search_last_class', $a_class);
    }

References ilSession\set().

Referenced by executeCommand(), and getLastClass().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilSearchControllerGUI::$ctrl

protected

Definition at line 40 of file class.ilSearchControllerGUI.php.

$http

GlobalHttpState ilSearchControllerGUI::$http

protected

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

$ilias

ILIAS ilSearchControllerGUI::$ilias

protected

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

$lng

ilLanguage ilSearchControllerGUI::$lng

protected

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

$refinery

Factory ilSearchControllerGUI::$refinery

protected

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

$system

ilRbacSystem ilSearchControllerGUI::$system

protected

Definition at line 44 of file class.ilSearchControllerGUI.php.

$tpl

ilGlobalTemplateInterface ilSearchControllerGUI::$tpl

protected

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

$user

ilObjUser ilSearchControllerGUI::$user

protected

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

TYPE_USER_SEARCH

const ilSearchControllerGUI::TYPE_USER_SEARCH = -1

Definition at line 37 of file class.ilSearchControllerGUI.php.

Referenced by ilMainMenuSearchGUI\getHTML().

---

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

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