Class ilCtrlStructure holds the currently read control structure. More...

Inheritance diagram for ilCtrlStructure:

Collaboration diagram for ilCtrlStructure:

Public Member Functions
	__construct (array $ctrl_structure, array $base_classes, array $security_info)
	ilCtrlStructure Constructor More...

	isBaseClass (string $class_name)
	@inheritDoc More...

	getObjNameByCid (string $cid)
	@inheritDoc More...

	getObjNameByName (string $class_name)
	@inheritDoc More...

	getClassNameByCid (string $cid)
	@inheritDoc More...

	getClassCidByName (string $class_name)
	@inheritDoc More...

	getRelativePathByName (string $class_name)
	@inheritDoc More...

	getRelativePathByCid (string $cid)
	@inheritDoc More...

	getChildrenByCid (string $cid)
	@inheritDoc More...

	getChildrenByName (string $class_name)
	@inheritDoc More...

	getParentsByCid (string $cid)
	@inheritDoc More...

	getParentsByName (string $class_name)
	@inheritDoc More...

	setPermanentParameterByClass (string $class_name, string $parameter_name)
	@inheritDoc More...

	removePermanentParametersByClass (string $class_name)
	@inheritDoc More...

	getPermanentParametersByClass (string $class_name)
	@inheritDoc More...

	setTemporaryParameterByClass (string $class_name, string $parameter_name, $value)
	@inheritDoc More...

	removeTemporaryParametersByClass (string $class_name)
	@inheritDoc More...

	getTemporaryParametersByClass (string $class_name)
	@inheritDoc More...

	removeSingleParameterByClass (string $class_name, string $parameter_name)
	@inheritDoc More...

	setReturnTargetByClass (string $class_name, string $target_url)
	@inheritDoc More...

	getReturnTargetByClass (string $class_name)
	@inheritDoc More...

	getUnsafeCommandsByCid (string $cid)
	@inheritDoc More...

	getUnsafeCommandsByName (string $class_name)
	@inheritDoc More...

	getSafeCommandsByCid (string $cid)
	@inheritDoc More...

	getSafeCommandsByName (string $class_name)
	@inheritDoc More...

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

Private Member Functions
	getValueForKeyByCid (string $identifier_key, string $cid)
	Returns a stored structure value of the given key from the corresponding class mapped by CID. More...

	getValueForKeyByName (string $identifier_key, string $class_name)
	Returns a stored structure value of the given key from the corresponding class mapped by name. More...

	lowercase (string $string)
	Helper function to lowercase strings. More...

Private Attributes
const	PARAM_NAME_REGEX = '/^[A-Za-z0-9_-]*$/'

array	$temporary_parameters = []

array	$permanent_parameters = []

array	$return_targets = []

array	$structure

array	$base_classes

array	$security

array	$mapped_structure = []

Additional Inherited Members
Data Fields inherited from ilCtrlStructureInterface
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

Class ilCtrlStructure holds the currently read control structure.

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

Definition at line 12 of file class.ilCtrlStructure.php.

Constructor & Destructor Documentation

◆ __construct()

ilCtrlStructure::__construct	(	array	$ctrl_structure,
		array	$base_classes,
		array	$security_info
	)

ilCtrlStructure Constructor

Parameters

array	$ctrl_structure
array	$base_classes
array	$security_info

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

      {
        $this->base_classes = $base_classes;
        $this->security = $security_info;
        $this->structure = $ctrl_structure;
    }

References $base_classes.

Member Function Documentation

◆ getChildrenByCid()

ilCtrlStructure::getChildrenByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 149 of file class.ilCtrlStructure.php.

                                                 : ?array
    {
        $children = $this->getValueForKeyByCid(self::KEY_CLASS_CHILDREN, $cid);
        if (empty($children)) {
            return null;
        }
 
        return $children;
    }

References getValueForKeyByCid().

Here is the call graph for this function:

◆ getChildrenByName()

ilCtrlStructure::getChildrenByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 162 of file class.ilCtrlStructure.php.

                                                         : ?array
    {
        $children = $this->getValueForKeyByName(self::KEY_CLASS_CHILDREN, $class_name);
        if (empty($children)) {
            return null;
        }
 
        return $children;
    }

References getValueForKeyByName().

Here is the call graph for this function:

◆ getClassCidByName()

ilCtrlStructure::getClassCidByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

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

                                                         : ?string
    {
        return $this->getValueForKeyByName(self::KEY_CLASS_CID, $class_name);
    }

References getValueForKeyByName().

Referenced by isBaseClass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassNameByCid()

ilCtrlStructure::getClassNameByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 112 of file class.ilCtrlStructure.php.

                                                  : ?string
    {
        $class_name = $this->getValueForKeyByCid(
            self::KEY_CLASS_NAME,
            $cid
        );
 
        return (null !== $class_name) ? $this->lowercase($class_name) : null;
    }

References getValueForKeyByCid(), and lowercase().

Referenced by getSafeCommandsByCid(), and getUnsafeCommandsByCid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjNameByCid()

ilCtrlStructure::getObjNameByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 96 of file class.ilCtrlStructure.php.

                                                : ?string
    {
        return $this->getValueForKeyByCid(self::KEY_CLASS_NAME, $cid);
    }

References getValueForKeyByCid().

Here is the call graph for this function:

◆ getObjNameByName()

ilCtrlStructure::getObjNameByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 104 of file class.ilCtrlStructure.php.

                                                        : ?string
    {
        return $this->getValueForKeyByName(self::KEY_CLASS_NAME, $class_name);
    }

References getValueForKeyByName().

Here is the call graph for this function:

◆ getParentsByCid()

ilCtrlStructure::getParentsByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 175 of file class.ilCtrlStructure.php.

                                                : ?array
    {
        $parents = $this->getValueForKeyByCid(self::KEY_CLASS_PARENTS, $cid);
        if (empty($parents)) {
            return null;
        }
 
        return $parents;
    }

References getValueForKeyByCid().

Here is the call graph for this function:

◆ getParentsByName()

ilCtrlStructure::getParentsByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

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

                                                        : ?array
    {
        $parents = $this->getValueForKeyByName(self::KEY_CLASS_PARENTS, $class_name);
        if (empty($parents)) {
            return null;
        }
 
        return $parents;
    }

References getValueForKeyByName().

Here is the call graph for this function:

◆ getPermanentParametersByClass()

ilCtrlStructure::getPermanentParametersByClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 228 of file class.ilCtrlStructure.php.

                                                                     : ?array
    {
        return $this->permanent_parameters[$this->lowercase($class_name)] ?? null;
    }

References lowercase().

Here is the call graph for this function:

◆ getRelativePathByCid()

ilCtrlStructure::getRelativePathByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 141 of file class.ilCtrlStructure.php.

                                                     : ?string
    {
        return $this->getValueForKeyByCid(self::KEY_CLASS_PATH, $cid);
    }

References getValueForKeyByCid().

Here is the call graph for this function:

◆ getRelativePathByName()

ilCtrlStructure::getRelativePathByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 133 of file class.ilCtrlStructure.php.

                                                             : ?string
    {
        return $this->getValueForKeyByName(self::KEY_CLASS_PATH, $class_name);
    }

References getValueForKeyByName().

Here is the call graph for this function:

◆ getReturnTargetByClass()

ilCtrlStructure::getReturnTargetByClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 305 of file class.ilCtrlStructure.php.

                                                              : ?string
    {
        return $this->return_targets[$this->lowercase($class_name)] ?? null;
    }

References lowercase().

Here is the call graph for this function:

◆ getSafeCommandsByCid()

ilCtrlStructure::getSafeCommandsByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 334 of file class.ilCtrlStructure.php.

                                                     : array
    {
        $class_name = $this->getClassNameByCid($cid);
        if (null !== $class_name) {
            return $this->getSafeCommandsByName($class_name);
        }
 
        return [];
    }

References getClassNameByCid(), and getSafeCommandsByName().

Here is the call graph for this function:

◆ getSafeCommandsByName()

ilCtrlStructure::getSafeCommandsByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 347 of file class.ilCtrlStructure.php.

                                                             : array
    {
        return $this->security[$this->lowercase($class_name)][self::KEY_SAFE_COMMANDS] ?? [];
    }

References ilCtrlStructureInterface\KEY_SAFE_COMMANDS, and lowercase().

Referenced by getSafeCommandsByCid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemporaryParametersByClass()

ilCtrlStructure::getTemporaryParametersByClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 259 of file class.ilCtrlStructure.php.

                                                                     : ?array
    {
        return $this->temporary_parameters[$this->lowercase($class_name)] ?? null;
    }

References lowercase().

Here is the call graph for this function:

◆ getUnsafeCommandsByCid()

ilCtrlStructure::getUnsafeCommandsByCid ( string $cid )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 313 of file class.ilCtrlStructure.php.

                                                       : array
    {
        $class_name = $this->getClassNameByCid($cid);
        if (null !== $class_name) {
            return $this->getUnsafeCommandsByName($class_name);
        }
 
        return [];
    }

References getClassNameByCid(), and getUnsafeCommandsByName().

Here is the call graph for this function:

◆ getUnsafeCommandsByName()

ilCtrlStructure::getUnsafeCommandsByName ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 326 of file class.ilCtrlStructure.php.

                                                               : array
    {
        return $this->security[$this->lowercase($class_name)][self::KEY_UNSAFE_COMMANDS] ?? [];
    }

References ilCtrlStructureInterface\KEY_UNSAFE_COMMANDS, and lowercase().

Referenced by getUnsafeCommandsByCid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueForKeyByCid()

ilCtrlStructure::getValueForKeyByCid	(	string	$identifier_key,
		string	$cid
	)

private

Returns a stored structure value of the given key from the corresponding class mapped by CID.

Parameters

string	$identifier_key
string	$cid

Returns: array|string|null

Definition at line 359 of file class.ilCtrlStructure.php.

    {
        if (isset($this->mapped_structure[$cid][$identifier_key])) {
            return $this->mapped_structure[$cid][$identifier_key];
        }
 
        foreach ($this->structure as $class_info) {
            if (isset($class_info[$identifier_key]) && $class_info[self::KEY_CLASS_CID] === $cid) {
                $this->mapped_structure[$cid] = $class_info;
                return $class_info[$identifier_key];
            }
        }
 
        return null;
    }

Referenced by getChildrenByCid(), getClassNameByCid(), getObjNameByCid(), getParentsByCid(), and getRelativePathByCid().

Here is the caller graph for this function:

◆ getValueForKeyByName()

ilCtrlStructure::getValueForKeyByName	(	string	$identifier_key,
		string	$class_name
	)

private

Returns a stored structure value of the given key from the corresponding class mapped by name.

Parameters

string	$identifier_key
string	$class_name

Returns: array|string|null

Definition at line 382 of file class.ilCtrlStructure.php.

    {
        $class_name = $this->lowercase($class_name);
        if (isset($this->structure[$class_name])) {
            return $this->structure[$class_name][$identifier_key];
        }
 
        return null;
    }

References lowercase().

Referenced by getChildrenByName(), getClassCidByName(), getObjNameByName(), getParentsByName(), and getRelativePathByName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isBaseClass()

ilCtrlStructure::isBaseClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 84 of file class.ilCtrlStructure.php.

                                                   : bool
    {
        // baseclass must be contained within the current structure
        // and within the current baseclass array.
        return
            null !== $this->getClassCidByName($class_name) &&
            in_array($this->lowercase($class_name), $this->base_classes, true);
    }

References getClassCidByName(), and lowercase().

Here is the call graph for this function:

◆ lowercase()

ilCtrlStructure::lowercase ( string $string )

private

Helper function to lowercase strings.

Parameters

string $string

Returns: string

Definition at line 397 of file class.ilCtrlStructure.php.

                                              : string
    {
        return strtolower($string);
    }

Referenced by getClassNameByCid(), getPermanentParametersByClass(), getReturnTargetByClass(), getSafeCommandsByName(), getTemporaryParametersByClass(), getUnsafeCommandsByName(), getValueForKeyByName(), isBaseClass(), removePermanentParametersByClass(), removeSingleParameterByClass(), removeTemporaryParametersByClass(), setPermanentParameterByClass(), setReturnTargetByClass(), and setTemporaryParameterByClass().

Here is the caller graph for this function:

◆ removePermanentParametersByClass()

ilCtrlStructure::removePermanentParametersByClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 217 of file class.ilCtrlStructure.php.

                                                                        : void
    {
        $class_name = $this->lowercase($class_name);
        if (isset($this->permanent_parameters[$class_name])) {
            unset($this->permanent_parameters[$class_name]);
        }
    }

References lowercase().

Here is the call graph for this function:

◆ removeSingleParameterByClass()

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

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 267 of file class.ilCtrlStructure.php.

                                                                                            : void
    {
        $class_name = $this->lowercase($class_name);
 
        // permanent parameters are lists of parameter names
        // mapped to the classname, therefore the index is
        // unknown and has to be figured out.
        if (!empty($this->permanent_parameters[$class_name])) {
            foreach ($this->permanent_parameters[$class_name] as $index => $permanent_parameter) {
                if ($parameter_name === $permanent_parameter) {
                    unset($this->permanent_parameters[$class_name][$index]);
 
                    // reindex the array values.
                    $permanent_parameters = &$this->permanent_parameters[$class_name];
                    $permanent_parameters = array_values($permanent_parameters);
                }
            }
        }
 
        // the temporary parameters are key => value pairs mapped
        // to the classname, whereas key is the parameter name.
        // The index is therefore known and can be unset directly.
        if (isset($this->temporary_parameters[$class_name])) {
            unset($this->temporary_parameters[$class_name][$parameter_name]);
        }
    }

References $index, $permanent_parameters, and lowercase().

Here is the call graph for this function:

◆ removeTemporaryParametersByClass()

ilCtrlStructure::removeTemporaryParametersByClass ( string $class_name )

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 248 of file class.ilCtrlStructure.php.

                                                                        : void
    {
        $class_name = $this->lowercase($class_name);
        if (isset($this->temporary_parameters[$class_name])) {
            unset($this->temporary_parameters[$class_name]);
        }
    }

References lowercase().

Here is the call graph for this function:

◆ setPermanentParameterByClass()

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

@inheritDoc

Implements ilCtrlStructureInterface.

Definition at line 201 of file class.ilCtrlStructure.php.

                                                                                            : void
    {
        if (in_array($parameter_name, ilCtrlInterface::PROTECTED_PARAMETERS, true)) {
            throw new ilCtrlException("Parameter '$parameter_name' must not be saved, it could mess with the control flow.");
        }
 
        if (!preg_match(self::PARAM_NAME_REGEX, $parameter_name)) {
            throw new ilCtrlException("Cannot save parameter '$parameter_name', as it contains invalid characters.");
        }
 
        $this->permanent_parameters[$this->lowercase($class_name)][] = $parameter_name;
    }

References lowercase(), and ilCtrlInterface\PROTECTED_PARAMETERS.

Here is the call graph for this function:

◆ setReturnTargetByClass()

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

@inheritDoc

Implements ilCtrlStructureInterface.

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

                                                                                  : void
    {
        $this->return_targets[$this->lowercase($class_name)] = $target_url;
    }

References lowercase().

Here is the call graph for this function:

◆ setTemporaryParameterByClass()

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

@inheritDoc

Implements ilCtrlStructureInterface.

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

                                                                                                    : void
    {
        if (!preg_match(self::PARAM_NAME_REGEX, $parameter_name)) {
            throw new ilCtrlException("Cannot save parameter '$parameter_name', as it contains invalid characters.");
        }
 
        $this->temporary_parameters[$this->lowercase($class_name)][$parameter_name] = $value;
    }

References lowercase().

Here is the call graph for this function:

Field Documentation

◆ $base_classes

array ilCtrlStructure::$base_classes

private

Definition at line 50 of file class.ilCtrlStructure.php.

Referenced by __construct().

◆ $mapped_structure

array ilCtrlStructure::$mapped_structure = []

private

Definition at line 63 of file class.ilCtrlStructure.php.

◆ $permanent_parameters

array ilCtrlStructure::$permanent_parameters = []

private

Definition at line 32 of file class.ilCtrlStructure.php.

Referenced by removeSingleParameterByClass().

◆ $return_targets

array ilCtrlStructure::$return_targets = []

private

Definition at line 38 of file class.ilCtrlStructure.php.

◆ $security

array ilCtrlStructure::$security

private

Definition at line 56 of file class.ilCtrlStructure.php.

◆ $structure

array ilCtrlStructure::$structure

private

Definition at line 44 of file class.ilCtrlStructure.php.

◆ $temporary_parameters

array ilCtrlStructure::$temporary_parameters = []

private

Definition at line 25 of file class.ilCtrlStructure.php.

◆ PARAM_NAME_REGEX

const ilCtrlStructure::PARAM_NAME_REGEX = '/^[A-Za-z0-9_-]*$/'

private

Definition at line 18 of file class.ilCtrlStructure.php.

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

Services/UICore/classes/Structure/class.ilCtrlStructure.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildrenByCid()

◆ getChildrenByName()

◆ getClassCidByName()

◆ getClassNameByCid()

◆ getObjNameByCid()

◆ getObjNameByName()

◆ getParentsByCid()

◆ getParentsByName()

◆ getPermanentParametersByClass()

◆ getRelativePathByCid()

◆ getRelativePathByName()

◆ getReturnTargetByClass()

◆ getSafeCommandsByCid()

◆ getSafeCommandsByName()

◆ getTemporaryParametersByClass()

◆ getUnsafeCommandsByCid()

◆ getUnsafeCommandsByName()

◆ getValueForKeyByCid()

◆ getValueForKeyByName()

◆ isBaseClass()

◆ lowercase()

◆ removePermanentParametersByClass()

◆ removeSingleParameterByClass()

◆ removeTemporaryParametersByClass()

◆ setPermanentParameterByClass()

◆ setReturnTargetByClass()

◆ setTemporaryParameterByClass()

Field Documentation

◆ $base_classes

◆ $mapped_structure

◆ $permanent_parameters

◆ $return_targets

◆ $security

◆ $structure

◆ $temporary_parameters

◆ PARAM_NAME_REGEX