ilCtrlPathInterface Interface Reference

Interface ilCtrlPathInterface is responsible for holding and manipulating a valid ilCtrl class-path (abbreviated by CID). More...

Inheritance diagram for ilCtrlPathInterface:

Collaboration diagram for ilCtrlPathInterface:

Public Member Functions
	getCidPath ()
	Returns the CID path for the target class of the current instance. More...
	getCurrentCid ()
	Returns the CID that must currently be processed. More...
	getNextCid (string $current_class)
	Returns the next CID that must be processed. More...
	getCidPaths (int $order=SORT_DESC)
	Returns all individual paths for each cid position for the given direction. More...
	getCidArray (int $order=SORT_DESC)
	Returns all cid's from the current path in the provided directory/order. More...
	getBaseClass ()
	Returns the baseclass of the current cid path. More...
	getException ()
	Returns the exception produced during the path-finding- process. More...

Data Fields
const	CID_PATH_SEPARATOR = ':'

Detailed Description

Interface ilCtrlPathInterface is responsible for holding and manipulating a valid ilCtrl class-path (abbreviated by CID).

Author

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

A CID-path or class-path is a

Definition at line 13 of file interface.ilCtrlPathInterface.php.

Member Function Documentation

getBaseClass()

ilCtrlPathInterface::getBaseClass

(

)

Returns the baseclass of the current cid path.

Returns

string|null

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

getCidArray()

ilCtrlPathInterface::getCidArray

(

int

$order = SORT_DESC

)

Returns all cid's from the current path in the provided directory/order.

ASC => from baseclass to command class. DESC => from command class to baseclass.

Parameters

int

$order

(SORT_DESC|SORT_ASC)

Returns

string[]

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

getCidPath()

ilCtrlPathInterface::getCidPath

(

)

Returns the CID path for the target class of the current instance.

Null is returned when there's no valid path.

Returns

string|null

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

Referenced by ilCtrlContext\setBaseClass(), and ilCtrlContext\setCmdClass().

Here is the caller graph for this function:

getCidPaths()

ilCtrlPathInterface::getCidPaths

(

int

$order = SORT_DESC

)

Returns all individual paths for each cid position for the given direction.

For example, trace 'cid1:cid2:cid3' it would return: array( 'cid1', 'cid1:cid2', 'cid1:cid2:cid3', ... );

ASC => from baseclass to command class. DESC => from command class to baseclass.

Parameters

int

$order

(SORT_DESC|SORT_ASC)

Returns

string[]

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

getCurrentCid()

ilCtrlPathInterface::getCurrentCid

(

)

Returns the CID that must currently be processed.

Returns

string|null

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

getException()

ilCtrlPathInterface::getException

(

)

Returns the exception produced during the path-finding- process.

Returns

ilCtrlException|null

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

getNextCid()

ilCtrlPathInterface::getNextCid

(

string

$current_class

)

Returns the next CID that must be processed.

Parameters

string

$current_class

Returns

string|null

Implemented in ilCtrlAbstractPath, and ilCtrlNullPath.

Field Documentation

CID_PATH_SEPARATOR

const ilCtrlPathInterface::CID_PATH_SEPARATOR = ':'

Definition at line 18 of file interface.ilCtrlPathInterface.php.

---

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

• Services/UICore/interfaces/interface.ilCtrlPathInterface.php