ilCtrl Class Reference

Class ilCtrl provides processing control methods. More...

Inheritance diagram for ilCtrl:

Collaboration diagram for ilCtrl:

Public Member Functions
	__construct (protected ilCtrlStructureInterface $structure, protected ilCtrlTokenRepositoryInterface $token_repository, protected ilCtrlPathFactoryInterface $path_factory, protected ilCtrlContextInterface $context, protected ResponseSenderStrategy $response_sender, protected ServerRequestInterface $server_request, protected RequestWrapper $post_parameters, protected RequestWrapper $get_parameters, protected Refinery $refinery, protected ilComponentFactory $component_factory, protected ilCtrlSubject $subject, protected ilCtrlQueryParserInterface $query_parser,)
	__clone ()
	callBaseClass (?string $a_base_class=null)
	forwardCommand (object $a_gui_object)
	getHTML (object $a_gui_object, ?array $a_parameters=null)
	getCmd (?string $fallback_command=null)
	getCmdClass ()
	getNextClass ($a_gui_class=null)
	saveParameter (object $a_gui_obj, $a_parameter)
	saveParameterByClass (string $a_class, $a_parameter)
	setParameter (object $a_gui_obj, string $a_parameter, $a_value)
	setParameterByClass (string $a_class, string $a_parameter, $a_value)
	getParameterArray (object $a_gui_obj)
	getParameterArrayByClass (string $a_class)
	clearParameters (object $a_gui_obj)
	clearParametersByClass (string $a_class)
	clearParameterByClass (string $a_class, string $a_parameter)
	getLinkTarget (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	getLinkTargetByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	getFormAction (object $a_gui_obj, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	getFormActionByClass ( $a_class, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	redirect (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	redirectByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	redirectToURL (string $target_url)
	setContextObject (int $obj_id, string $obj_type)
	getContextObjId ()
	getContextObjType ()
	getCallHistory ()
	lookupClassPath (string $a_class)
	lookupOriginalClassName (string $a_class)
	getClassForClasspath (string $a_class_path)
	setTargetScript (string $a_target_script)
	isAsynch ()
	setReturn (object $a_gui_obj, ?string $a_cmd=null)
	setReturnByClass (string $a_class, ?string $a_cmd=null)
	returnToParent (object $a_gui_obj, ?string $a_anchor=null)
	getParentReturn (object $a_gui_obj)
	getParentReturnByClass (string $a_class)
	getRedirectSource ()
	insertCtrlCalls ($a_parent, $a_child, string $a_comp_prefix)
	checkCurrentPathForClass (string $gui_class)
	getCurrentClassPath ()
	attachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	detachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)

Protected Member Functions
	getDeterminedCommand ()

Protected Attributes
object	$exec_object = null
string	$command = null
array	$stacktrace = []

Private Member Functions
	getQueryParam (string $parameter_name)
	Returns a parameter with the given name from the current GET request. More...
	getTableCommand ()
	getPostCommand ()
	Returns the current $_POST command. More...
	getTargetUrl ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $is_escaped=false, bool $is_post=false)
	Helper function that returns a target URL string. More...
	isCmdSecure (bool $is_post, string $cmd_class, ?string $cmd=null)
	Returns whether a given command is considered safe or not. More...
	appendParameterStringsByClass (string $class_name, string $target_url, bool $is_escaped=false)
	Appends all parameters for a given class to the given URL. More...
	populateCall (string $class_name, string $cmd_mode)
	Helper function that populates a call in the current stacktrace. More...
	getClassByObject ($object)
	Helper function that returns the class name of a mixed (object or string) parameter. More...

Additional Inherited Members
Data Fields inherited from ilCtrlInterface
const	CMD_POST = 'post'
const	PARAM_CSRF_TOKEN = 'rtoken'
	$_GET request parameter names, used throughout ilCtrl. More...
const	PARAM_CID_PATH = 'cmdNode'
const	PARAM_REDIRECT = 'redirectSource'
const	PARAM_BASE_CLASS = 'baseClass'
const	PARAM_CMD_CLASS = 'cmdClass'
const	PARAM_CMD_MODE = 'cmdMode'
const	PARAM_CMD_FALLBACK = 'fallbackCmd'
const	PARAM_CMD = 'cmd'
const	PROTECTED_PARAMETERS
const	CMD_MODE_PROCESS = 'execComm'
	different modes used for UI plugins (or in dev-mode). More...
const	CMD_MODE_ASYNC = 'asynch'
const	CMD_MODE_HTML = 'getHtml'

Detailed Description

Class ilCtrl provides processing control methods.

A global instance is available through $DIC->ctrl() or $ilCtrl.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r.rai.nosp@m.mann.nosp@m..ch AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

__construct()

ilCtrl::__construct	(	protected ilCtrlStructureInterface	$structure,
		protected ilCtrlTokenRepositoryInterface	$token_repository,
		protected ilCtrlPathFactoryInterface	$path_factory,
		protected ilCtrlContextInterface	$context,
		protected ResponseSenderStrategy	$response_sender,
		protected ServerRequestInterface	$server_request,
		protected RequestWrapper	$post_parameters,
		protected RequestWrapper	$get_parameters,
		protected Refinery	$refinery,
		protected ilComponentFactory	$component_factory,
		protected ilCtrlSubject	$subject,
		protected ilCtrlQueryParserInterface	$query_parser
	)

Definition at line 47 of file class.ilCtrl.php.

      {
    }

Member Function Documentation

__clone()

ilCtrl::__clone

(

)

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

References $structure.

    {
        $this->structure = clone $this->structure;
    }

appendParameterStringsByClass()

ilCtrl::appendParameterStringsByClass ( string  $class_name, string  $target_url, bool  $is_escaped = false  )

private

Appends all parameters for a given class to the given URL.

Parameters

string	$class_name
string	$target_url
bool	$is_escaped

Returns

string

Exceptions

ilCtrlException

Definition at line 1049 of file class.ilCtrl.php.

References $url, getParameterArrayByClass(), and ILIAS\Repository\refinery().

Referenced by getTargetUrl().

     : string {
        $class_parameters = $this->getParameterArrayByClass($class_name);
        if (!empty($class_parameters)) {
            foreach ($class_parameters as $key => $value) {
                $target_url = $this->appendParameterString(
                    $target_url,
                    $key,
                    $value,
                    $is_escaped
                );
            }
        }

        return $target_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

attachObserver()

ilCtrl::attachObserver	(	ilCtrlObserver	$observer,
		ilCtrlEvent	$event = ilCtrlEvent::ALL
	)

Implements ilCtrlInterface.

Definition at line 700 of file class.ilCtrl.php.

                                                                                                 : void
    {
        $this->subject->attach($observer, $event);
    }

callBaseClass()

ilCtrl::callBaseClass

(

?string

$a_base_class = null

)

Implements ilCtrlInterface.

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

References forwardCommand(), and null.

                                                               : void
    {
        // prioritise the context's baseclass over the given one.
        $a_base_class = $this->context->getBaseClass() ?? $a_base_class;

        // abort if no baseclass was provided.
        if (null === $a_base_class) {
            throw new ilCtrlException(__METHOD__ . " was not given a baseclass and the request doesn't include one either.");
        }

        // abort if the provided baseclass is unknown.
        if (!$this->structure->isBaseClass($a_base_class)) {
            throw new ilCtrlException("Provided class '$a_base_class' is not a baseclass");
        }

        // in case the baseclass was given by argument,
        // set the context's baseclass.
        $this->context->setBaseClass($a_base_class);

        // no null-check needed as previous isBaseClass() was true.
        $obj_name = $this->structure->getObjNameByName($a_base_class);
        $this->forwardCommand(new $obj_name());
    }

Here is the call graph for this function:

checkCurrentPathForClass()

ilCtrl::checkCurrentPathForClass

(

string

$gui_class

)

Implements ilCtrlInterface.

Definition at line 667 of file class.ilCtrl.php.

References null.

                                                               : bool
    {
        $class_cid = $this->structure->getClassCidByName($gui_class);
        if (null === $class_cid) {
            return false;
        }

        return strpos(
            $this->context->getPath()->getCidPath() ?? '',
            $class_cid
        ) !== false;
    }

clearParameterByClass()

ilCtrl::clearParameterByClass	(	string	$a_class,
		string	$a_parameter
	)

Implements ilCtrlInterface.

Definition at line 308 of file class.ilCtrl.php.

Referenced by ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), and ILIAS\Test\StaticURLHandler\buildQuestionURL().

                                                                               : void
    {
        $this->structure->removeSingleParameterByClass($a_class, $a_parameter);
    }

Here is the caller graph for this function:

clearParameters()

ilCtrl::clearParameters

(

object

$a_gui_obj

)

Implements ilCtrlInterface.

Definition at line 289 of file class.ilCtrl.php.

References clearParametersByClass(), and getClassByObject().

                                                      : void
    {
        $this->clearParametersByClass($this->getClassByObject($a_gui_obj));
    }

Here is the call graph for this function:

clearParametersByClass()

ilCtrl::clearParametersByClass

(

string

$a_class

)

Implements ilCtrlInterface.

Definition at line 297 of file class.ilCtrl.php.

Referenced by ilObjExerciseGUI\addContentSubTabs(), clearParameters(), and ilExAssignmentInfo\getInstructionFileInfo().

                                                           : void
    {
        // apparently permanent parameters should not be removable,
        // therefore the line below stays commented:
        // $this->structure->removePermanentParametersByClass($a_class);
        $this->structure->removeTemporaryParametersByClass($a_class);
    }

Here is the caller graph for this function:

detachObserver()

ilCtrl::detachObserver	(	ilCtrlObserver	$observer,
		ilCtrlEvent	$event = ilCtrlEvent::ALL
	)

Implements ilCtrlInterface.

Definition at line 708 of file class.ilCtrl.php.

                                                                                                 : void
    {
        $this->subject->detach($observer, $event);
    }

forwardCommand()

ilCtrl::forwardCommand

(

object

$a_gui_object

)

Implements ilCtrlInterface.

Definition at line 98 of file class.ilCtrl.php.

References populateCall().

Referenced by callBaseClass(), ilGroupUserActionsGUI\executeCommand(), ilAchievementsGUI\executeCommand(), ilPortfolioRoleAssignmentGUI\executeCommand(), ilContainerSkillGUI\executeCommand(), ilObjLearningHistorySettingsGUI\executeCommand(), ilContSkillPresentationGUI\executeCommand(), ilObjCommentsSettingsGUI\executeCommand(), McstPodcastGUI\executeCommand(), ilObjNotesSettingsGUI\executeCommand(), ilObjPersonalWorkspaceSettingsGUI\executeCommand(), ilSkillTreeAdminGUI\executeCommand(), ilObjStyleSheetGUI\executeCommand(), ilNewsTimelineGUI\executeCommand(), ilBookingGatewayGUI\executeCommand(), and ilMediaCreationGUI\executeCommand().

    {
        $class_name = get_class($a_gui_object);

        // @TODO: remove this check once an interface for command classes exists.
        if (!method_exists($a_gui_object, 'executeCommand')) {
            throw new ilCtrlException("$class_name doesn't implement executeCommand().");
        }

        $this->exec_object = $a_gui_object;
        $this->populateCall($class_name, self::CMD_MODE_PROCESS);

        // with forward command we cannot progress, or set
        // the current command class. Otherwise, the path-
        // finding gets mixed up, as it can only be used in
        // getHTML() method calls.
        $this->context
            ->setCmdMode(self::CMD_MODE_PROCESS);

        $this->subject->notify(ilCtrlEvent::COMMAND_CLASS_FORWARD, $class_name);

        return $a_gui_object->executeCommand();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCallHistory()

ilCtrl::getCallHistory

(

)

Implements ilCtrlInterface.

Definition at line 524 of file class.ilCtrl.php.

References $stacktrace.

                                    : array
    {
        return $this->stacktrace;
    }

getClassByObject()

ilCtrl::getClassByObject (   $object )

private

Helper function that returns the class name of a mixed (object or string) parameter.

Parameters

object | string

$object

Returns

string

Definition at line 1134 of file class.ilCtrl.php.

Referenced by clearParameters(), getFormAction(), getLinkTarget(), getNextClass(), getParameterArray(), getParentReturn(), redirect(), returnToParent(), saveParameter(), setParameter(), and setReturn().

                                              : string
    {
        return (is_object($object)) ? get_class($object) : $object;
    }

Here is the caller graph for this function:

getClassForClasspath()

ilCtrl::getClassForClasspath

(

string

$a_class_path

)

Implements ilCtrlInterface.

Definition at line 553 of file class.ilCtrl.php.

                                                              : string
    {
        $path_info = pathinfo($a_class_path);

        return substr($path_info['basename'], 6, -4);
    }

getCmd()

ilCtrl::getCmd

(

?string

$fallback_command = null

)

Implements ilCtrlInterface.

Definition at line 158 of file class.ilCtrl.php.

References $command, getDeterminedCommand(), and null.

Referenced by ilGroupUserActionsGUI\executeCommand(), ilAchievementsGUI\executeCommand(), ilSurveySkillDeterminationGUI\executeCommand(), ilObjNotificationSettingsGUI\executeCommand(), ilMediaPoolImportGUI\executeCommand(), ilPageEditorServerAdapterGUI\executeCommand(), ilIIMEditorServerAdapterGUI\executeCommand(), ilLMImportGUI\executeCommand(), ilPortfolioRoleAssignmentGUI\executeCommand(), ilExcRandomAssignmentGUI\executeCommand(), ilAccordionPropertiesStorageGUI\executeCommand(), ilSurveySkillGUI\executeCommand(), ilContainerBlockPropertiesStorageGUI\executeCommand(), ilSurveySkillThresholdsGUI\executeCommand(), ilExAssTypeWikiTeamGUI\executeCommand(), ilContainerFilterAdminGUI\executeCommand(), ilTablePropertiesStorageGUI\executeCommand(), ilObjLearningHistorySettingsGUI\executeCommand(), ilRecommendedContentRoleConfigGUI\executeCommand(), ilBookingPreferencesGUI\executeCommand(), ilSurveyConstraintsGUI\executeCommand(), McstPodcastGUI\executeCommand(), ilObjCommentsSettingsGUI\executeCommand(), ilDerivedTasksGUI\executeCommand(), ilObjNotesSettingsGUI\executeCommand(), ilObjPersonalWorkspaceSettingsGUI\executeCommand(), ilPCQuestionGUI\executeCommand(), ilAssignmentPresentationGUI\executeCommand(), ilTaggingSlateContentGUI\executeCommand(), ilClassificationBlockGUI\executeCommand(), ilLearningHistoryGUI\executeCommand(), ilSkillTreeAdminGUI\executeCommand(), ilPDTasksBlockGUI\executeCommand(), ilTaxonomySettingsGUI\executeCommand(), ilGroupAddToGroupActionGUI\executeCommand(), ilBookingProcessWithoutScheduleGUI\executeCommand(), ilBookingProcessWithScheduleGUI\executeCommand(), ilBookingReservationsGUI\executeCommand(), ilObjStyleSheetGUI\executeCommand(), ilBookingGatewayGUI\executeCommand(), ilMediaCreationGUI\executeCommand(), and ilContainerGUI\forwardToPageObject().

                                                            : ?string
    {
        $command = $this->getDeterminedCommand() ?? $fallback_command;
        if (null !== $this->command && $command === $this->command) {
            // don't broadcast command determination event on consecutive
            // method calls.
            return $command;
        }

        $this->subject->notify(ilCtrlEvent::COMMAND_DETERMINATION, $command);
        $this->command = $command;

        return $command ?? ''; // remove null-coalesce
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCmdClass()

ilCtrl::getCmdClass

(

)

Implements ilCtrlInterface.

Definition at line 176 of file class.ilCtrl.php.

References null.

                                 : ?string
    {
        if (null !== ($cmd_class = $this->context->getCmdClass())) {
            return strtolower($this->structure->getObjNameByName($cmd_class));
        }

        return '';
    }

getContextObjId()

ilCtrl::getContextObjId

(

)

Implements ilCtrlInterface.

Definition at line 508 of file class.ilCtrl.php.

                                     : ?int
    {
        return $this->context->getObjId();
    }

getContextObjType()

ilCtrl::getContextObjType

(

)

Implements ilCtrlInterface.

Definition at line 516 of file class.ilCtrl.php.

                                       : ?string
    {
        return $this->context->getObjType();
    }

getCurrentClassPath()

ilCtrl::getCurrentClassPath

(

)

Implements ilCtrlInterface.

Definition at line 683 of file class.ilCtrl.php.

References null.

Referenced by ilObjGlossaryGUI\showTaxonomy(), and ilObjTaxonomyGUI\showTree().

                                         : array
    {
        if (null === $this->context->getPath()->getCidPath()) {
            return [];
        }

        $class_paths = [];
        foreach ($this->context->getPath()->getCidArray(SORT_ASC) as $cid) {
            $class_paths[] = $this->structure->getObjNameByCid($cid);
        }

        return $class_paths;
    }

Here is the caller graph for this function:

getDeterminedCommand()

ilCtrl::getDeterminedCommand ( )

protected

Definition at line 713 of file class.ilCtrl.php.

References $command, getPostCommand(), getQueryParam(), getTableCommand(), isCmdSecure(), and null.

Referenced by getCmd(), and populateCall().

                                             : ?string
    {
        // retrieve $_GET and $_POST parameters.
        $post_command = $this->getPostCommand();
        $get_command = $this->getQueryParam(self::PARAM_CMD);
        $table_command = $this->getTableCommand();

        $is_post = (self::CMD_POST === $get_command);

        // if the $_GET command is 'post', either the $_POST
        // command or $_GETs fallback command is used.
        // for now, the table command is used as fallback as well,
        // but this will be removed once the implementation of
        // table actions change.
        $command = ($is_post) ?
            $post_command ?? $table_command ?? $this->getQueryParam(self::PARAM_CMD_FALLBACK) :
            $get_command;

        // override the command that has been set during a
        // request via ilCtrl::setCmd().
        $context_command = $this->context->getCmd();
        if (null !== $context_command && self::CMD_POST !== $context_command) {
            $command = $context_command;
        }

        if (null === $command) {
            return $command;
        }

        // if the command is for post requests, or the command
        // is not considered safe, the csrf-validation must pass.
        $cmd_class = $this->context->getCmdClass();
        if (null !== $cmd_class && !$this->isCmdSecure($is_post, $cmd_class, $command)) {
            $stored_token = $this->token_repository->getToken();
            $sent_token = $this->getQueryParam(self::PARAM_CSRF_TOKEN);

            if (null !== $sent_token && $stored_token->verifyWith($sent_token)) {
                return $command;
            }
        }

        return $command;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFormAction()

ilCtrl::getFormAction	(	object	$a_gui_obj,
		?string	$a_fallback_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false,
		bool	$has_xml_style = false
	)

Implements ilCtrlInterface.

Definition at line 354 of file class.ilCtrl.php.

References getClassByObject(), and getFormActionByClass().

Referenced by ilBookingBulkCreationTableGUI\__construct(), ilExAssignmentTeamLogTableGUI\__construct(), ilParticipantsPerAssignmentTableGUI\__construct(), ilFeedbackConfirmationTable2GUI\__construct(), ILIAS\Style\Content\CharacteristicTableGUI\__construct(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilContSkillAdminGUI\confirmDeleteSelectedLocalProfiles(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilObjStyleSheetGUI\deleteObject(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilExSubmissionTeamGUI\getAdoptForm(), ilObjStyleSheetGUI\getCloneForm(), ilObjStyleSheetGUI\getCreateForm(), ilSurveyEvaluationGUI\getExportModal(), ilObjStyleSheetGUI\getImportForm(), ilPCAMDFormGUI\getPortfolioForm(), ilPortfolioRoleAssignmentGUI\initAssignmentForm(), ilObjNotificationSettingsGUI\initForm(), ilMediaCreationGUI\initPoolSelection(), ilObjStyleSheetGUI\initPropertiesForm(), ilBookingGatewayGUI\initSettingsForm(), ilContSkillAdminGUI\initSettingsForm(), ilMediaCreationGUI\initUrlForm(), and ilContSkillAdminGUI\listProfiles().

     : string {
        return $this->getFormActionByClass(
            $this->getClassByObject($a_gui_obj),
            $a_fallback_cmd,
            $a_anchor,
            $is_async,
            $has_xml_style
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFormActionByClass()

ilCtrl::getFormActionByClass	(		$a_class,
		?string	$a_fallback_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false,
		bool	$has_xml_style = false
	)

Implements ilCtrlInterface.

Definition at line 373 of file class.ilCtrl.php.

References getTargetUrl().

Referenced by ilPortfolioTemplatePageGUI\getCourseSortAction(), ilPortfolioPageGUI\getCourseSortAction(), and getFormAction().

     : string {
        return $this->getTargetUrl(
            $a_class,
            $a_fallback_cmd,
            $a_anchor,
            $is_async,
            $has_xml_style,
            true
        ) ?? '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilCtrl::getHTML	(	object	$a_gui_object,
		?array	$a_parameters = null
	)

Implements ilCtrlInterface.

Definition at line 125 of file class.ilCtrl.php.

References $context, $exec_object, $structure, null, and populateCall().

                                                                              : string
    {
        $class_name = get_class($a_gui_object);

        // @TODO: remove this check once an interface for command classes exists.
        if (!method_exists($a_gui_object, 'getHTML')) {
            throw new ilCtrlException("$class_name doesn't implement getHTML().");
        }

        $isolatad_structure = $this->structure;
        $isolated_context = $this->context;
        $isolated_object = $this->exec_object;

        $this->exec_object = $a_gui_object;
        $this->populateCall($class_name, self::CMD_MODE_HTML);
        $this->context
            ->setCmdClass($class_name)
            ->setCmdMode(self::CMD_MODE_HTML);

        $html = (null !== $a_parameters) ?
            $a_gui_object->getHTML($a_parameters) :
            $a_gui_object->getHTML();

        $this->structure = $isolatad_structure;
        $this->context = $isolated_context;
        $this->exec_object = $isolated_object;

        return $html;
    }

Here is the call graph for this function:

getLinkTarget()

ilCtrl::getLinkTarget	(	object	$a_gui_obj,
		?string	$a_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false,
		bool	$has_xml_style = false
	)

Implements ilCtrlInterface.

Definition at line 316 of file class.ilCtrl.php.

References getClassByObject(), and getLinkTargetByClass().

Referenced by ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjExerciseGUI\addContentSubTabs(), ilTaxMDGUI\addSubTab(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilLMPageObjectGUI\create(), ilContainerFilterAdminGUI\executeCommand(), ilContSkillMemberTableGUI\fillRow(), ilCopySelfAssQuestionTableGUI\fillRow(), ilContProfileTableGUI\fillRow(), ilObjLearningHistorySettingsGUI\getAdminTabs(), ilObjCommentsSettingsGUI\getAdminTabs(), ilObjNotesSettingsGUI\getAdminTabs(), ilObjPersonalWorkspaceSettingsGUI\getAdminTabs(), ilContainerFilterAdminGUI\getFieldSelectionForm(), ilNoteGUI\getGlyph(), ilLikeGUI\getHTML(), ilNoteGUI\getNumber(), ilObjPortfolioGUI\getOfflineMessage(), ilPortfolioRepositoryGUI\getPortfolioList(), ilObjContentObjectGUI\getPublicAccessColValue(), ilPCAMDFormGUI\getTemplateForm(), ilNoteGUI\getTriggerShyButton(), ilNoteGUI\getWidget(), ilObjPortfolioAdministrationGUI\initAuthorshipForm(), ilObjLearningHistorySettingsGUI\initForm(), ilObjCommentsSettingsGUI\initForm(), ilObjNotesSettingsGUI\initForm(), ilObjBookingPoolGUI\initHeaderAction(), ilLMPageObjectGUI\initNewPageForm(), ilBookingPreferencesGUI\initPreferenceForm(), ilObjSkillTreeGUI\initTreeForm(), ilContSkillAdminGUI\listCompetences(), ilRecommendedContentRoleConfigGUI\listItems(), ilMediaCreationGUI\listPoolItems(), ilTaggingClassificationProvider\render(), ilLearningHistoryGUI\renderButton(), ilContainerRenderer\renderHelperGeneric(), ilTaggingSlateContentGUI\renderResourcesForTag(), ilObjDashboardSettingsGUI\setSettingsSubTabs(), ilBookingGatewayGUI\setSubTabs(), ilPDNotesGUI\setToolbar(), ilGroupAddToGroupActionGUI\show(), ilSkillRootGUI\showImportForm(), and ilSkillProfileGUI\showLevelsWithLocalContext().

     : string {
        return $this->getLinkTargetByClass(
            $this->getClassByObject($a_gui_obj),
            $a_cmd,
            $a_anchor,
            $is_async,
            $has_xml_style
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkTargetByClass()

ilCtrl::getLinkTargetByClass	(		$a_class,
		?string	$a_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false,
		bool	$has_xml_style = false
	)

Implements ilCtrlInterface.

Definition at line 335 of file class.ilCtrl.php.

References getTargetUrl().

Referenced by ilBlockGUI\addRepoCommands(), ilContainerSkillGUI\addTabs(), ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), ILIAS\Test\StaticURLHandler\buildQuestionURL(), ilExAssTypeUploadGUI\buildSubmissionPropertiesAndActions(), ilExAssTypeWikiTeamGUI\buildSubmissionPropertiesAndActions(), ilSkillProfileGUI\createLocal(), ilContProfileTableGUI\fillRow(), ilBookingParticipantsTableGUI\fillRow(), ilKSDocumentationGotoLink\generateRedirectURL(), ilContainerPageGUI\getAdditionalPageActions(), ilObjLearningHistorySettingsGUI\getAdminTabs(), ilObjCommentsSettingsGUI\getAdminTabs(), ilObjNotesSettingsGUI\getAdminTabs(), ilObjPersonalWorkspaceSettingsGUI\getAdminTabs(), ilNoteGUI\getButton(), ilAccessibilitySupportContactsGUI\getFooterLink(), ilSurveyContainsDataMessageBoxGUI\getHTML(), McstPodcastGUI\getHTML(), ilExAssignmentInfo\getInstructionFileInfo(), ilAchievementsGUI\getLinks(), getLinkTarget(), ilPortfolioRepositoryGUI\getPortfolioList(), ilNoteGUI\getShyButton(), ilPageObjectGUI\getTinyMenu(), ilPortfolioTemplatePageGUI\getViewPageLink(), ilPortfolioPageGUI\getViewPageLink(), ilHelpGUI\initHelp(), ilBookingPreferencesGUI\listBookingResults(), ilContSkillAdminGUI\listProfiles(), ilSkillTreeAdminGUI\listTrees(), redirectByClass(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), setReturnByClass(), ilBookingGatewayGUI\setSubTabs(), ilPDNotesGUI\setToolbar(), and ilSkillProfileGUI\showLevelsWithLocalContext().

     : string {
        return $this->getTargetUrl(
            $a_class,
            $a_cmd,
            $a_anchor,
            $is_async,
            $has_xml_style
        ) ?? '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNextClass()

ilCtrl::getNextClass

(

$a_gui_class = null

)

Implements ilCtrlInterface.

Definition at line 188 of file class.ilCtrl.php.

References getClassByObject(), and null.

Referenced by ilGroupUserActionsGUI\executeCommand(), ilAchievementsGUI\executeCommand(), ilObjNotificationSettingsGUI\executeCommand(), ilPageEditorServerAdapterGUI\executeCommand(), ilIIMEditorServerAdapterGUI\executeCommand(), ilExSubmissionTextGUI\executeCommand(), ilObjPluginDispatchGUI\executeCommand(), ilPortfolioRoleAssignmentGUI\executeCommand(), ilExcCriteriaGUI\executeCommand(), ilExcRandomAssignmentGUI\executeCommand(), ilExAssTypeWikiTeamGUI\executeCommand(), ilFormPropertyDispatchGUI\executeCommand(), ilContainerFilterAdminGUI\executeCommand(), ilPageMultiLangGUI\executeCommand(), ilObjLearningHistorySettingsGUI\executeCommand(), ilWikiStatGUI\executeCommand(), ilBookingScheduleGUI\executeCommand(), ilRecommendedContentRoleConfigGUI\executeCommand(), ilBookingPreferencesGUI\executeCommand(), McstImageGalleryGUI\executeCommand(), ilBookingParticipantGUI\executeCommand(), ilObjCommentsSettingsGUI\executeCommand(), ilSurveyRaterGUI\executeCommand(), McstPodcastGUI\executeCommand(), ilObjNotesSettingsGUI\executeCommand(), ilDerivedTasksGUI\executeCommand(), ilObjPersonalWorkspaceSettingsGUI\executeCommand(), ilImageMapEditorGUI\executeCommand(), ilAssignmentPresentationGUI\executeCommand(), ilTaggingGUI\executeCommand(), ilRatingGUI\executeCommand(), ilTaggingSlateContentGUI\executeCommand(), ilRepositoryObjectSearchBlockGUI\executeCommand(), ilWikiImportantPagesBlockGUI\executeCommand(), ilRatingCategoryGUI\executeCommand(), ilLearningHistoryGUI\executeCommand(), ilSkillTreeAdminGUI\executeCommand(), ilExSubmissionTeamGUI\executeCommand(), ilWikiFunctionsBlockGUI\executeCommand(), ilTaxonomySettingsGUI\executeCommand(), ilObjSCORM2004LearningModuleGUI\executeCommand(), ilLikeGUI\executeCommand(), ilPropertyFormGUI\executeCommand(), ilExSubmissionGUI\executeCommand(), ilGroupAddToGroupActionGUI\executeCommand(), ilBookingProcessWithoutScheduleGUI\executeCommand(), ilBookingProcessWithScheduleGUI\executeCommand(), ilBookingReservationsGUI\executeCommand(), ilObjStyleSheetGUI\executeCommand(), ilPDNewsBlockGUI\executeCommand(), ilBadgeManagementGUI\executeCommand(), ilBookingGatewayGUI\executeCommand(), ilMediaCreationGUI\executeCommand(), ilNewsForContextBlockGUI\executeCommand(), ilBookingObjectGUI\getPoolOverallLimit(), and ilTable2GUI\getSelectedColumns().

                                                     : ?string
    {
        if (null === $a_gui_class && null === $this->exec_object) {
            return '';
        }

        if (null === $this->context->getPath()) {
            return '';
        }

        $next_cid = $this->context->getPath()->getNextCid(
            $this->getClassByObject($a_gui_class ?? $this->exec_object)
        );

        if (null !== $next_cid) {
            return strtolower($this->structure->getObjNameByCid($next_cid) ?? '');
        }

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParameterArray()

ilCtrl::getParameterArray

(

object

$a_gui_obj

)

Implements ilCtrlInterface.

Definition at line 252 of file class.ilCtrl.php.

References getClassByObject(), and getParameterArrayByClass().

                                                        : array
    {
        return $this->getParameterArrayByClass($this->getClassByObject($a_gui_obj));
    }

Here is the call graph for this function:

getParameterArrayByClass()

ilCtrl::getParameterArrayByClass

(

string

$a_class

)

Implements ilCtrlInterface.

Definition at line 260 of file class.ilCtrl.php.

References getQueryParam(), and null.

Referenced by appendParameterStringsByClass(), and getParameterArray().

                                                             : array
    {
        if (null === $this->structure->getClassCidByName($a_class)) {
            throw new ilCtrlException("Cannot find provided class '$a_class' in the control structure.");
        }

        $parameters = [];
        $permanent_parameters = $this->structure->getPermanentParametersByClass($a_class);
        if (null !== $permanent_parameters) {
            foreach ($permanent_parameters as $parameter) {
                $parameters[$parameter] = $this->getQueryParam($parameter);
            }
        }

        $temporary_parameters = $this->structure->getTemporaryParametersByClass($a_class);
        if (null !== $temporary_parameters) {
            // override existing ones, as temporary parameters
            // are prioritised over fetched ones.
            foreach ($temporary_parameters as $key => $value) {
                $parameters[$key] = $value;
            }
        }

        return $parameters;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentReturn()

ilCtrl::getParentReturn

(

object

$a_gui_obj

)

Implements ilCtrlInterface.

Definition at line 624 of file class.ilCtrl.php.

References getClassByObject(), and getParentReturnByClass().

Referenced by ilPageContentGUI\getParentReturn().

                                                      : ?string
    {
        return $this->getParentReturnByClass($this->getClassByObject($a_gui_obj));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentReturnByClass()

ilCtrl::getParentReturnByClass

(

string

$a_class

)

Implements ilCtrlInterface.

Definition at line 632 of file class.ilCtrl.php.

References $path, and null.

Referenced by getParentReturn(), and returnToParent().

                                                           : ?string
    {
        $path = $this->path_factory->find($this->context, $a_class);
        if (null !== $path->getCidPath()) {
            foreach ($path->getCidArray() as $cid) {
                $current_class = $this->structure->getClassNameByCid($cid);
                $return_target = $this->structure->getReturnTargetByClass($current_class);
                if (null !== $return_target) {
                    return $return_target;
                }
            }
        }

        return null;
    }

Here is the caller graph for this function:

getPostCommand()

ilCtrl::getPostCommand ( )

private

Returns the current $_POST command.

Returns

string|null

Definition at line 808 of file class.ilCtrl.php.

References null, and ILIAS\Repository\refinery().

Referenced by getDeterminedCommand().

                                     : ?string
    {
        if ($this->post_parameters->has(self::PARAM_CMD)) {
            return $this->post_parameters->retrieve(
                self::PARAM_CMD,
                $this->refinery->custom()->transformation(
                    static function ($value): ?string {
                        if (!empty($value)) {
                            if (is_array($value)) {
                                // this most likely only works by accident, but
                                // the selected or clicked command button will
                                // always be sent as first array entry. This
                                // should definitely be done differently.
                                return (string) array_key_first($value);
                            }

                            return (string) $value;
                        }

                        return null;
                    }
                )
            );
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQueryParam()

ilCtrl::getQueryParam ( string  $parameter_name )

private

Returns a parameter with the given name from the current GET request.

Parameters

string

$parameter_name

Returns

string|null

Definition at line 763 of file class.ilCtrl.php.

References null, and ILIAS\Repository\refinery().

Referenced by getDeterminedCommand(), and getParameterArrayByClass().

                                                          : ?string
    {
        if ($this->get_parameters->has($parameter_name)) {
            return $this->get_parameters->retrieve(
                $parameter_name,
                $this->refinery->to()->string()
            );
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectSource()

ilCtrl::getRedirectSource

(

)

Implements ilCtrlInterface.

Definition at line 651 of file class.ilCtrl.php.

                                       : ?string
    {
        return $this->context->getRedirectSource();
    }

getTableCommand()

ilCtrl::getTableCommand ( )

private

Deprecated:

Definition at line 778 of file class.ilCtrl.php.

References null, and ILIAS\Repository\refinery().

Referenced by getDeterminedCommand().

                                      : ?string
    {
        if ($this->post_parameters->has('table_top_cmd')) {
            return $this->post_parameters->retrieve(
                'table_top_cmd',
                $this->refinery->custom()->transformation(function ($item): ?string {
                    return is_array($item) ? key($item) : null;
                })
            );
        }
        // Button on top of the table
        if ($this->post_parameters->has('select_cmd2')) {
            return $this->post_parameters->has('selected_cmd2')
                ? $this->post_parameters->retrieve('selected_cmd2', $this->refinery->to()->string())
                : null;
        }
        // Button at bottom of the table
        if ($this->post_parameters->has('select_cmd')) {
            return $this->post_parameters->has('selected_cmd')
                ? $this->post_parameters->retrieve('selected_cmd', $this->refinery->to()->string())
                : null;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTargetUrl()

ilCtrl::getTargetUrl (   $a_class, ?string  $a_cmd = null, ?string  $a_anchor = null, bool  $is_async = false, bool  $is_escaped = false, bool  $is_post = false  )

private

Helper function that returns a target URL string.

(that function is horrific, I'm sorry little one)

Parameters

array | string	$a_class
string | null	$a_cmd
string | null	$a_anchor
bool	$is_async
bool	$is_escaped
bool	$is_post

Returns

string|null

Exceptions

ilCtrlException

Definition at line 848 of file class.ilCtrl.php.

References $path, $token, appendParameterStringsByClass(), isCmdSecure(), ilUIHookPluginGUI\KEEP, and null.

Referenced by getFormActionByClass(), and getLinkTargetByClass().

     : ?string {
        if (empty($a_class)) {
            throw new ilCtrlException(__METHOD__ . " was provided with an empty class or class-array.");
        }

        $is_array = is_array($a_class);

        $path = $this->path_factory->find($this->context, $a_class);
        if (null !== ($exception = $path->getException())) {
            throw $exception;
        }

        $base_class = $path->getBaseClass();
        if (null === $base_class) {
            throw new ilCtrlException("Cannot find a valid baseclass in the cid path '{$path->getCidPath()}'");
        }

        $target_url = $this->context->getTargetScript();
        $target_url = $this->appendParameterString(
            $target_url,
            self::PARAM_BASE_CLASS,
            urlencode($base_class), // encode in case of namespaced classes
            $is_escaped
        );

        $cmd_class = ($is_array) ?
            $a_class[array_key_last($a_class)] :
            $a_class;

        // only append the cid path and command class params
        // if they exist.
        if (null !== $path->getNextCid($base_class)) {
            $target_url = $this->appendParameterString(
                $target_url,
                self::PARAM_CID_PATH,
                $path->getCidPath(),
                $is_escaped
            );

            $target_url = $this->appendParameterString(
                $target_url,
                self::PARAM_CMD_CLASS,
                urlencode($cmd_class), // encode in case of namespaced classes
                $is_escaped
            );
        }

        // if the target url is generated for form actions,
        // the command must be set to 'post'.
        if ($is_post) {
            $target_url = $this->appendParameterString(
                $target_url,
                self::PARAM_CMD,
                self::CMD_POST,
                $is_escaped
            );
        }

        // the actual command is appended as fallback command
        // for form actions and 'normal' get requests.
        if (!empty($a_cmd)) {
            $target_url = $this->appendParameterString(
                $target_url,
                ($is_post) ? self::PARAM_CMD_FALLBACK : self::PARAM_CMD,
                $a_cmd,
                $is_escaped
            );
        }

        // collect all parameters of classes within the current
        // targets path and append them to the target url.
        foreach ($path->getCidArray(SORT_ASC) as $cid) {
            $class_name = $this->structure->getClassNameByCid($cid);
            if (null === $class_name) {
                throw new ilCtrlException("Classname for cid '$cid' in current path cannot be found.");
            }

            $target_url = $this->appendParameterStringsByClass(
                $class_name,
                $target_url,
                $is_escaped
            );
        }

        // append a csrf token if the command is considered
        // unsafe or the link is for form actions.
        if (!$this->isCmdSecure($is_post, $cmd_class, $a_cmd)) {
            $token = $this->token_repository->getToken();
            $target_url = $this->appendParameterString(
                $target_url,
                self::PARAM_CSRF_TOKEN,
                $token->getToken(),
                $is_escaped
            );
        }

        if ($is_async) {
            $target_url = $this->appendParameterString(
                $target_url,
                self::PARAM_CMD_MODE,
                self::CMD_MODE_ASYNC,
                $is_escaped
            );
        }

        if (!empty($a_anchor)) {
            $target_url .= "#$a_anchor";
        }

        return $target_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCtrlCalls()

ilCtrl::insertCtrlCalls	(		$a_parent,
			$a_child,
		string	$a_comp_prefix
	)

Implements ilCtrlInterface.

Definition at line 659 of file class.ilCtrl.php.

                                                                               : void
    {
        throw new ilCtrlException(__METHOD__ . " is deprecated and must not be used.");
    }

isAsynch()

ilCtrl::isAsynch

(

)

Implements ilCtrlInterface.

Definition at line 571 of file class.ilCtrl.php.

Referenced by ilLearningHistoryGUI\getHistoryHtml(), ilBlockGUI\getHTML(), ilNoteGUI\getWidget(), ilLearningHistoryGUI\renderButton(), ilNoteGUI\renderContent(), and ilContainerRenderer\renderHelperGeneric().

                              : bool
    {
        return $this->context->isAsync();
    }

Here is the caller graph for this function:

isCmdSecure()

ilCtrl::isCmdSecure ( bool  $is_post, string  $cmd_class, ?string  $cmd = null  )

private

Returns whether a given command is considered safe or not.

Parameters

bool	$is_post
string	$cmd_class
string | null	$cmd

Returns

bool

Definition at line 1007 of file class.ilCtrl.php.

References null.

Referenced by getDeterminedCommand(), and getTargetUrl().

                                                                                       : bool
    {
        // if no command is specified, the command is
        // considered safe if it's not a POST command.
        if (null === $cmd) {
            return !$is_post;
        }

        // if the given command class doesn't exist, the
        // command is not considered safe as it might've been
        // tampered with.
        $obj_name = $this->structure->getObjNameByName($cmd_class);
        if (null === $obj_name) {
            return false;
        }

        // if the command class does not yet implement the
        // ilCtrlSecurityInterface, the command is considered
        // safe if it's not a POST command.
        if (!is_a($obj_name, ilCtrlSecurityInterface::class, true)) {
            return !$is_post;
        }

        // the post command is considered safe if it's contained
        // in the list of safe post commands.
        if ($is_post) {
            return in_array($cmd, $this->structure->getSafeCommandsByName($cmd_class), true);
        }

        // the get command is considered safe if it's not
        // contained in the list of unsafe get commands.
        return !in_array($cmd, $this->structure->getUnsafeCommandsByName($cmd_class), true);
    }

Here is the caller graph for this function:

lookupClassPath()

ilCtrl::lookupClassPath

(

string

$a_class

)

Implements ilCtrlInterface.

Definition at line 532 of file class.ilCtrl.php.

References $path, and null.

                                                    : string
    {
        $path = $this->structure->getRelativePathByName($a_class);
        if (null === $path) {
            throw new ilCtrlException("Class '$a_class' cannot be found in the control structure.");
        }

        return $path;
    }

lookupOriginalClassName()

ilCtrl::lookupOriginalClassName

(

string

$a_class

)

Implements ilCtrlInterface.

Definition at line 545 of file class.ilCtrl.php.

                                                            : ?string
    {
        return $this->structure->getObjNameByName($a_class);
    }

populateCall()

ilCtrl::populateCall ( string  $class_name, string  $cmd_mode  )

private

Helper function that populates a call in the current stacktrace.

Parameters

string	$class_name
string	$cmd_mode

Definition at line 1117 of file class.ilCtrl.php.

References getDeterminedCommand().

Referenced by forwardCommand(), and getHTML().

                                                                       : void
    {
        $obj_name = $this->structure->getObjNameByName($class_name);

        $this->stacktrace[] = [
            self::PARAM_CMD_CLASS => $obj_name,
            self::PARAM_CMD_MODE => $cmd_mode,
            self::PARAM_CMD => $this->getDeterminedCommand(),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirect()

ilCtrl::redirect	(	object	$a_gui_obj,
		?string	$a_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false
	)

Implements ilCtrlInterface.

Definition at line 393 of file class.ilCtrl.php.

References getClassByObject(), and redirectByClass().

Referenced by ilBadgeProfileGUI\activate(), ilBadgeProfileGUI\activateInCard(), ilExcCriteriaGUI\add(), ilObjMediaCastGUI\addMobsToCast(), ilObjMediaPoolGUI\addMobsToPool(), ilPCTabsGUI\addTab(), ilObjBlogGUI\afterSave(), ilSkillTreeNodeGUI\afterUpdate(), ilRecommendedContentRoleConfigGUI\assignItem(), ilObjExerciseAdministrationGUI\cancel(), ilObjBlogAdministrationGUI\cancel(), ilObjMediaCastSettingsGUI\cancel(), ilObjPortfolioAdministrationGUI\cancel(), ilObjTaggingSettingsGUI\cancel(), ilObjAwarenessAdministrationGUI\cancel(), ilObjStyleSheetGUI\cancelColorDeletionObject(), ilObjStyleSheetGUI\cancelColorSavingObject(), ilSkillRootGUI\cancelDelete(), ilObjMediaPoolGUI\cancelSave(), ilPCTabsGUI\cancelTabDeletion(), ilObjStyleSheetGUI\cancelTemplateDeletionObject(), ilObjStyleSheetGUI\cancelTemplateSavingObject(), ilWikiPageGUI\cancelWikiPageDeletion(), ilInternalLinkGUI\changeLinkType(), ilRecommendedContentRoleConfigGUI\checkPushPermission(), ilBadgeManagementGUI\clearClipboard(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilContSkillAdminGUI\confirmDeleteSelectedLocalProfiles(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilExcCriteriaGUI\create(), ilBadgeProfileGUI\deactivate(), ilBadgeProfileGUI\deactivateInCard(), ilContSkillAdminGUI\deassignCompetences(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilPortfolioRoleAssignmentGUI\deleteAssignments(), ilObjStyleSheetGUI\deleteColorObject(), ilPCFileListGUI\deleteFileItem(), ilBasicSkillGUI\deleteLevel(), ilObjStyleSheetGUI\deleteMediaQueriesObject(), ilContSkillAdminGUI\deleteSelectedLocalProfiles(), ilContSkillAdminGUI\deleteSingleLocalProfile(), ilObjMediaObjectGUI\deleteSrtFilesObject(), ilObjStyleSheetGUI\deleteTemplateKeepClassesObject(), ilObjStyleSheetGUI\deleteTemplateObject(), ilExAssignmentEditorGUI\downloadGlobalFeedbackFileObject(), ilPCInteractiveImageGUI\edit(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilNewsItemGUI\exitUpdateNewsItem(), ilObjMediaObjectGUI\extractPreviewImageObject(), ilBadgeManagementGUI\getBadgesFromMultiAction(), ilObjBadgeAdministrationGUI\getObjectBadgesFromMultiAction(), ilContSkillAdminGUI\initCompetenceAssignmentForm(), ilSurveyParticipantsGUI\inviteUsers(), ilBadgeManagementGUI\pasteBadges(), ilContSkillAdminGUI\publishAssignments(), ilEditClipboardGUI\remove(), ilMultilingualismGUI\removeLanguages(), ilContSkillAdminGUI\removeSelectedGlobalProfiles(), ilContSkillAdminGUI\removeSelectedSkill(), ilContSkillAdminGUI\removeSingleGlobalProfile(), ilInternalLinkGUI\resetLinkList(), ilObjMediaPoolGUI\returnFromItem(), ilTaxMDGUI\save(), ilObjNotificationSettingsGUI\save(), ilObjSkillTreeGUI\save(), ilPortfolioRoleAssignmentGUI\saveAssignment(), ilObjPortfolioAdministrationGUI\saveAuthorship(), ilContSkillAdminGUI\saveCompetenceAssignment(), ilContainerFilterAdminGUI\saveFields(), ilObjStyleSheetGUI\saveMediaQueryOrderObject(), ilObjMediaObjectGUI\saveMultiSrtObject(), ilObjBookingPoolGUI\saveNotificationObject(), ilObjStyleSheetGUI\saveObject(), ilPCFileListGUI\savePositions(), ilPCFileListGUI\savePositionsAndClasses(), ilBookingPreferencesGUI\savePreferences(), ilUserPrivacySettingsGUI\savePrivacySettings(), ilContSkillAdminGUI\saveSelectedProfile(), ilContSkillAdminGUI\saveSelectedSkill(), ilObjLearningHistorySettingsGUI\saveSettings(), ilObjNotesSettingsGUI\saveSettings(), ilObjCommentsSettingsGUI\saveSettings(), ilBookingGatewayGUI\saveSettings(), ilContSkillAdminGUI\saveSettings(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilExerciseManagementGUI\selectAssignmentObject(), ilExerciseManagementGUI\selectParticipantObject(), ilMediaCreationGUI\selectPool(), ilObjContentObjectGUI\sendMailToBlockedUsers(), ilInternalLinkGUI\setMedPoolFolder(), ilBookingGatewayGUI\show(), ilPCImageMapEditorGUI\updateAreas(), ilExSubmissionTextGUI\updateAssignmentTextObject(), ilObjStyleSheetGUI\updateObject(), ilObjMediaObjectGUI\uploadSubtitleFileObject(), and ilSurveyEvaluationGUI\validateAndSubmitExportForm().

     : void {
        $this->redirectByClass(
            $this->getClassByObject($a_gui_obj),
            $a_cmd,
            $a_anchor,
            $is_async
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectByClass()

ilCtrl::redirectByClass	(		$a_class,
		?string	$a_cmd = null,
		?string	$a_anchor = null,
		bool	$is_async = false
	)

Implements ilCtrlInterface.

Definition at line 410 of file class.ilCtrl.php.

References getLinkTargetByClass(), and redirectToURL().

Referenced by ilObjCmiXapiVerificationGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilStructureObjectGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilLMPageObjectGUI\_goto(), ilGlossaryTermGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjPortfolioGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjWikiGUI\_goto(), ilObjGlossaryGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjQuestionPoolGUI\_goto(), ilObjContentObjectGUI\_goto(), ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilNoteGUI\activateComments(), ilContainerGUI\competencesObject(), ilObjSkillTreeGUI\confirmedDeleteTrees(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilContentStyleSettingsGUI\createStyle(), ilNoteGUI\deactivateComments(), ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjStyleSheetGUI\editObject(), ilObjLearningSequenceGUI\forwardByClass(), ilAdministrationGUI\jumpToPluginSlot(), ilSkillProfileGUI\listLocalProfiles(), ilGlossaryPresentationGUI\listTermByGivenAsPanel(), redirect(), ilObjFileBasedLMGUI\redirectAfterCreation(), ilObjSessionGUI\redirectToParentContentPageObject(), ilRepositoryGUI\redirectToRoot(), ilObjSkillTreeGUI\save(), ilAchievementsGUI\show(), ilBookingGatewayGUI\show(), ilPDNotesGUI\showPrivateNotes(), and ilObjExerciseGUI\startAssignmentObject().

     : void {
        $this->redirectToURL(
            $this->getLinkTargetByClass(
                $a_class,
                $a_cmd,
                $a_anchor,
                $is_async
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToURL()

ilCtrl::redirectToURL

(

string

$target_url

)

Implements ilCtrlInterface.

Definition at line 429 of file class.ilCtrl.php.

References Vendor\Package\$e, $response, exit, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and null.

Referenced by ilObjUserFolderGUI\_goto(), ilObjTaxonomyGUI\cancel(), redirectByClass(), ilKSDocumentationGotoLink\redirectWithGotoLink(), and returnToParent().

                                                     : void
    {
        // prepend the ILIAS HTTP path if it wasn't already.
        if (defined("ILIAS_HTTP_PATH") &&
            strpos($target_url, "://") === false &&
            strpos($target_url, "/") !== 0
        ) {
            $target_url = ILIAS_HTTP_PATH . "/" . $target_url;
        }

        // this line can be dropped after discussion with TB or JF,
        // it keeps the functionality of UI plugin hooks alive.
        $target_url = $this->modifyUrlWithPluginHooks($target_url);

        // initialize http response object
        $response = new Response();

        // there's an exceptional case for asynchronous file uploads
        // where a json response is delivered.
        if ('application/json' === $this->server_request->getHeaderLine('Accept')) {
            try {
                $body = Streams::ofString(
                    json_encode(
                        [
                            'redirect_url' => $target_url,
                            'success' => true,
                            'message' => 'called redirect after asynchronous file-upload request.',
                        ],
                        JSON_THROW_ON_ERROR
                    )
                );
            } catch (Throwable $exception) {
                $body = Streams::ofString($exception->getMessage());
            }

            $response = $response->withBody($body);
        } else {
            $response = $response->withAddedHeader('Location', $target_url);
        }

        // manually trigger session_write_close() due to exceptions stored
        // in the ILIAS database, otherwise this method is called by exit()
        // which leads to the exceptions not being written to the database.
        session_write_close();

        try {
            $this->response_sender->sendResponse($response);
        } catch (ResponseSendingException $e) {
            header("Location: $target_url");
            if ('application/json' === $this->server_request->getHeaderLine('Accept')) {
                $content = (null !== $response->getBody()) ?
                    $response->getBody()->getContents() :
                    [];

                echo json_encode($content, JSON_THROW_ON_ERROR);
            }
        } catch (Throwable $t) {
            header("Location: $target_url");
            echo $t->getMessage();
        }

        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

returnToParent()

ilCtrl::returnToParent	(	object	$a_gui_obj,
		?string	$a_anchor = null
	)

Implements ilCtrlInterface.

Definition at line 601 of file class.ilCtrl.php.

References getClassByObject(), getParentReturnByClass(), null, and redirectToURL().

Referenced by ilMediaCreationGUI\cancel(), ilMediaCreationGUI\cancelCreate(), ilContainerGUI\cancelMoveLinkObject(), ilMediaPoolPageGUI\cancelSaveNewMediaPoolPage(), ilNewsItemGUI\cancelSaveNewsItem(), ilNewsForContextBlockGUI\cancelSettings(), ilObjStyleSheetGUI\copyStyleObject(), ilNewsItemGUI\exitSaveNewsItem(), ilObjectCopyGUI\keepObjectsInClipboard(), ilContainerGUI\keepObjectsInClipboardObject(), ilObjStyleSheetGUI\returnToUpperContextObject(), and ilMediaCreationGUI\saveTitlesAndDescriptions().

                                                                               : void
    {
        $class_name = $this->getClassByObject($a_gui_obj);
        $target_url = $this->getParentReturnByClass($class_name);

        // append redirect source to target url.
        $target_url = $this->appendParameterString(
            $target_url,
            self::PARAM_REDIRECT,
            $class_name
        );

        // append the provided anchor if necessary.
        if (null !== $a_anchor) {
            $target_url .= "#$a_anchor";
        }

        $this->redirectToURL($target_url);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveParameter()

ilCtrl::saveParameter	(	object	$a_gui_obj,
			$a_parameter
	)

Implements ilCtrlInterface.

Definition at line 212 of file class.ilCtrl.php.

References getClassByObject(), and saveParameterByClass().

Referenced by ilContSkillAdminGUI\assignCompetences(), ilSurveySkillGUI\assignSkillToQuestion(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilNewsTimelineGUI\executeCommand(), and ilBookingGatewayGUI\initPool().

                                                                  : void
    {
        $this->saveParameterByClass($this->getClassByObject($a_gui_obj), $a_parameter);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveParameterByClass()

ilCtrl::saveParameterByClass	(	string	$a_class,
			$a_parameter
	)

Implements ilCtrlInterface.

Definition at line 220 of file class.ilCtrl.php.

Referenced by ilContainerContentGUI\getRightColumnHTML(), and saveParameter().

                                                                       : void
    {
        if (!empty($a_parameter)) {
            if (is_array($a_parameter)) {
                foreach ($a_parameter as $parameter) {
                    $this->structure->setPermanentParameterByClass($a_class, $parameter);
                }
            } else {
                $this->structure->setPermanentParameterByClass($a_class, $a_parameter);
            }
        }
    }

Here is the caller graph for this function:

setContextObject()

ilCtrl::setContextObject	(	int	$obj_id,
		string	$obj_type
	)

Implements ilCtrlInterface.

Definition at line 496 of file class.ilCtrl.php.

                                                                   : void
    {
        // cannot process object without object type.
        if (!empty($obj_type)) {
            $this->context->setObjId($obj_id);
            $this->context->setObjType($obj_type);
        }
    }

setParameter()

ilCtrl::setParameter	(	object	$a_gui_obj,
		string	$a_parameter,
			$a_value
	)

Implements ilCtrlInterface.

Definition at line 236 of file class.ilCtrl.php.

References getClassByObject(), and setParameterByClass().

Referenced by ilObjBlogGUI\addHeaderActionForCommand(), ilObjMediaCastGUI\addMobsToCast(), ilObjWikiGUI\addPagesSubTabs(), ilObjWikiGUI\addPageTabs(), ilPCDataTableGUI\afterCreation(), ilPCTabsGUI\afterCreation(), ilSurveyEvaluationGUI\buildExportButtonAndModal(), ilObjMediaPoolGUI\cancelFolderUpdate(), ilInternalLinkGUI\changeLinkType(), ilInternalLinkGUI\changeTargetObject(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilNoteGUI\confirmDelete(), ilLMPageObjectGUI\create(), ilSkillTreeNodeGUI\deleteNodes(), ilNoteGUI\deleteNote(), ilRatingCategoryGUI\edit(), ilObjStyleSheetGUI\editColorObject(), ilStructureObjectGUI\editMasterLanguage(), ilObjContentObjectGUI\editMasterLanguage(), ilObjStyleSheetGUI\editMediaQueryObject(), ilObjSkillTreeGUI\editSkillTemplates(), ilObjStyleSheetGUI\editTemplateObject(), ilGroupAddToGroupActionGUI\executeCommand(), ilColumnGUI\executeCommand(), ilLMGlossaryTableGUI\fillRow(), ilLMMenuItemsTableGUI\fillRow(), ilTaxonomyListTableGUI\fillRow(), ilRatingCategoryTableGUI\fillRow(), ilHelpModuleTableGUI\fillRow(), ilStyleMediaQueryTableGUI\fillRow(), ilBookingSchedulesTableGUI\fillRow(), ilStyleColorTableGUI\fillRow(), ilTableTemplatesTableGUI\fillRow(), ilPageLayoutTableGUI\fillRow(), ilExerciseVerificationTableGUI\fillRow(), ilSurveySkillTableGUI\fillRow(), ilContSkillMemberTableGUI\fillRow(), ilSurveySkillAssignmentTableGUI\fillRow(), ilExcCriteriaTableGUI\fillRow(), ilTaxonomyTableGUI\fillRow(), ilCopySelfAssQuestionTableGUI\fillRow(), ilNewItemGroupTableGUI\fillRow(), ilContProfileTableGUI\fillRow(), ilSkillLevelTableGUI\fillRow(), ilExcCriteriaCatalogueTableGUI\fillRow(), ilWorkspaceAccessTableGUI\fillRow(), ilAssignmentsPerParticipantTableGUI\fillRow(), ilParticipantsPerAssignmentTableGUI\fillRow(), ilNoteGUI\getGlyph(), ilLikeGUI\getHTML(), ilColumnGUI\getHTML(), ilCommentGUI\getListHTML(), ilNoteGUI\getNotesHTML(), ilNoteGUI\getNumber(), ilPortfolioRepositoryGUI\getPortfolioList(), ilNoteGUI\getTriggerShyButton(), ilNoteGUI\getWidget(), ilInternalLinkGUI\init(), ilExAssignmentEditorGUI\initAssignmentForm(), ilObjBookingPoolGUI\initHeaderAction(), ilBookingGatewayGUI\initPool(), ilSkillProfileGUI\initProfileForm(), ilExAssignmentEditorGUI\listAssignmentsObject(), ilMediaCreationGUI\listPoolItems(), ilPageEditorGUI\pasteFromClipboard(), ilPCContentIncludeGUI\poolSelection(), ilTaggingClassificationProvider\render(), ilLearningHistoryGUI\renderButton(), ilContainerRenderer\renderHelperGeneric(), ilInternalLinkGUI\resetLinkList(), ilObjMediaPoolGUI\returnFromItem(), ilObjContentObjectGUI\savePageLayout(), ilExerciseManagementGUI\selectAssignmentObject(), ilExerciseManagementGUI\selectParticipantObject(), ilPCContentIncludeGUI\selectPool(), ilPCMediaObjectGUI\selectPool(), ilPCQuestionGUI\selectPool(), ilMediaCreationGUI\selectPool(), ilInternalLinkGUI\selectRepositoryItem(), ilSurveySkillThresholdsGUI\selectSkill(), ilObjMediaPoolGUI\setContentSubTabs(), ilInternalLinkGUI\setMedPoolFolder(), ilTable2GUI\setOrderLink(), ilObjContentObjectGUI\setPageLayoutInHierarchy(), ilRepositorySelectorInputGUI\showRepositorySelection(), ilStructureObjectGUI\switchToLanguage(), ilObjContentObjectGUI\switchToLanguage(), and ilSurveyEvaluationGUI\validateAndSubmitExportForm().

                                                                                  : void
    {
        $this->setParameterByClass($this->getClassByObject($a_gui_obj), $a_parameter, $a_value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParameterByClass()

ilCtrl::setParameterByClass	(	string	$a_class,
		string	$a_parameter,
			$a_value
	)

Implements ilCtrlInterface.

Definition at line 244 of file class.ilCtrl.php.

Referenced by ilObjCmiXapiVerificationGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilStructureObjectGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilLMPageObjectGUI\_goto(), ilGlossaryTermGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjPortfolioGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjWikiGUI\_goto(), ilObjGlossaryGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjQuestionPoolGUI\_goto(), ilObjContentObjectGUI\_goto(), ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilPCFileListGUI\addFileItem(), ilBlockGUI\addRepoCommands(), ilBasicSkillGUI\afterSave(), ilBasicSkillTemplateGUI\afterSave(), ilSkillTemplateReferenceGUI\afterSave(), ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), ILIAS\Test\StaticURLHandler\buildQuestionURL(), ilExAssTypeWikiTeamGUI\buildSubmissionPropertiesAndActions(), ilBlogPostingGUI\cancelBlogPostingDeletion(), ilObjWikiGUI\cancelCreationPageUsingTemplateObject(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjSkillTreeGUI\editSkills(), ilFoundUsersTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilContentStylesTableGUI\fillRow(), ilContProfileTableGUI\fillRow(), ilSkillCatTableGUI\fillRow(), ilBookingParticipantsTableGUI\fillRow(), ilObjLearningSequenceGUI\forwardByClass(), ilKSDocumentationGotoLink\generateRedirectURL(), McstPodcastGUI\getHTML(), ilRepositorySelector2InputGUI\getHTML(), ilExAssignmentInfo\getInstructionFileInfo(), ilNoteGUI\getItemForNote(), ilNewsForContextBlockGUI\getJSEnabler(), ilPCFileItemFileSelectorGUI\getNodeHref(), ilPoolSelectorGUI\getNodeHref(), ilTaxonomyExplorerGUI\getNodeHref(), ilMediaPoolExplorerGUI\getNodeHref(), ilSkillTemplateTreeExplorerGUI\getNodeHref(), ilRepositoryExplorerGUI\getNodeHref(), ilRepositorySelectorExplorerGUI\getNodeHref(), ilPersonalSkillExplorerGUI\getNodeHref(), ilPortfolioRepositoryGUI\getPortfolioList(), ilNoteGUI\getShyButton(), ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\getSubmissionLink(), ilBlogPostingGUI\getTabs(), ilPortfolioTemplatePageGUI\getViewPageLink(), ilPortfolioPageGUI\getViewPageLink(), ilBookingPreferencesGUI\listBookingResults(), ilObjFileBasedLMGUI\redirectAfterCreation(), ilContainerReferenceGUI\redirectObject(), ilBasicSkillTemplateGUI\redirectToParent(), ilSkillTemplateReferenceGUI\redirectToParent(), ilObjSessionGUI\redirectToParentContentPageObject(), ilRepositoryGUI\redirectToRoot(), ilRepositorySelector2InputGUI\render(), ILIAS\Blog\Navigation\ToolbarNavigationRenderer\renderActionDropdown(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), setParameter(), ilObjSkillTreeGUI\showLocator(), ilObjWikiGUI\showTemplateSelectionObject(), ilObjExerciseGUI\startAssignmentObject(), and ilExerciseManagementGUI\waitingDownloadObject().

                                                                                       : void
    {
        $this->structure->setTemporaryParameterByClass($a_class, $a_parameter, $a_value);
    }

Here is the caller graph for this function:

setReturn()

ilCtrl::setReturn	(	object	$a_gui_obj,
		?string	$a_cmd = null
	)

Implements ilCtrlInterface.

Definition at line 579 of file class.ilCtrl.php.

References getClassByObject(), and setReturnByClass().

Referenced by ilAssignmentPresentationGUI\executeCommand(), ilTaxonomySettingsGUI\executeCommand(), and ilBookingGatewayGUI\executeCommand().

                                                                       : void
    {
        $this->setReturnByClass($this->getClassByObject($a_gui_obj), $a_cmd);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setReturnByClass()

ilCtrl::setReturnByClass	(	string	$a_class,
		?string	$a_cmd = null
	)

Implements ilCtrlInterface.

Definition at line 587 of file class.ilCtrl.php.

References getLinkTargetByClass().

Referenced by ilObjectCopyGUI\cancel(), and setReturn().

                                                                            : void
    {
        $this->structure->setReturnTargetByClass(
            $a_class,
            $this->getLinkTargetByClass(
                $a_class,
                $a_cmd
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTargetScript()

ilCtrl::setTargetScript

(

string

$a_target_script

)

Implements ilCtrlInterface.

Definition at line 563 of file class.ilCtrl.php.

Referenced by ilObjCourseReferenceGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjectPluginGUI\afterSave(), ilImageMapEditorGUI\editMapAreas(), ilObjLearningSequenceGUI\forwardByClass(), and ilKSDocumentationGotoLink\generateRedirectURL().

                                                            : void
    {
        $this->context->setTargetScript($a_target_script);
    }

Here is the caller graph for this function:

Field Documentation

$command

string ilCtrl::$command = null

protected

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

Referenced by getCmd(), and getDeterminedCommand().

$exec_object

object ilCtrl::$exec_object = null

protected

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

Referenced by getHTML().

$stacktrace

array ilCtrl::$stacktrace = []

protected

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

Referenced by getCallHistory().

---

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

• components/ILIAS/UICore/classes/class.ilCtrl.php