This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCtrlInterface:

Collaboration diagram for ilCtrlInterface:

Public Member Functions
	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. 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. More...

	setCmd (?string $a_cmd)
	Sets the current command. More...

	getCmdClass ()
	Returns the fully-qualified classname of the requested command class. More...

	setCmdClass ($a_cmd_class)
	Sets the command class that should be executed next. 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...

Data Fields
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 25 of file interface.ilCtrlInterface.php.

Member Function Documentation

◆ callBaseClass()

ilCtrlInterface::callBaseClass ( string $a_base_class = null )

Calls the currently provided baseclass.

If no baseclass is provided as an argument, the current GET request MUST contain

Parameters

string | null $a_base_class

Exceptions

ilCtrlException if no valid baseclass is provided.

See also: ilCtrlInterface::PARAM_BASE_CLASS.

Implemented in ilCtrl.

◆ checkCurrentPathForClass()

ilCtrlInterface::checkCurrentPathForClass ( string $gui_class )

Check if current CID trace contains a certain gui class.

Parameters

string $gui_class

Returns: bool

Exceptions

ilCtrlException

Implemented in ilCtrl.

◆ clearParameterByClass()

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

Removes a specific parameter of a specific class that is currently set or saved.

Parameters

string	$a_class
string	$a_parameter

Implemented in ilCtrl.

Referenced by ilCalendarPresentationGUI\addCategoryTabs().

Here is the caller graph for this function:

◆ clearParameters()

ilCtrlInterface::clearParameters ( object $a_gui_obj )

Removes all currently set or saved parameters for the given GUI object.

Parameters

object $a_gui_obj

Implemented in ilCtrl.

◆ clearParametersByClass()

ilCtrlInterface::clearParametersByClass ( string $a_class )

Removes all currently set or saved parameters for the given GUI class.

Parameters

string $a_class

Implemented in ilCtrl.

◆ forwardCommand()

ilCtrlInterface::forwardCommand ( object $a_gui_object )

Forwards the request by invoking executeCommand() on the given GUI object.

If any output was generated in that method, it will be returned by this method as well.

Parameters

object $a_gui_object

Returns: mixed

Exceptions

ilCtrlException if executeCommand() cannot be invoked.

Implemented in ilCtrl.

◆ getCallHistory()

ilCtrlInterface::getCallHistory ( )

Returns the descending stacktrace of ilCtrl calls that have been made.

Returns: array<int, array<string, string>>

Implemented in ilCtrl.

◆ getClassForClasspath()

ilCtrlInterface::getClassForClasspath ( string $a_class_path )

Returns the effective classname for a given path.

Deprecated:: if you know the classpath you most likely called lookupClassPath already, which means you already know the classname.

Parameters

string $a_class_path

Returns: string

Exceptions

ilCtrlException in the future.

Implemented in ilCtrl.

◆ getCmd()

ilCtrlInterface::getCmd ( string $fallback_command = null )

Returns the command passed with the current POST or GET request.

Parameters

string | null $fallback_command

Returns: string|null

Implemented in ilCtrl.

Referenced by ilSettingsTemplateGUI\executeCommand(), and ilMembershipOverviewGUI\executeCommand().

Here is the caller graph for this function:

◆ getCmdClass()

ilCtrlInterface::getCmdClass ( )

Returns the fully-qualified classname of the requested command class.

Note this will be lowercase for backwards compatibility.

Returns: string|null

Implemented in ilCtrl.

◆ getContextObjId()

ilCtrlInterface::getContextObjId ( )

Returns the current context's object id.

Deprecated:: setParameterByClass, setParameter, saveParameterByClass or saveParameter should be used.

Returns: int|null

Implemented in ilCtrl.

◆ getContextObjType()

ilCtrlInterface::getContextObjType ( )

Returns the current context's object type.

Deprecated:: setParameterByClass, setParameter, saveParameterByClass or saveParameter should be used.

Returns: string|null

Implemented in ilCtrl.

◆ getCurrentClassPath()

ilCtrlInterface::getCurrentClassPath ( )

Get current class path as array of class file names.

Returns: array

Implemented in ilCtrl.

◆ getFormAction()

ilCtrlInterface::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.

Parameters

object	$a_gui_obj
string \| null	$a_fallback_cmd
string \| null	$a_anchor
bool	$is_async
bool	$has_xml_style

Returns: string

Exceptions

ilCtrlException if the provided class cannot be found.

Implemented in ilCtrl.

◆ getFormActionByClass()

ilCtrlInterface::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.

Parameters

string \| string[]	$a_class
string \| null	$a_fallback_cmd
string \| null	$a_anchor
bool	$is_async
bool	$has_xml_style

Returns: string

Exceptions

ilCtrlException if a provided class cannot be found.

Implemented in ilCtrl.

◆ getHTML()

ilCtrlInterface::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.

Parameters

object	$a_gui_object
array \| null	$a_parameters

Returns: string

Exceptions

ilCtrlException if getHTML() cannot be invoked.

Implemented in ilCtrl.

◆ getLinkTarget()

ilCtrlInterface::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.

Parameters

object	$a_gui_obj
string \| null	$a_cmd
string \| null	$a_anchor
bool	$is_async
bool	$has_xml_style

Returns: string

Exceptions

ilCtrlException if the provided class cannot be found.

Implemented in ilCtrl.

Referenced by ilCalendarViewGUI\addToolbarFileDownload().

Here is the caller graph for this function:

◆ getLinkTargetByClass()

ilCtrlInterface::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.

Parameters

string \| string[]	$a_class
string \| null	$a_cmd
string \| null	$a_anchor
bool	$is_async
bool	$has_xml_style

Returns: string

Exceptions

ilCtrlException if a provided class cannot be found.

Implemented in ilCtrl.

Referenced by ilCalendarPresentationGUI\addCategoryTabs(), ilObjLearningModuleListGUI\getCommandLink(), ILIAS\Notes\FilterAdapterGUI\getFilter(), ilCalendarPresentationGUI\prepareOutput(), and ilCalendarPresentationGUI\showViewSelection().

Here is the caller graph for this function:

◆ getNextClass()

ilCtrlInterface::getNextClass ( $a_gui_class = null )

Returns the fully-qualified classname of the next class in the control flow.

Note this will be lowercase for backwards compatibility.

Parameters

object | string | null $a_gui_class

Returns: string|null

Exceptions

ilCtrlException if an invalid parameter name is given.

Implemented in ilCtrl.

Referenced by ilMembershipOverviewGUI\executeCommand().

Here is the caller graph for this function:

◆ getParameterArray()

ilCtrlInterface::getParameterArray ( object $a_gui_obj )

Returns all parameters that have been saved or set for a GUI object.

Parameters

object $a_gui_obj

Returns: array

Exceptions

ilCtrlException if the given object cannot be found.

Implemented in ilCtrl.

◆ getParameterArrayByClass()

ilCtrlInterface::getParameterArrayByClass ( string $a_class )

Returns all parameters that have been saved or set for a given GUI class.

Parameters

string $a_class

Returns: array<string, mixed>

Exceptions

ilCtrlException if the given class cannot be found.

Implemented in ilCtrl.

◆ getParentReturn()

ilCtrlInterface::getParentReturn ( object $a_gui_obj )

See also: ilCtrlInterface::getReturnClass().

Deprecated:: Used in conjunction with ilTabs->setBackTarget and ilBlockGUI->addHeaderCommand.

Parameters

object $a_gui_obj

Returns: string|null

Implemented in ilCtrl.

◆ getParentReturnByClass()

ilCtrlInterface::getParentReturnByClass ( string $a_class )

See also: ilCtrlInterface::getReturnClass().

Deprecated:

See also: ilCtrlInterface::getParentReturn().

Parameters

string $a_class

Returns: string|null

Implemented in ilCtrl.

◆ getRedirectSource()

ilCtrlInterface::getRedirectSource ( )

Returns the current redirect source.

Returns: string|null

Implemented in ilCtrl.

◆ insertCtrlCalls()

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

Inserts an ilCtrl call record into the database.

Deprecated:: Due to the change of storing data in an artifact, this method should no longer be used. If an error is thrown at this point, it's probably solved by the correct @ilCtrl_Calls or @ilCtrl_IsCalledBy statements.

Parameters

object \| string	$a_parent
object \| string	$a_child
string	$a_comp_prefix

Exceptions

ilCtrlException due to deprecation.

Implemented in ilCtrl.

◆ isAsynch()

ilCtrlInterface::isAsynch ( )

Returns whether the current request is an asynchronous one.

Returns: bool

Implemented in ilCtrl.

◆ lookupClassPath()

ilCtrlInterface::lookupClassPath ( string $a_class )

Get class path that can be used in include statements for a given class name.

Parameters

string $a_class

Returns: string

Exceptions

ilCtrlException if the class cannot be found.

Implemented in ilCtrl.

◆ lookupOriginalClassName()

ilCtrlInterface::lookupOriginalClassName ( string $a_class )

This method was introduced due to composer being case-sensitive when autoloading classes.

In some cases, the command class needs to be dynamically instantiated, for which one should use the name with proper capitalization.

Implemented in ilCtrl.

◆ redirect()

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

Redirects to another GUI object.

Parameters

object	$a_gui_obj
string \| null	$a_cmd
string \| null	$a_anchor
bool	$is_async

Exceptions

ilCtrlException if the provided class cannot be found.

Implemented in ilCtrl.

◆ redirectByClass()

ilCtrlInterface::redirectByClass	(		$a_class,
		string	$a_cmd = `null`,
		string	$a_anchor = `null`,
		bool	$is_async = `false`
	)

Redirects to the provided GUI class.

Parameters

string \| string[]	$a_class
string \| null	$a_cmd
string \| null	$a_anchor
bool	$is_async

Exceptions

ilCtrlException if a provided class cannot be found.

Implemented in ilCtrl.

◆ redirectToURL()

ilCtrlInterface::redirectToURL ( string $target_url )

Redirects to the given target URL.

Parameters

string $target_url

Implemented in ilCtrl.

◆ returnToParent()

ilCtrlInterface::returnToParent	(	object	$a_gui_obj,
		string	$a_anchor = `null`
	)

Redirects to next parent class set with setReturn().

Deprecated:

See also: ilCtrlInterface::getParentReturn().

Parameters

object	$a_gui_obj
string \| null	$a_anchor

Exceptions

ilCtrlException if the object was not yet provided with a return target.

Implemented in ilCtrl.

◆ saveParameter()

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

Sets parameters for the given object.

See also: ilCtrlInterface::saveParameterByClass()

Parameters

object	$a_gui_obj
string \| string[]	$a_parameter

Exceptions

ilCtrlException if an invalid parameter name is given.

Implemented in ilCtrl.

◆ saveParameterByClass()

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

Sets a parameter for the given GUI class that must be passed in every target link generation.

This means ilCtrl considers these parameters whenever a link-generation method is called afterwards, and uses the currently given value for these parameters for the next URL as well.

Typical examples are ref_id or obj_id, where the constructor of a class can use the statement $ilCtrl->saveParameterByClass(self::class, ['ref_id'])

See also: ilCtrlInterface::getLinkTargetByClass(), ilCtrlInterface::getFormActionByClass()

Parameters

string	$a_class
string \| string[]	$a_parameter

Exceptions

ilCtrlException if an invalid parameter name is given.

Implemented in ilCtrl.

◆ setCmd()

ilCtrlInterface::setCmd ( ?string $a_cmd )

Sets the current command.

Deprecated:: this method should not be used anymore and will be removed with ILIAS 10.

Parameters

string | null $a_cmd

Implemented in ilCtrl.

◆ setCmdClass()

ilCtrlInterface::setCmdClass ( $a_cmd_class )

Sets the command class that should be executed next.

Deprecated:: this method should not be used anymore and will be removed with ILIAS 10.

Parameters

object | string | null $a_cmd_class

Implemented in ilCtrl.

◆ setContextObject()

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

Sets the current object (id and type) of ilCtrl's context.

Deprecated:: setParameterByClass, setParameter, saveParameterByClass or saveParameter should be used.

Parameters

int	$obj_id
string	$obj_type

Implemented in ilCtrl.

◆ setParameter()

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

Sets a parameter for the given GUI object and appends the given value.

See also: ilCtrlInterface::setParameterByClass()

Parameters

object	$a_gui_obj
string	$a_parameter
mixed	$a_value

Exceptions

ilCtrlException if an invalid parameter name is given.

Implemented in ilCtrl.

◆ setParameterByClass()

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

Sets a parameter for the given GUI class and appends the given value as well.

unlike

See also: ilCtrlInterface::saveParameterByClass() this method uses the given value for future link generation method calls, instead of using the value already given.

Parameters

string	$a_class
string	$a_parameter
mixed	$a_value

Exceptions

ilCtrlException if an invalid parameter name is given.

Implemented in ilCtrl.

Referenced by ilCalendarPresentationGUI\addCategoryTabs(), ilObjSessionListGUI\getCommandLink(), ilObjBookingPoolListGUI\getCommandLink(), ilObjItemGroupListGUI\getCommandLink(), ilObjLearningModuleListGUI\getCommandLink(), ilObjWorkspaceRootFolderListGUI\getCommandLink(), ilCalendarPresentationGUI\prepareOutput(), and ilCalendarPresentationGUI\showViewSelection().

Here is the caller graph for this function:

◆ setReturn()

ilCtrlInterface::setReturn	(	object	$a_gui_obj,
		string	$a_cmd = `null`
	)

Sets the return command of a given GUI object.

Parameters

object	$a_gui_obj
string \| null	$a_cmd

Returns: mixed

Exceptions

ilCtrlException if a provided class cannot be found.

Implemented in ilCtrl.

Referenced by ilMembershipOverviewGUI\executeCommand().

Here is the caller graph for this function:

◆ setReturnByClass()

ilCtrlInterface::setReturnByClass	(	string	$a_class,
		string	$a_cmd = `null`
	)

Sets the return command of a given class.

Parameters

string	$a_class
string \| null	$a_cmd

Returns: mixed

Exceptions

ilCtrlException if a provided class cannot be found.

Implemented in ilCtrl.

◆ setTargetScript()

ilCtrlInterface::setTargetScript ( string $a_target_script )

Sets the current ilCtrl target script (default ilias.php).

Parameters

string $a_target_script

Implemented in ilCtrl.

Field Documentation

◆ CMD_MODE_ASYNC

const ilCtrlInterface::CMD_MODE_ASYNC = 'asynch'

Definition at line 59 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), and ilCtrlContextTest\testContextAsyncPropertyAdoptionByRequest().

◆ CMD_MODE_HTML

const ilCtrlInterface::CMD_MODE_HTML = 'getHtml'

Definition at line 60 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContextTest\testContextAsyncPropertyAdoptionByRequest().

◆ CMD_MODE_PROCESS

const ilCtrlInterface::CMD_MODE_PROCESS = 'execComm'

different modes used for UI plugins (or in dev-mode).

Definition at line 58 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContextTest\testContextAsyncPropertyAdoptionByRequest().

◆ CMD_POST

const ilCtrlInterface::CMD_POST = 'post'

Definition at line 31 of file interface.ilCtrlInterface.php.

◆ PARAM_BASE_CLASS

const ilCtrlInterface::PARAM_BASE_CLASS = 'baseClass'

Definition at line 39 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), ILIAS\UICore\PageContentProvider\getFooterModification(), ilCtrlContextTest\testContextBaseClassPropertyAdoptionByRequest(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PARAM_CID_PATH

const ilCtrlInterface::PARAM_CID_PATH = 'cmdNode'

Definition at line 37 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PARAM_CMD

const ilCtrlInterface::PARAM_CMD = 'cmd'

Definition at line 43 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PARAM_CMD_CLASS

const ilCtrlInterface::PARAM_CMD_CLASS = 'cmdClass'

Definition at line 40 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), ilMMSubItemGUI\executeCommand(), ilGlobalTemplate\fillFooter(), ilCtrlContextTest\testContextCommandClassPropertyWithBaseClass(), ilCtrlContextTest\testContextCommandClassPropertyWithoutBaseClass(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PARAM_CMD_FALLBACK

const ilCtrlInterface::PARAM_CMD_FALLBACK = 'fallbackCmd'

Definition at line 42 of file interface.ilCtrlInterface.php.

◆ PARAM_CMD_MODE

const ilCtrlInterface::PARAM_CMD_MODE = 'cmdMode'

Definition at line 41 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), ilCtrlContextTest\testContextAsyncPropertyAdoptionByRequest(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PARAM_CSRF_TOKEN

const ilCtrlInterface::PARAM_CSRF_TOKEN = 'rtoken'

$_GET request parameter names, used throughout ilCtrl.

Definition at line 36 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlTokenRepository\fetchToken(), and ilCtrlTokenRepository\storeToken().

◆ PARAM_REDIRECT

const ilCtrlInterface::PARAM_REDIRECT = 'redirectSource'

Definition at line 38 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlContext\adoptRequestParameters(), and ilCtrlContextTest\testContextPropertyAdoptionByRequest().

◆ PROTECTED_PARAMETERS

const ilCtrlInterface::PROTECTED_PARAMETERS

Initial value:

= [
        self::PARAM_BASE_CLASS,
        self::PARAM_CMD_CLASS,
        self::PARAM_CID_PATH,
        self::PARAM_CSRF_TOKEN,
    ]

Definition at line 48 of file interface.ilCtrlInterface.php.

Referenced by ilCtrlStructure\setPermanentParameterByClass().

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

Services/UICore/interfaces/interface.ilCtrlInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ callBaseClass()

◆ checkCurrentPathForClass()

◆ clearParameterByClass()

◆ clearParameters()

◆ clearParametersByClass()

◆ forwardCommand()

◆ getCallHistory()

◆ getClassForClasspath()

◆ getCmd()

◆ getCmdClass()

◆ getContextObjId()

◆ getContextObjType()

◆ getCurrentClassPath()

◆ getFormAction()

◆ getFormActionByClass()

◆ getHTML()

◆ getLinkTarget()

◆ getLinkTargetByClass()

◆ getNextClass()

◆ getParameterArray()

◆ getParameterArrayByClass()

◆ getParentReturn()

◆ getParentReturnByClass()

◆ getRedirectSource()

◆ insertCtrlCalls()

◆ isAsynch()

◆ lookupClassPath()

◆ lookupOriginalClassName()

◆ redirect()

◆ redirectByClass()

◆ redirectToURL()

◆ returnToParent()

◆ saveParameter()

◆ saveParameterByClass()

◆ setCmd()

◆ setCmdClass()

◆ setContextObject()

◆ setParameter()

◆ setParameterByClass()

◆ setReturn()

◆ setReturnByClass()

◆ setTargetScript()

Field Documentation

◆ CMD_MODE_ASYNC

◆ CMD_MODE_HTML

◆ CMD_MODE_PROCESS

◆ CMD_POST

◆ PARAM_BASE_CLASS

◆ PARAM_CID_PATH

◆ PARAM_CMD

◆ PARAM_CMD_CLASS

◆ PARAM_CMD_FALLBACK

◆ PARAM_CMD_MODE

◆ PARAM_CSRF_TOKEN

◆ PARAM_REDIRECT

◆ PROTECTED_PARAMETERS