ILIAS\Search\GUI\ActionsImpl Class Reference

Inheritance diagram for ILIAS\Search\GUI\ActionsImpl:

Collaboration diagram for ILIAS\Search\GUI\ActionsImpl:

Public Member Functions
	__construct (protected ilCtrlInterface $ctrl, protected DataFactory $data_factory)
	search ()
	remoteSearch ()
	showSavedResults ()
	applyFilter ()
	switchResultPage (Sortation $sortation)
	sortResultPage ()
	autoComplete ()
	isValidCommand (string $cmd)
	search ()
	remoteSearch ()
	showSavedResults ()
	applyFilter ()
	switchResultPage (Sortation $sortation)
	sortResultPage ()
	autoComplete ()
	isValidCommand (string $cmd)

Protected Member Functions
	ctrlToURI (string $ctrl_target)

Protected Attributes
const string	SEARCH_CMD = 'search'
const string	REMOTE_SEARCH_CMD = 'remoteSearch'
const string	SHOW_SAVED_RESULTS_CMD = 'showSavedResults'
const string	APPLY_FILTER_CMD = 'applyFilter'
const string	SWITCH_RESULT_PAGE_CMD = 'switchResultPage'
const string	SORT_RESULT_PAGE_CMD = 'sortResultPage'
const string	AUTO_COMPLETE_CMD = 'autoComplete'

Detailed Description

Definition at line 29 of file ActionsImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Search\GUI\ActionsImpl::__construct	(	protected ilCtrlInterface	$ctrl,
		protected DataFactory	$data_factory
	)

Definition at line 39 of file ActionsImpl.php.

      {
    }

Member Function Documentation

applyFilter()

ILIAS\Search\GUI\ActionsImpl::applyFilter

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 72 of file ActionsImpl.php.

                                 : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::APPLY_FILTER_CMD
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

autoComplete()

ILIAS\Search\GUI\ActionsImpl::autoComplete

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 101 of file ActionsImpl.php.

                                  : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::AUTO_COMPLETE_CMD,
            null,
            true
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

ctrlToURI()

ILIAS\Search\GUI\ActionsImpl::ctrlToURI ( string  $ctrl_target )

protected

Definition at line 125 of file ActionsImpl.php.

                                                     : URI
    {
        return $this->data_factory->uri(
            rtrim(ILIAS_HTTP_PATH, '/') . '/' . $ctrl_target
        );
    }

Referenced by ILIAS\Search\GUI\ActionsImpl\applyFilter(), ILIAS\Search\GUI\ActionsImpl\autoComplete(), ILIAS\Search\GUI\ActionsImpl\remoteSearch(), ILIAS\Search\GUI\ActionsImpl\search(), ILIAS\Search\GUI\ActionsImpl\showSavedResults(), ILIAS\Search\GUI\ActionsImpl\sortResultPage(), and ILIAS\Search\GUI\ActionsImpl\switchResultPage().

Here is the caller graph for this function:

isValidCommand()

ILIAS\Search\GUI\ActionsImpl::isValidCommand

(

string

$cmd

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 112 of file ActionsImpl.php.

                                               : bool
    {
        return in_array($cmd, [
            self::SEARCH_CMD,
            self::REMOTE_SEARCH_CMD,
            self::SHOW_SAVED_RESULTS_CMD,
            self::APPLY_FILTER_CMD,
            self::SWITCH_RESULT_PAGE_CMD,
            self::SORT_RESULT_PAGE_CMD,
            self::AUTO_COMPLETE_CMD
        ]);
    }

remoteSearch()

ILIAS\Search\GUI\ActionsImpl::remoteSearch

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 54 of file ActionsImpl.php.

                                  : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::REMOTE_SEARCH_CMD
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

search()

ILIAS\Search\GUI\ActionsImpl::search

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 45 of file ActionsImpl.php.

                            : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::SEARCH_CMD
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

showSavedResults()

ILIAS\Search\GUI\ActionsImpl::showSavedResults

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 63 of file ActionsImpl.php.

                                      : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::SHOW_SAVED_RESULTS_CMD
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

sortResultPage()

ILIAS\Search\GUI\ActionsImpl::sortResultPage

(

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 92 of file ActionsImpl.php.

                                    : URI
    {
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::SORT_RESULT_PAGE_CMD
        );
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

switchResultPage()

ILIAS\Search\GUI\ActionsImpl::switchResultPage

(

Sortation

$sortation

)

Implements ILIAS\Search\GUI\Actions.

Definition at line 81 of file ActionsImpl.php.

                                                          : URI
    {
        $this->ctrl->setParameterByClass(ilSearchGUI::class, Param::SORTATION->value, $sortation->value);
        $ctrl_target = $this->ctrl->getLinkTargetByClass(
            ilSearchGUI::class,
            self::SWITCH_RESULT_PAGE_CMD
        );
        $this->ctrl->clearParameterByClass(ilSearchGUI::class, Param::SORTATION->value);
        return $this->ctrlToURI($ctrl_target);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Search\GUI\ActionsImpl\ctrlToURI().

Here is the call graph for this function:

Field Documentation

APPLY_FILTER_CMD

const string ILIAS\Search\GUI\ActionsImpl::APPLY_FILTER_CMD = 'applyFilter'

protected

Definition at line 34 of file ActionsImpl.php.

AUTO_COMPLETE_CMD

const string ILIAS\Search\GUI\ActionsImpl::AUTO_COMPLETE_CMD = 'autoComplete'

protected

Definition at line 37 of file ActionsImpl.php.

REMOTE_SEARCH_CMD

const string ILIAS\Search\GUI\ActionsImpl::REMOTE_SEARCH_CMD = 'remoteSearch'

protected

Definition at line 32 of file ActionsImpl.php.

SEARCH_CMD

const string ILIAS\Search\GUI\ActionsImpl::SEARCH_CMD = 'search'

protected

Definition at line 31 of file ActionsImpl.php.

SHOW_SAVED_RESULTS_CMD

const string ILIAS\Search\GUI\ActionsImpl::SHOW_SAVED_RESULTS_CMD = 'showSavedResults'

protected

Definition at line 33 of file ActionsImpl.php.

SORT_RESULT_PAGE_CMD

const string ILIAS\Search\GUI\ActionsImpl::SORT_RESULT_PAGE_CMD = 'sortResultPage'

protected

Definition at line 36 of file ActionsImpl.php.

SWITCH_RESULT_PAGE_CMD

const string ILIAS\Search\GUI\ActionsImpl::SWITCH_RESULT_PAGE_CMD = 'switchResultPage'

protected

Definition at line 35 of file ActionsImpl.php.

---

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

• components/ILIAS/Search/classes/GUI/ActionsImpl.php