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

Inheritance diagram for ilCtrlSingleClassPath:

Collaboration diagram for ilCtrlSingleClassPath:

Public Member Functions
	__construct (ilCtrlStructureInterface $structure, ilCtrlContextInterface $context, string $target_class)
	ilCtrlSingleClassPath 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
	getCidPathByClass (string $target_class)
	Returns a cid path that reaches from the current context's baseclass to the given class. 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

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 Class ilCtrlSingleClassPath

Author: Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Constructor & Destructor Documentation

◆ __construct()

ilCtrlSingleClassPath::__construct	(	ilCtrlStructureInterface	$structure,
		ilCtrlContextInterface	$context,
		string	$target_class
	)

ilCtrlSingleClassPath Constructor

Parameters

ilCtrlStructureInterface	$structure
ilCtrlContextInterface	$context
string	$target_class

Definition at line 39 of file class.ilCtrlSingleClassPath.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getCidPathByClass()

ilCtrlSingleClassPath::getCidPathByClass ( string $target_class )

private

Returns a cid path that reaches from the current context's baseclass to the given class.

If the given class cannot be reached from the context's baseclass this instance must be given a class array instead.

Parameters

string $target_class

Returns: string

Exceptions

ilCtrlException if the class has no relations or cannot reach the baseclass of this context.

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

                                                            : string
    {
        $target_cid = $this->structure->getClassCidByName($target_class);
 
        // abort if the target class is unknown.
        if (null === $target_cid) {
            throw new ilCtrlException("Class '$target_class' was not found in the control structure, try `composer du` to read artifacts.");
        }
 
        // if the target class is already the current command
        // class of this context, nothing has to be changed.
        if ($target_cid === $this->context->getPath()->getCurrentCid()) {
            return $this->context->getPath()->getCidPath();
        }
 
        // check if the target is related to a class within
        // the current context's path.
        $related_class_path = $this->getPathToRelatedClassInContext($this->context, $target_class);
        if (null !== $related_class_path) {
            return $this->appendCid($target_cid, $related_class_path);
        }
 
        // fix https://mantis.ilias.de/view.php?id=33094:
        // prioritise baseclasses less than relationships,
        // therefore test at last if the target class is a
        // baseclass.
        if ($this->structure->isBaseClass($target_class)) {
            return $target_cid;
        }
 
        throw new ilCtrlException("ilCtrl cannot find a path for '$target_class' that reaches '{$this->context->getBaseClass()}'");
    }