Inheritance diagram for ilCtrlArrayClassPath:

Collaboration diagram for ilCtrlArrayClassPath:

Public Member Functions
	__construct (ilCtrlStructureInterface $structure, ilCtrlContextInterface $context, array $target_classes)
	ilCtrlArrayClassPath Constructor More...

Public Member Functions inherited from ilCtrlAbstractPath
	__construct (ilCtrlStructureInterface $structure)
	ilCtrlAbstractPath Constructor More...

	getCidPath ()
	@inheritDoc More...

	getCurrentCid ()
	@inheritDoc More...

	getNextCid (string $current_class)
	@inheritDoc More...

	getCidPaths (int $order=SORT_DESC)
	@inheritDoc More...

	getCidArray (int $order=SORT_DESC)
	@inheritDoc More...

	getBaseClass ()
	@inheritDoc More...

	getException ()
	@inheritDoc More...

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

Private Member Functions
	getCidPathByArray (array $target_classes)
	Generates a cid path from the given class array. More...

Private Attributes
ilCtrlContextInterface	$context

Additional Inherited Members
Data Fields inherited from ilCtrlPathInterface
const	CID_PATH_SEPARATOR = ':'

Protected Member Functions inherited from ilCtrlAbstractPath
	getPathToRelatedClassInContext (ilCtrlContextInterface $context, string $target_class)
	Returns the path to a class within the given contexts current path that has a relation to the given target. More...

	isClassChildOf (string $child_class, string $parent_class)
	Returns whether the given target class is a child of the other given class. More...

	isClassParentOf (string $parent_class, string $child_class)
	Returns whether the given target class is a parent of the other given class. More...

	appendCid (string $cid, ?string $path=null)
	Helper function to add CIDs to a given path. More...

Protected Attributes inherited from ilCtrlAbstractPath
ilCtrlStructureInterface	$structure

ilCtrlException	$exception = null

string	$cid_path = null

Detailed Description

Class ilCtrlArrayClassPath.

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

Definition at line 26 of file class.ilCtrlArrayClassPath.php.

Constructor & Destructor Documentation

◆ __construct()

ilCtrlArrayClassPath::__construct	(	ilCtrlStructureInterface	$structure,
		ilCtrlContextInterface	$context,
		array	$target_classes
	)

ilCtrlArrayClassPath Constructor

Parameters

ilCtrlStructureInterface	$structure
ilCtrlContextInterface	$context
string[]	$target_classes

Definition at line 40 of file class.ilCtrlArrayClassPath.php.

    {
        parent::__construct($structure);
 
        $this->context = $context;
 
        try {
            $this->cid_path = $this->getCidPathByArray($target_classes);
        } catch (ilCtrlException $exception) {
            $this->exception = $exception;
        }
    }

References $context, ilCtrlAbstractPath\$exception, ilCtrlAbstractPath\$structure, ILIAS\GlobalScreen\Provider\__construct(), and getCidPathByArray().

Here is the call graph for this function:

Member Function Documentation

◆ getCidPathByArray()

ilCtrlArrayClassPath::getCidPathByArray ( array $target_classes )

private

Generates a cid path from the given class array.

If the given class array does not contain a valid path an according exception will be thrown.

Parameters

string[] $target_classes

Returns: string

Exceptions

ilCtrlException if classes within the classes array are not related.

Definition at line 64 of file class.ilCtrlArrayClassPath.php.

                                                             : string
    {
        // abort if the provided targets are empty.
        if (empty($target_classes)) {
            throw new ilCtrlException(__METHOD__ . " must be provided with a list of classes.");
        }
 
        // loop through each provided class in descending order
        // and check if they are all related to one another and
        // convert them to a cid path.
        $cid_path = $previous_class = null;
        foreach ($target_classes as $current_class) {
            $current_cid = $this->structure->getClassCidByName($current_class);
 
            // abort if the current class cannot be found.
            if (null === $current_cid) {
                throw new ilCtrlException("Class '$current_class' was not found in the control structure, try `composer du` to read artifacts.");
            }
 
            // abort if the current and previous classes are
            // not related.
            if (null !== $previous_class && !$this->isClassParentOf($previous_class, $current_class)) {
                throw new ilCtrlException("Class '$current_class' is not a child of '$previous_class'.");
            }
 
            $cid_path = $this->appendCid($current_cid, $cid_path);
            $previous_class = $current_class;
        }
 
        // if the first provided class is a baseclass the
        // created cid path can be returned.
        $first_array_class = $target_classes[array_key_first($target_classes)];
        if ($this->structure->isBaseClass($first_array_class)) {
            return $cid_path;
        }
 
        // check if the first command class is related to one
        // of the current context.
        $related_class_path = $this->getPathToRelatedClassInContext($this->context, $first_array_class);
        if (null === $related_class_path) {
            throw new ilCtrlException("Class '$first_array_class' is not a baseclass and the current context doesn't have one either.");
        }
 
        return $this->appendCid($cid_path, $related_class_path);
    }