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)
	@inheritDoc More...
	forwardCommand (object $a_gui_object)
	@inheritDoc More...
	getHTML (object $a_gui_object, ?array $a_parameters=null)
	@inheritDoc More...
	getCmd (?string $fallback_command=null)
	@inheritDoc More...
	getCmdClass ()
	@inheritDoc More...
	getNextClass ($a_gui_class=null)
	@inheritDoc More...
	saveParameter (object $a_gui_obj, $a_parameter)
	@inheritDoc More...
	saveParameterByClass (string $a_class, $a_parameter)
	@inheritDoc More...
	setParameter (object $a_gui_obj, string $a_parameter, $a_value)
	@inheritDoc More...
	setParameterByClass (string $a_class, string $a_parameter, $a_value)
	@inheritDoc More...
	getParameterArray (object $a_gui_obj)
	@inheritDoc More...
	getParameterArrayByClass (string $a_class)
	@inheritDoc More...
	clearParameters (object $a_gui_obj)
	@inheritDoc More...
	clearParametersByClass (string $a_class)
	@inheritDoc More...
	clearParameterByClass (string $a_class, string $a_parameter)
	@inheritDoc More...
	getLinkTarget (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	@inheritDoc More...
	getLinkTargetByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	@inheritDoc More...
	getFormAction (object $a_gui_obj, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	@inheritDoc More...
	getFormActionByClass ( $a_class, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	@inheritDoc More...
	redirect (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	@inheritDoc More...
	redirectByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	@inheritDoc More...
	redirectToURL (string $target_url)
	@inheritDoc More...
	setContextObject (int $obj_id, string $obj_type)
	@inheritDoc More...
	getContextObjId ()
	@inheritDoc More...
	getContextObjType ()
	@inheritDoc More...
	getCallHistory ()
	@inheritDoc More...
	lookupClassPath (string $a_class)
	@inheritDoc More...
	lookupOriginalClassName (string $a_class)
	@inheritDoc More...
	getClassForClasspath (string $a_class_path)
	@inheritDoc More...
	setTargetScript (string $a_target_script)
	@inheritDoc More...
	isAsynch ()
	@inheritDoc More...
	setReturn (object $a_gui_obj, ?string $a_cmd=null)
	@inheritDoc More...
	setReturnByClass (string $a_class, ?string $a_cmd=null)
	@inheritDoc More...
	returnToParent (object $a_gui_obj, ?string $a_anchor=null)
	@inheritDoc More...
	getParentReturn (object $a_gui_obj)
	@inheritDoc More...
	getParentReturnByClass (string $a_class)
	@inheritDoc More...
	getRedirectSource ()
	@inheritDoc More...
	insertCtrlCalls ($a_parent, $a_child, string $a_comp_prefix)
	@inheritDoc More...
	checkCurrentPathForClass (string $gui_class)
	@inheritDoc More...
	getCurrentClassPath ()
	@inheritDoc More...
	attachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	@inheritDoc More...
	detachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	@inheritDoc More...
	callBaseClass (?string $a_base_class=null)
	Calls the currently provided baseclass. More...
	forwardCommand (object $a_gui_object)
	Forwards the request by invoking executeCommand() on the given GUI object and fires an according ilCtrlEvent. More...
	getHTML (object $a_gui_object, ?array $a_parameters=null)
	Returns the HTML output of another GUI object by invoking getHTML() with optional parameters on it. More...
	getCmd (?string $fallback_command=null)
	Returns the command passed with the current POST or GET request and fires an according ilCtrlEvent. More...
	getCmdClass ()
	Returns the fully-qualified classname of the requested command class. More...
	getNextClass ($a_gui_class=null)
	Returns the fully-qualified classname of the next class in the control flow. More...
	saveParameter (object $a_gui_obj, $a_parameter)
	Sets parameters for the given object. More...
	saveParameterByClass (string $a_class, $a_parameter)
	Sets a parameter for the given GUI class that must be passed in every target link generation. More...
	setParameter (object $a_gui_obj, string $a_parameter, $a_value)
	Sets a parameter for the given GUI object and appends the given value. More...
	setParameterByClass (string $a_class, string $a_parameter, $a_value)
	Sets a parameter for the given GUI class and appends the given value as well. More...
	getParameterArray (object $a_gui_obj)
	Returns all parameters that have been saved or set for a GUI object. More...
	getParameterArrayByClass (string $a_class)
	Returns all parameters that have been saved or set for a given GUI class. More...
	clearParameters (object $a_gui_obj)
	Removes all currently set or saved parameters for the given GUI object. More...
	clearParametersByClass (string $a_class)
	Removes all currently set or saved parameters for the given GUI class. More...
	clearParameterByClass (string $a_class, string $a_parameter)
	Removes a specific parameter of a specific class that is currently set or saved. More...
	getLinkTarget (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	Returns a link target for the given information. More...
	getLinkTargetByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	Returns a link target for the given information. More...
	getFormAction (object $a_gui_obj, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	Returns a form action link for the given information. More...
	getFormActionByClass ( $a_class, ?string $a_fallback_cmd=null, ?string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
	Returns a form action link for the given information. More...
	redirect (object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	Redirects to another GUI object. More...
	redirectByClass ( $a_class, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
	Redirects to the provided GUI class. More...
	redirectToURL (string $target_url)
	Redirects to the given target URL. More...
	setContextObject (int $obj_id, string $obj_type)
	Sets the current object (id and type) of ilCtrl's context. More...
	getContextObjId ()
	Returns the current context's object id. More...
	getContextObjType ()
	Returns the current context's object type. More...
	getCallHistory ()
	Returns the descending stacktrace of ilCtrl calls that have been made. More...
	lookupClassPath (string $a_class)
	Get class path that can be used in include statements for a given class name. More...
	lookupOriginalClassName (string $a_class)
	This method was introduced due to composer being case-sensitive when autoloading classes. More...
	getClassForClasspath (string $a_class_path)
	Returns the effective classname for a given path. More...
	setTargetScript (string $a_target_script)
	Sets the current ilCtrl target script (default ilias.php). More...
	isAsynch ()
	Returns whether the current request is an asynchronous one. More...
	setReturn (object $a_gui_obj, ?string $a_cmd=null)
	Sets the return command of a given GUI object. More...
	setReturnByClass (string $a_class, ?string $a_cmd=null)
	Sets the return command of a given class. More...
	getParentReturn (object $a_gui_obj)
	getParentReturnByClass (string $a_class)
	returnToParent (object $a_gui_obj, ?string $a_anchor=null)
	Redirects to next parent class set with setReturn(). More...
	getRedirectSource ()
	Returns the current redirect source. More...
	insertCtrlCalls ($a_parent, $a_child, string $a_comp_prefix)
	Inserts an ilCtrl call record into the database. More...
	checkCurrentPathForClass (string $gui_class)
	Check if current CID trace contains a certain gui class. More...
	getCurrentClassPath ()
	Get current class path as array of class file names. More...
	attachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	Attaches an observer to ALL or a specific. More...
	detachObserver (ilCtrlObserver $observer, ilCtrlEvent $event=ilCtrlEvent::ALL)
	Detaches an observer from ALL or a specific. More...

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 @noinspection 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.

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

References $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 1050 of file class.ilCtrl.php.

     : 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;
    }

attachObserver()

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

@inheritDoc

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

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                               : 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());
    }

References forwardCommand().

Here is the call graph for this function:

checkCurrentPathForClass()

ilCtrl::checkCurrentPathForClass

(

string

$gui_class

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                               : 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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

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

Here is the caller graph for this function:

clearParameters()

ilCtrl::clearParameters

(

object

$a_gui_obj

)

@inheritDoc

Implements ilCtrlInterface.

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

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

References clearParametersByClass(), and getClassByObject().

Here is the call graph for this function:

clearParametersByClass()

ilCtrl::clearParametersByClass

(

string

$a_class

)

@inheritDoc

Implements ilCtrlInterface.

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

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

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

Here is the caller graph for this function:

detachObserver()

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

@inheritDoc

Implements ilCtrlInterface.

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

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

forwardCommand()

ilCtrl::forwardCommand

(

object

$a_gui_object

)

@inheritDoc

Implements ilCtrlInterface.

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

    {
        $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();
    }

References populateCall().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCallHistory()

ilCtrl::getCallHistory

(

)

@inheritDoc

Implements ilCtrlInterface.

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

                                    : 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 1135 of file class.ilCtrl.php.

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

Referenced by clearParameters(), getNextClass(), getParameterArray(), saveParameter(), and setParameter().

Here is the caller graph for this function:

getClassForClasspath()

ilCtrl::getClassForClasspath

(

string

$a_class_path

)

@inheritDoc

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

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                            : ?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
    }

References $command, and getDeterminedCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCmdClass()

ilCtrl::getCmdClass

(

)

@inheritDoc

Implements ilCtrlInterface.

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

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

getContextObjId()

ilCtrl::getContextObjId

(

)

@inheritDoc

Implements ilCtrlInterface.

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

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

getContextObjType()

ilCtrl::getContextObjType

(

)

@inheritDoc

Implements ilCtrlInterface.

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

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

getCurrentClassPath()

ilCtrl::getCurrentClassPath

(

)

@inheritDoc

Implements ilCtrlInterface.

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

                                         : 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;
    }

getDeterminedCommand()

ilCtrl::getDeterminedCommand ( )

protected

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

                                             : ?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 null;
        }
 
        return $command;
    }

Referenced by getCmd().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilBookingBulkCreationTableGUI\__construct(), ILIAS\Style\Content\CharacteristicTableGUI\__construct(), ilFeedbackConfirmationTable2GUI\__construct(), ilExAssignmentTeamLogTableGUI\__construct(), ilParticipantsPerAssignmentTableGUI\__construct(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilSessionStatisticsGUI\current(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilExSubmissionTeamGUI\getAdoptForm(), ilObjStyleSheetGUI\getCloneForm(), ilObjStyleSheetGUI\getCreateForm(), ilSurveyEvaluationGUI\getExportModal(), McstImageGalleryGUI\getHTML(), ilObjStyleSheetGUI\getImportForm(), ilPCAMDFormGUI\getPortfolioForm(), ilPortfolioRoleAssignmentGUI\initAssignmentForm(), ilObjNotificationSettingsGUI\initForm(), ILIAS\Chatroom\BuildChat\initialData(), ilMediaCreationGUI\initPoolSelection(), ilBookingGatewayGUI\initSettingsForm(), ilContSkillAdminGUI\initSettingsForm(), ilHistoryTableGUI\initTable(), ilMediaCreationGUI\initUrlForm(), ilContSkillAdminGUI\listProfiles(), ilSessionStatisticsGUI\long(), ilSessionStatisticsGUI\periodic(), ilSessionStatisticsGUI\renderCurrentBasics(), ilSessionStatisticsGUI\short(), and ilChatroomViewGUI\showNameSelection().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

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

Here is the caller graph for this function:

getHTML()

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

@inheritDoc

Implements ilCtrlInterface.

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

                                                                              : 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;
    }

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

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilObjWorkspaceFolderGUI\addContentSubTabs(), ilTaxMDGUI\addSubTab(), ILIAS\COPage\Page\PageQueryActionHandler\allCommand(), ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\assignParticipants(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilLMPageObjectGUI\create(), ilCopySelfAssQuestionTableGUI\fillRow(), ILIAS\COPage\Page\PageQueryActionHandler\getActionsDropDown(), ilObjLearningHistorySettingsGUI\getAdminTabs(), ilObjCommentsSettingsGUI\getAdminTabs(), ilObjNotesSettingsGUI\getAdminTabs(), ilObjPersonalWorkspaceSettingsGUI\getAdminTabs(), ilContainerFilterAdminGUI\getFieldSelectionForm(), ilNoteGUI\getGlyph(), ilLikeGUI\getHTML(), ILIAS\COPage\Page\PageQueryActionHandler\getMultiLangActions(), ilNoteGUI\getNumber(), ilPCAMDFormGUI\getTemplateForm(), ILIAS\COPage\Page\PageQueryActionHandler\getTopActions(), ilNoteGUI\getTriggerShyButton(), ilNoteGUI\getWidget(), ILIAS\COPage\PC\InteractiveImage\InteractiveImageQueryActionHandler\init(), ilObjPortfolioAdministrationGUI\initAuthorshipForm(), ilObjLearningHistorySettingsGUI\initForm(), ilObjCommentsSettingsGUI\initForm(), ilObjNotesSettingsGUI\initForm(), ilObjBookingPoolGUI\initHeaderAction(), ILIAS\Chatroom\BuildChat\initialData(), ilLMPageObjectGUI\initNewPageForm(), ilBookingPreferencesGUI\initPreferenceForm(), ilObjSkillTreeGUI\initTreeForm(), ilContSkillAdminGUI\listCompetences(), ilRecommendedContentRoleConfigGUI\listItems(), ilMediaCreationGUI\listPoolItems(), ilLearningHistoryGUI\renderButton(), ilTaggingSlateContentGUI\renderResourcesForTag(), ilObjDashboardSettingsGUI\setSettingsSubTabs(), ilPDNotesGUI\setToolbar(), ilGroupAddToGroupActionGUI\show(), ilSkillRootGUI\showImportForm(), ilSkillProfileGUI\showLevelsWithLocalContext(), and ILIAS\Chatroom\BuildChat\template().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilBlockGUI\addRepoCommands(), ilContainerSkillGUI\addTabs(), ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), ILIAS\Test\StaticURLHandler\buildQuestionURL(), ilExAssTypeUploadGUI\buildSubmissionPropertiesAndActions(), ilExAssTypeWikiTeamGUI\buildSubmissionPropertiesAndActions(), ilSkillProfileGUI\createLocal(), ilBookingParticipantsTableGUI\fillRow(), ilHistoryTableGUI\fillRow(), ILIAS\COPage\Page\PageQueryActionHandler\getActionsDropDown(), ilContainerPageGUI\getAdditionalPageActions(), ilObjLearningHistorySettingsGUI\getAdminTabs(), ilObjCommentsSettingsGUI\getAdminTabs(), ilObjNotesSettingsGUI\getAdminTabs(), ilObjPersonalWorkspaceSettingsGUI\getAdminTabs(), ilNoteGUI\getButton(), ilAccessibilitySupportContactsGUI\getFooterLink(), McstImageGalleryGUI\getHTML(), McstPodcastGUI\getHTML(), ilSurveyContainsDataMessageBoxGUI\getHTML(), ilExAssignmentInfo\getInstructionFileInfo(), ilAchievementsGUI\getLinks(), ilNoteGUI\getShyButton(), ilBookingPreferencesGUI\listBookingResults(), ilContSkillAdminGUI\listProfiles(), ilSkillTreeAdminGUI\listTrees(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), ilBookingGatewayGUI\setSubTabs(), ilPDNotesGUI\setToolbar(), ilSkillProfileGUI\showLevelsWithLocalContext(), and ilChatroomViewGUI\showRoom().

Here is the caller graph for this function:

getNextClass()

ilCtrl::getNextClass

(

$a_gui_class = null

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                     : ?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 '';
    }

References getClassByObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getParameterArray()

ilCtrl::getParameterArray

(

object

$a_gui_obj

)

@inheritDoc

Implements ilCtrlInterface.

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

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

References getClassByObject(), and getParameterArrayByClass().

Here is the call graph for this function:

getParameterArrayByClass()

ilCtrl::getParameterArrayByClass

(

string

$a_class

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                             : 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;
    }

References getQueryParam().

Referenced by getParameterArray().

Here is the call graph for this function:

Here is the caller graph for this function:

getParentReturn()

ilCtrl::getParentReturn

(

object

$a_gui_obj

)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilPageContentGUI\getParentReturn().

Here is the caller graph for this function:

getParentReturnByClass()

ilCtrl::getParentReturnByClass

(

string

$a_class

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                           : ?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;
    }

References $path.

getPostCommand()

ilCtrl::getPostCommand ( )

private

Returns the current $_POST command.

Returns

string|null

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

                                     : ?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;
    }

References ILIAS\Repository\refinery().

Here is the call 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 764 of file class.ilCtrl.php.

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

References ILIAS\Repository\refinery().

Referenced by getParameterArrayByClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectSource()

ilCtrl::getRedirectSource

(

)

@inheritDoc

Implements ilCtrlInterface.

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

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

getTableCommand()

ilCtrl::getTableCommand ( )

private

Deprecated:

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

                                      : ?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;
    }

References ILIAS\Repository\refinery().

Here is the call 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 849 of file class.ilCtrl.php.

     : ?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;
    }

insertCtrlCalls()

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

@inheritDoc

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

(

)

@inheritDoc

Implements ilCtrlInterface.

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

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

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

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 1008 of file class.ilCtrl.php.

                                                                                       : 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);
    }

lookupClassPath()

ilCtrl::lookupClassPath

(

string

$a_class

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                    : 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;
    }

References $path.

Referenced by ilLTIRouterGUI\executeCommand().

Here is the caller graph for this function:

lookupOriginalClassName()

ilCtrl::lookupOriginalClassName

(

string

$a_class

)

@inheritDoc

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 1118 of file class.ilCtrl.php.

                                                                       : 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(),
        ];
    }

Referenced by forwardCommand(), and getHTML().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilBadgeProfileGUI\activate(), ilBadgeProfileGUI\activateInCard(), ilExcCriteriaGUI\add(), ilExAssignmentEditorGUI\addAssignmentObject(), ilSessionStatisticsGUI\adminSync(), ilObjBlogGUI\afterSave(), ilSkillTreeNodeGUI\afterUpdate(), ilRecommendedContentRoleConfigGUI\assignItem(), ilObjAwarenessAdministrationGUI\cancel(), ilObjBlogAdministrationGUI\cancel(), ilObjExerciseAdministrationGUI\cancel(), ilObjMediaCastSettingsGUI\cancel(), ilObjPortfolioAdministrationGUI\cancel(), ilObjTaggingSettingsGUI\cancel(), ilSkillRootGUI\cancelDelete(), ilObjMediaPoolGUI\cancelSave(), ilInternalLinkGUI\changeLinkType(), ilRecommendedContentRoleConfigGUI\checkPushPermission(), ilPortfolioRoleAssignmentGUI\confirmAssignmentDeletion(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilContSkillAdminGUI\confirmRemoveSelectedGlobalProfiles(), ilContSkillAdminGUI\confirmRemoveSelectedSkill(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilBadgeProfileGUI\deactivate(), ilBadgeProfileGUI\deactivateInCard(), ilContSkillAdminGUI\deassignCompetences(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilChatroomBanGUI\delete(), ilPortfolioRoleAssignmentGUI\deleteAssignments(), ilBasicSkillGUI\deleteLevel(), ilContSkillAdminGUI\deleteSingleLocalProfile(), ilChatroomAdminViewGUI\executeDefault(), ilChatroomViewGUI\executeDefault(), ilChatroomBanGUI\handleTableActions(), ilContSkillAdminGUI\initCompetenceAssignmentForm(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilSurveyParticipantsGUI\inviteUsers(), ilContSkillAdminGUI\publishAssignments(), ilEditClipboardGUI\remove(), ilContSkillAdminGUI\removeSelectedGlobalProfiles(), ilContSkillAdminGUI\removeSelectedSkill(), ilContSkillAdminGUI\removeSingleGlobalProfile(), ilInternalLinkGUI\resetLinkList(), ilObjMediaPoolGUI\returnFromItem(), ilObjNotificationSettingsGUI\save(), ilTaxMDGUI\save(), ilPortfolioRoleAssignmentGUI\saveAssignment(), ilObjPortfolioAdministrationGUI\saveAuthorship(), ilChatroomAdminViewGUI\saveClientSettings(), ilContSkillAdminGUI\saveCompetenceAssignment(), ilContainerFilterAdminGUI\saveFields(), ilChatroomSettingsGUI\saveGeneral(), ilObjBookingPoolGUI\saveNotificationObject(), ilBookingPreferencesGUI\savePreferences(), ilContSkillAdminGUI\saveSelectedProfile(), ilContSkillAdminGUI\saveSelectedSkill(), ilBookingGatewayGUI\saveSettings(), ilContSkillAdminGUI\saveSettings(), ilObjLearningHistorySettingsGUI\saveSettings(), ilObjCommentsSettingsGUI\saveSettings(), ilObjNotesSettingsGUI\saveSettings(), ilExerciseManagementGUI\selectAssignmentObject(), ilExerciseManagementGUI\selectParticipantObject(), ilMediaCreationGUI\selectPool(), ilInternalLinkGUI\setMedPoolFolder(), ilBookingGatewayGUI\show(), ilPCImageMapEditorGUI\updateAreas(), and ilSurveyEvaluationGUI\validateAndSubmitExportForm().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilObjCmiXapiVerificationGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilLMPageObjectGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjWikiGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilNoteGUI\activateComments(), ilObjSkillTreeGUI\confirmedDeleteTrees(), ilContentStyleSettingsGUI\createStyle(), ilNoteGUI\deactivateComments(), ilObjStyleSheetGUI\editObject(), ilChatroomInfoScreenGUI\executeDefault(), ilObjLearningSequenceGUI\forwardByClass(), ilChatroomSettingsGUI\general(), ilAdministrationGUI\jumpToPluginSlot(), ilSkillProfileGUI\listLocalProfiles(), ilChatroomViewGUI\logout(), ilChatroomViewGUI\lostConnection(), ilObjFileBasedLMGUI\redirectAfterCreation(), ilChatroomGUIHandler\redirectIfNoPermission(), ilObjSessionGUI\redirectToParentContentPageObject(), ilRepositoryGUI\redirectToRoot(), ilObjSkillTreeGUI\save(), ilChatroomSettingsGUI\saveGeneral(), ilBookingGatewayGUI\show(), ilAchievementsGUI\show(), ilPDNotesGUI\showPrivateNotes(), ilChatroomViewGUI\showRoom(), and ilObjExerciseGUI\startAssignmentObject().

Here is the caller graph for this function:

redirectToURL()

ilCtrl::redirectToURL

(

string

$target_url

)

@inheritDoc

Implements ilCtrlInterface.

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

                                                     : 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;
    }

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

Referenced by ilKSDocumentationGotoLink\redirectWithGotoLink().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

                                                                               : 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);
    }

Referenced by ilMediaCreationGUI\cancel(), ilMediaCreationGUI\cancelCreate(), ilNewsForContextBlockGUI\cancelSettings(), ilObjectCopyGUI\keepObjectsInClipboard(), and ilMediaCreationGUI\saveTitlesAndDescriptions().

Here is the caller graph for this function:

saveParameter()

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

@inheritDoc

Implements ilCtrlInterface.

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

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

References getClassByObject(), and saveParameterByClass().

Referenced by ilSurveySkillGUI\assignSkillToQuestion(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilNewsTimelineGUI\executeCommand(), ilBookingGatewayGUI\initPool(), and ilChatroomViewGUI\showNameSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

saveParameterByClass()

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

@inheritDoc

Implements ilCtrlInterface.

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

                                                                       : 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);
            }
        }
    }

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

Here is the caller graph for this function:

setContextObject()

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

@inheritDoc

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

References getClassByObject(), and setParameterByClass().

Referenced by ilObjWikiGUI\addPagesSubTabs(), ilObjWikiGUI\addPageTabs(), ilPCDataTableGUI\afterCreation(), ilContSkillAdminGUI\assignCompetences(), ilObjMediaPoolGUI\cancelFolderUpdate(), ilInternalLinkGUI\changeLinkType(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilLMPageObjectGUI\create(), ilSkillTreeNodeGUI\deleteNodes(), ilNoteGUI\deleteNote(), ilObjSkillTreeGUI\editSkillTemplates(), ilGroupAddToGroupActionGUI\executeCommand(), ilBookingSchedulesTableGUI\fillRow(), ilCopySelfAssQuestionTableGUI\fillRow(), ilPageLayoutTableGUI\fillRow(), ilAssignmentsPerParticipantTableGUI\fillRow(), ilExerciseVerificationTableGUI\fillRow(), ilParticipantsPerAssignmentTableGUI\fillRow(), ilExcCriteriaCatalogueTableGUI\fillRow(), ilExcCriteriaTableGUI\fillRow(), ilHelpModuleTableGUI\fillRow(), ilLMGlossaryTableGUI\fillRow(), ilLMMenuItemsTableGUI\fillRow(), ilClipboardTableGUI\fillRow(), ilWorkspaceAccessTableGUI\fillRow(), ilNewItemGroupTableGUI\fillRow(), ilSkillLevelTableGUI\fillRow(), ilStyleMediaQueryTableGUI\fillRow(), ilTableTemplatesTableGUI\fillRow(), ilStyleColorTableGUI\fillRow(), ilSurveySkillAssignmentTableGUI\fillRow(), ilSurveySkillTableGUI\fillRow(), ilTaxonomyListTableGUI\fillRow(), ilTaxonomyTableGUI\fillRow(), ILIAS\COPage\Page\PageQueryActionHandler\getActionsDropDown(), ilNoteGUI\getGlyph(), ilLikeGUI\getHTML(), ilCommentGUI\getListHTML(), ILIAS\COPage\Page\PageQueryActionHandler\getMultiLangActions(), ilNoteGUI\getNotesHTML(), ilNoteGUI\getNumber(), ilNoteGUI\getTriggerShyButton(), ilNoteGUI\getWidget(), ilInternalLinkGUI\init(), ilObjBookingPoolGUI\initHeaderAction(), ilBookingGatewayGUI\initPool(), ilSkillProfileGUI\initProfileForm(), ilExAssignmentEditorGUI\listAssignmentsObject(), ilMediaCreationGUI\listPoolItems(), ilPCContentIncludeGUI\poolSelection(), ilLearningHistoryGUI\renderButton(), ilInternalLinkGUI\resetLinkList(), ilObjMediaPoolGUI\returnFromItem(), ilExerciseManagementGUI\selectAssignmentObject(), ilExerciseManagementGUI\selectParticipantObject(), ilPCContentIncludeGUI\selectPool(), ilPCQuestionGUI\selectPool(), ilMediaCreationGUI\selectPool(), ilInternalLinkGUI\setMedPoolFolder(), ilRepositorySelectorInputGUI\showRepositorySelection(), and ilSurveyEvaluationGUI\validateAndSubmitExportForm().

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
	)

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilObjCmiXapiVerificationGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilLMPageObjectGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjWikiGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilBlockGUI\addRepoCommands(), ilBasicSkillGUI\afterSave(), ilBasicSkillTemplateGUI\afterSave(), ilSkillTemplateReferenceGUI\afterSave(), ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), ILIAS\Test\StaticURLHandler\buildQuestionURL(), ilExAssTypeWikiTeamGUI\buildSubmissionPropertiesAndActions(), ilContSkillAdminGUI\confirmDeleteSingleLocalProfile(), ilContSkillAdminGUI\confirmRemoveSingleGlobalProfile(), ilObjSkillTreeGUI\editSkills(), ilBookingParticipantsTableGUI\fillRow(), ilHistoryTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilSkillCatTableGUI\fillRow(), ilContentStylesTableGUI\fillRow(), ilFoundUsersTableGUI\fillRow(), ilObjLearningSequenceGUI\forwardByClass(), ilChatroomSettingsGUI\general(), ILIAS\LearningModule\Menu\ilLMMenuGUI\getEntries(), ilRepositorySelector2InputGUI\getHTML(), McstImageGalleryGUI\getHTML(), McstPodcastGUI\getHTML(), ilExAssignmentInfo\getInstructionFileInfo(), ilNoteGUI\getItemForNote(), ilNewsForContextBlockGUI\getJSEnabler(), ilPoolSelectorGUI\getNodeHref(), ilPCFileItemFileSelectorGUI\getNodeHref(), ilMediaPoolExplorerGUI\getNodeHref(), ilRepositoryExplorerGUI\getNodeHref(), ilRepositorySelectorExplorerGUI\getNodeHref(), ilPersonalSkillExplorerGUI\getNodeHref(), ilSkillTemplateTreeExplorerGUI\getNodeHref(), ilTaxonomyExplorerGUI\getNodeHref(), ilNoteGUI\getShyButton(), ilBookingPreferencesGUI\listBookingResults(), ilChatroomViewGUI\logout(), ilObjFileBasedLMGUI\redirectAfterCreation(), ilChatroomGUIHandler\redirectIfNoPermission(), ilContainerReferenceGUI\redirectObject(), ilBasicSkillTemplateGUI\redirectToParent(), ilSkillTemplateReferenceGUI\redirectToParent(), ilObjSessionGUI\redirectToParentContentPageObject(), ilRepositoryGUI\redirectToRoot(), ilRepositorySelector2InputGUI\render(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), ilChatroomSettingsGUI\saveGeneral(), setParameter(), ilObjSkillTreeGUI\showLocator(), ilObjExerciseGUI\startAssignmentObject(), and ilExerciseManagementGUI\waitingDownloadObject().

Here is the caller graph for this function:

setReturn()

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

@inheritDoc

Implements ilCtrlInterface.

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

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

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

Here is the caller graph for this function:

setReturnByClass()

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

@inheritDoc

Implements ilCtrlInterface.

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

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

Referenced by ilObjectCopyGUI\cancel().

Here is the caller graph for this function:

setTargetScript()

ilCtrl::setTargetScript

(

string

$a_target_script

)

@inheritDoc

Implements ilCtrlInterface.

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

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

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

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().

$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.

---

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

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