Inheritance diagram for ilCtrlStructureInterface:

Collaboration diagram for ilCtrlStructureInterface:

Public Member Functions
	isBaseClass (string $class_name)
	Returns whether the given class is registered as a valid baseclass (module or service class) in the database. More...

	getObjNameByCid (string $cid)
	Returns the qualified object name of a class for the given CID, which can be used to instantiate the object. More...

	getObjNameByName (string $class_name)
	Returns the qualified object name of a given class, which can be used to instantiate the object. More...

	getClassNameByCid (string $cid)
	Returns the lower-cased name of a class for the given CID. More...

	getClassCidByName (string $class_name)
	Returns the CID of the given classname. More...

	getRelativePathByName (string $class_name)
	Returns the absolute path of a class for the given name. More...

	getRelativePathByCid (string $cid)
	Returns the absolute path of a class for the given CID. More...

	getChildrenByCid (string $cid)
	Returns all classes that can be called by a class for the given CID. More...

	getChildrenByName (string $class_name)
	Returns all classes that can be called by the given class. More...

	getParentsByCid (string $cid)
	Returns all classes that can call a class for the given CID. More...

	getParentsByName (string $class_name)
	Returns all classes that can call the given class. More...

	setPermanentParameterByClass (string $class_name, string $parameter_name)
	Saves a parameter for the given class, that should be fetched with every request including it. More...

	removePermanentParametersByClass (string $class_name)
	Removes all permanent parameters for the given class. More...

	getPermanentParametersByClass (string $class_name)
	Returns all permanent parameters for the given class. More...

	setTemporaryParameterByClass (string $class_name, string $parameter_name, $value)
	Sets a parameter => value pair for the given class which will be appended for the next request. More...

	removeTemporaryParametersByClass (string $class_name)
	Removes all temporarily set parameter => value pairs for the given class. More...

	getTemporaryParametersByClass (string $class_name)
	Returns all temporary parameters currently set for a given class. More...

	removeSingleParameterByClass (string $class_name, string $parameter_name)
	Removes a specific permanent or temporary parameter for the given class. More...

	setReturnTargetByClass (string $class_name, string $target_url)
	Sets a target URL for the given class in order to reach it. More...

	getReturnTargetByClass (string $class_name)
	Returns a target URL for the given class in order to reach it. More...

	getUnsafeCommandsByCid (string $cid)
	Returns all unsafe GET commands for a given cid. More...

	getUnsafeCommandsByName (string $class_name)
	Returns all unsafe GET commands for a given classname. More...

	getSafeCommandsByCid (string $cid)
	Returns all safe POST commands for a given cid. More...

	getSafeCommandsByName (string $class_name)
	Returns all safe POST commands for a given classname. More...

Data Fields
const	KEY_CLASS_CID = 'cid'
	array key constants that are used for certain information. More...

const	KEY_CLASS_PATH = 'class_path'

const	KEY_CLASS_NAME = 'class_name'

const	KEY_CLASS_CID_PATHS = 'cid_paths'

const	KEY_CLASS_PARENTS = 'parents'

const	KEY_CLASS_CHILDREN = 'children'

const	KEY_UNSAFE_COMMANDS = 'unsafe_commands'

const	KEY_SAFE_COMMANDS = 'safe_commands'

Detailed Description

ilCtrlStructureInterface

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

Definition at line 10 of file interface.ilCtrlStructureInterface.php.

Member Function Documentation

◆ getChildrenByCid()

ilCtrlStructureInterface::getChildrenByCid ( string $cid )

Returns all classes that can be called by a class for the given CID.

Parameters

string $cid

Returns: array

Implemented in ilCtrlStructure.

◆ getChildrenByName()

ilCtrlStructureInterface::getChildrenByName ( string $class_name )

Returns all classes that can be called by the given class.

Parameters

string $class_name

Returns: array

Implemented in ilCtrlStructure.

◆ getClassCidByName()

ilCtrlStructureInterface::getClassCidByName ( string $class_name )

Returns the CID of the given classname.

Parameters

string $class_name

Returns: string|null

Implemented in ilCtrlStructure.

◆ getClassNameByCid()

ilCtrlStructureInterface::getClassNameByCid ( string $cid )

Returns the lower-cased name of a class for the given CID.

Parameters

string $cid

Returns: string|null

Implemented in ilCtrlStructure.

◆ getObjNameByCid()

ilCtrlStructureInterface::getObjNameByCid ( string $cid )

Returns the qualified object name of a class for the given CID, which can be used to instantiate the object.

Parameters

string $cid

Returns: string|null

Implemented in ilCtrlStructure.

◆ getObjNameByName()

ilCtrlStructureInterface::getObjNameByName ( string $class_name )

Returns the qualified object name of a given class, which can be used to instantiate the object.

Parameters

string $class_name

Returns: string|null

Implemented in ilCtrlStructure.

◆ getParentsByCid()

ilCtrlStructureInterface::getParentsByCid ( string $cid )

Returns all classes that can call a class for the given CID.

Parameters

string $cid

Returns: array

Implemented in ilCtrlStructure.

◆ getParentsByName()

ilCtrlStructureInterface::getParentsByName ( string $class_name )

Returns all classes that can call the given class.

Parameters

string $class_name

Returns: array

Implemented in ilCtrlStructure.

◆ getPermanentParametersByClass()

ilCtrlStructureInterface::getPermanentParametersByClass ( string $class_name )

Returns all permanent parameters for the given class.

Parameters

string $class_name

Returns: array|null

Implemented in ilCtrlStructure.

◆ getRelativePathByCid()

ilCtrlStructureInterface::getRelativePathByCid ( string $cid )

Returns the absolute path of a class for the given CID.

Parameters

string $cid

Returns: string|null

Implemented in ilCtrlStructure.

◆ getRelativePathByName()

ilCtrlStructureInterface::getRelativePathByName ( string $class_name )

Returns the absolute path of a class for the given name.

Parameters

string $class_name

Returns: string|null

Implemented in ilCtrlStructure.

◆ getReturnTargetByClass()

ilCtrlStructureInterface::getReturnTargetByClass ( string $class_name )

Returns a target URL for the given class in order to reach it.

Parameters

string $class_name

Returns: string|null

Implemented in ilCtrlStructure.

◆ getSafeCommandsByCid()

ilCtrlStructureInterface::getSafeCommandsByCid ( string $cid )

Returns all safe POST commands for a given cid.

Parameters

string $cid

Returns: array

Implemented in ilCtrlStructure.

◆ getSafeCommandsByName()

ilCtrlStructureInterface::getSafeCommandsByName ( string $class_name )

Returns all safe POST commands for a given classname.

Parameters

string $class_name

Returns: array

Implemented in ilCtrlStructure.

◆ getTemporaryParametersByClass()

ilCtrlStructureInterface::getTemporaryParametersByClass ( string $class_name )

Returns all temporary parameters currently set for a given class.

Parameters

string $class_name

Returns: array|null

Implemented in ilCtrlStructure.

◆ getUnsafeCommandsByCid()

ilCtrlStructureInterface::getUnsafeCommandsByCid ( string $cid )

Returns all unsafe GET commands for a given cid.

Parameters

string $cid

Returns: array

Implemented in ilCtrlStructure.

◆ getUnsafeCommandsByName()

ilCtrlStructureInterface::getUnsafeCommandsByName ( string $class_name )

Returns all unsafe GET commands for a given classname.

Parameters

string $class_name

Returns: array

Implemented in ilCtrlStructure.

◆ isBaseClass()

ilCtrlStructureInterface::isBaseClass ( string $class_name )

Returns whether the given class is registered as a valid baseclass (module or service class) in the database.

Parameters

string $class_name

Returns: bool

Implemented in ilCtrlStructure.

◆ removePermanentParametersByClass()

ilCtrlStructureInterface::removePermanentParametersByClass ( string $class_name )

Removes all permanent parameters for the given class.

Parameters

string $class_name

Implemented in ilCtrlStructure.

◆ removeSingleParameterByClass()

ilCtrlStructureInterface::removeSingleParameterByClass	(	string	$class_name,
		string	$parameter_name
	)

Removes a specific permanent or temporary parameter for the given class.

Parameters

string	$class_name
string	$parameter_name

Implemented in ilCtrlStructure.

◆ removeTemporaryParametersByClass()

ilCtrlStructureInterface::removeTemporaryParametersByClass ( string $class_name )

Removes all temporarily set parameter => value pairs for the given class.

Parameters

string $class_name

Implemented in ilCtrlStructure.

◆ setPermanentParameterByClass()

ilCtrlStructureInterface::setPermanentParameterByClass	(	string	$class_name,
		string	$parameter_name
	)

Saves a parameter for the given class, that should be fetched with every request including it.

Parameters

string	$class_name
string	$parameter_name

Exceptions

ilCtrlException if an invalid parameter name is provided.

Implemented in ilCtrlStructure.

◆ setReturnTargetByClass()

ilCtrlStructureInterface::setReturnTargetByClass	(	string	$class_name,
		string	$target_url
	)

Sets a target URL for the given class in order to reach it.

Parameters

string	$class_name
string	$target_url

Implemented in ilCtrlStructure.

◆ setTemporaryParameterByClass()

ilCtrlStructureInterface::setTemporaryParameterByClass	(	string	$class_name,
		string	$parameter_name,
			$value
	)

Sets a parameter => value pair for the given class which will be appended for the next request.

Parameters

string	$class_name
string	$parameter_name
mixed	$value

Exceptions

ilCtrlException if an invalid parameter name is provided.

Implemented in ilCtrlStructure.

Field Documentation

◆ KEY_CLASS_CHILDREN

const ilCtrlStructureInterface::KEY_CLASS_CHILDREN = 'children'

Definition at line 20 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlStructureHelper\filterUnnecessaryEntries(), ilCtrlStructureMapper\mapStructure(), ilCtrlStructureReader\readStructure(), ilCtrlStructureTest\testStructureCtrlInfos(), ilCtrlStructureHelperTest\testStructureHelperUnnecessaryEntryFilter(), ilCtrlStructureMapperTest\testStructureMapperReferenceListIndexesAfterInvalidReferenceIsRemoved(), ilCtrlStructureMapperTest\testStructureMapperWithMissingReferenceLists(), ilCtrlStructureMapperTest\testStructureMapperWithMixedArray(), and ilCtrlStructureMapperTest\testStructureMapperWithStructureArray().

◆ KEY_CLASS_CID

const ilCtrlStructureInterface::KEY_CLASS_CID = 'cid'

array key constants that are used for certain information.

Definition at line 15 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlStructureReader\readStructure(), ilCtrlStructureTest\testStructureBaseClasses(), ilCtrlStructureTest\testStructureCtrlInfos(), and ilCtrlStructureTest\testStructureSecurityInfos().

◆ KEY_CLASS_CID_PATHS

const ilCtrlStructureInterface::KEY_CLASS_CID_PATHS = 'cid_paths'

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

◆ KEY_CLASS_NAME

const ilCtrlStructureInterface::KEY_CLASS_NAME = 'class_name'

Definition at line 17 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlStructureReader\readStructure(), ilCtrlStructureTest\testStructureCtrlInfos(), and ilCtrlStructureTest\testStructureSecurityInfos().

◆ KEY_CLASS_PARENTS

const ilCtrlStructureInterface::KEY_CLASS_PARENTS = 'parents'

Definition at line 19 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlStructureHelper\filterUnnecessaryEntries(), ilCtrlStructureMapper\mapStructure(), ilCtrlStructureReader\readStructure(), ilCtrlStructureTest\testStructureCtrlInfos(), ilCtrlStructureHelperTest\testStructureHelperUnnecessaryEntryFilter(), ilCtrlStructureMapperTest\testStructureMapperReferenceListIndexesAfterInvalidReferenceIsRemoved(), ilCtrlStructureMapperTest\testStructureMapperWithInvalidReferenceInList(), ilCtrlStructureMapperTest\testStructureMapperWithMissingReferenceLists(), ilCtrlStructureMapperTest\testStructureMapperWithMixedArray(), and ilCtrlStructureMapperTest\testStructureMapperWithStructureArray().

◆ KEY_CLASS_PATH

const ilCtrlStructureInterface::KEY_CLASS_PATH = 'class_path'

Definition at line 16 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlStructureReader\readStructure(), and ilCtrlStructureTest\testStructureCtrlInfos().

◆ KEY_SAFE_COMMANDS

const ilCtrlStructureInterface::KEY_SAFE_COMMANDS = 'safe_commands'

Definition at line 22 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlSecurityArtifactObjective\getArtifactPath(), and ilCtrlStructureTest\testStructureSecurityInfos().

◆ KEY_UNSAFE_COMMANDS

const ilCtrlStructureInterface::KEY_UNSAFE_COMMANDS = 'unsafe_commands'

Definition at line 21 of file interface.ilCtrlStructureInterface.php.

Referenced by ilCtrlSecurityArtifactObjective\getArtifactPath(), and ilCtrlStructureTest\testStructureSecurityInfos().

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

Services/UICore/interfaces/interface.ilCtrlStructureInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getChildrenByCid()

◆ getChildrenByName()

◆ getClassCidByName()

◆ getClassNameByCid()

◆ getObjNameByCid()

◆ getObjNameByName()

◆ getParentsByCid()

◆ getParentsByName()

◆ getPermanentParametersByClass()

◆ getRelativePathByCid()

◆ getRelativePathByName()

◆ getReturnTargetByClass()

◆ getSafeCommandsByCid()

◆ getSafeCommandsByName()

◆ getTemporaryParametersByClass()

◆ getUnsafeCommandsByCid()

◆ getUnsafeCommandsByName()

◆ isBaseClass()

◆ removePermanentParametersByClass()

◆ removeSingleParameterByClass()

◆ removeTemporaryParametersByClass()

◆ setPermanentParameterByClass()

◆ setReturnTargetByClass()

◆ setTemporaryParameterByClass()

Field Documentation

◆ KEY_CLASS_CHILDREN

◆ KEY_CLASS_CID

◆ KEY_CLASS_CID_PATHS

◆ KEY_CLASS_NAME

◆ KEY_CLASS_PARENTS

◆ KEY_CLASS_PATH

◆ KEY_SAFE_COMMANDS

◆ KEY_UNSAFE_COMMANDS