ilCtrlContextInterface Interface Reference

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

Inheritance diagram for ilCtrlContextInterface:

Collaboration diagram for ilCtrlContextInterface:

Public Member Functions
	isAsync ()
	Returns whether this context is asynchronous or not. More...
	getRedirectSource ()
	Returns where the request of this context was redirected from. More...
	getPath ()
	Returns the path of this context. More...
	setCmdMode (string $mode)
	Sets the command mode of the current context. More...
	getCmdMode ()
	Returns the command mode of the current context. More...
	setBaseClass (string $base_class)
	Sets the baseclass of the current context. More...
	getBaseClass ()
	Returns the baseclass the current context. More...
	setTargetScript (string $target_script)
	Sets the target script of this context (usually ilias.php). More...
	getTargetScript ()
	Returns the target script of this context. More...
	setCmdClass (?string $cmd_class)
	Sets the current contexts command class. More...
	getCmdClass ()
	Returns the command class of this context. More...
	setCmd (?string $cmd)
	Sets the command which the current command- or baseclass should perform. More...
	getCmd ()
	Returns the command which the current command- or baseclass should perform. More...
	setObjType (string $obj_type)
	Sets the object type of the current context. More...
	getObjType ()
	Returns the object type of the current context. More...
	setObjId (int $obj_id)
	Sets the object id of the current context. More...
	getObjId ()
	Returns the object id of the current context. More...

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 Interface ilCtrlContextInterface holds the current ilCtrl context information.

Author

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

Definition at line 25 of file interface.ilCtrlContextInterface.php.

Member Function Documentation

getBaseClass()

ilCtrlContextInterface::getBaseClass

(

)

Returns the baseclass the current context.

Returns

string|null

Implemented in ilCtrlContext.

getCmd()

ilCtrlContextInterface::getCmd

(

)

Returns the command which the current command- or baseclass should perform.

Returns

string|null

Implemented in ilCtrlContext.

getCmdClass()

ilCtrlContextInterface::getCmdClass

(

)

Returns the command class of this context.

Returns

string|null

Implemented in ilCtrlContext.

getCmdMode()

ilCtrlContextInterface::getCmdMode

(

)

Returns the command mode of the current context.

Returns

string|null

Implemented in ilCtrlContext.

getObjId()

ilCtrlContextInterface::getObjId

(

)

Returns the object id of the current context.

Returns

int|null

Implemented in ilCtrlContext.

getObjType()

ilCtrlContextInterface::getObjType

(

)

Returns the object type of the current context.

Returns

string|null

Implemented in ilCtrlContext.

getPath()

ilCtrlContextInterface::getPath

(

)

Returns the path of this context.

Returns

ilCtrlPathInterface

Implemented in ilCtrlContext.

Referenced by ilCtrlAbstractPath\getPathToRelatedClassInContext().

Here is the caller graph for this function:

getRedirectSource()

ilCtrlContextInterface::getRedirectSource

(

)

Returns where the request of this context was redirected from.

Returns

string|null

Implemented in ilCtrlContext.

getTargetScript()

ilCtrlContextInterface::getTargetScript

(

)

Returns the target script of this context.

Returns

string

Implemented in ilCtrlContext.

isAsync()

ilCtrlContextInterface::isAsync

(

)

Returns whether this context is asynchronous or not.

Returns

bool

Implemented in ilCtrlContext.

setBaseClass()

ilCtrlContextInterface::setBaseClass

(

string

$base_class

)

Sets the baseclass of the current context.

Parameters

string

$base_class

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

setCmd()

ilCtrlContextInterface::setCmd

(

?string

$cmd

)

Sets the command which the current command- or baseclass should perform.

Parameters

string | null

$cmd

Returns

self

Implemented in ilCtrlContext.

setCmdClass()

ilCtrlContextInterface::setCmdClass

(

?string

$cmd_class

)

Sets the current contexts command class.

Parameters

string | null

$cmd_class

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

setCmdMode()

ilCtrlContextInterface::setCmdMode

(

string

$mode

)

Sets the command mode of the current context.

Parameters

string

$mode

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

setObjId()

ilCtrlContextInterface::setObjId

(

int

$obj_id

)

Sets the object id of the current context.

Parameters

int

$obj_id

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

setObjType()

ilCtrlContextInterface::setObjType

(

string

$obj_type

)

Sets the object type of the current context.

Parameters

string

$obj_type

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

setTargetScript()

ilCtrlContextInterface::setTargetScript

(

string

$target_script

)

Sets the target script of this context (usually ilias.php).

Parameters

string

$target_script

Returns

ilCtrlContextInterface

Implemented in ilCtrlContext.

---

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

• components/ILIAS/UICore/interfaces/interface.ilCtrlContextInterface.php