Inheritance diagram for ilCtrlAbstractPath:

Collaboration diagram for ilCtrlAbstractPath:

Public Member Functions
	__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...

Protected Member Functions
	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
ilCtrlStructureInterface	$structure

ilCtrlException	$exception = null

string	$cid_path = null

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

Detailed Description

Class ilCtrlAbstractPath.

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

Constructor & Destructor Documentation

◆ __construct()

ilCtrlAbstractPath::__construct ( ilCtrlStructureInterface $structure )

ilCtrlAbstractPath Constructor

Parameters

ilCtrlStructureInterface $structure

Definition at line 34 of file class.ilCtrlAbstractPath.php.

    {
        $this->structure = $structure;
    }

References $structure.

Member Function Documentation

◆ appendCid()

ilCtrlAbstractPath::appendCid	(	string	$cid,
		string	$path = `null`
	)

protected

Helper function to add CIDs to a given path.

Parameters

string	$cid
string \| null	$path

Returns: string

Definition at line 223 of file class.ilCtrlAbstractPath.php.

                                                                  : string
    {
        if (null === $path) {
            return $cid;
        }
 
        return $path . self::CID_PATH_SEPARATOR . $cid;
    }

References $path.

Referenced by ilCtrlArrayClassPath\getCidPathByArray(), ilCtrlSingleClassPath\getCidPathByClass(), and getCidPaths().

Here is the caller graph for this function:

◆ getBaseClass()

ilCtrlAbstractPath::getBaseClass ( )

@inheritDoc

Implements ilCtrlPathInterface.

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

                                  : ?string
    {
        if (null !== $this->cid_path) {
            $cid_array = $this->getCidArray(SORT_ASC);
            $class_name = $this->structure->getClassNameByCid($cid_array[0]);
            if (null !== $class_name && $this->structure->isBaseClass($class_name)) {
                return $class_name;
            }
        }
 
        return null;
    }

References getCidArray().

Here is the call graph for this function:

◆ getCidArray()

ilCtrlAbstractPath::getCidArray ( int $order = SORT_DESC )

@inheritDoc

Implements ilCtrlPathInterface.

Definition at line 116 of file class.ilCtrlAbstractPath.php.

                                                       : array
    {
        if (null === $this->getCidPath()) {
            return [];
        }
 
        $cid_array = explode(self::CID_PATH_SEPARATOR, $this->cid_path);
        if (SORT_DESC === $order) {
            $cid_array = array_reverse($cid_array);
        }
 
        return $cid_array;
    }

References getCidPath().

Referenced by getBaseClass(), getCidPaths(), getCurrentCid(), and getNextCid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCidPath()

ilCtrlAbstractPath::getCidPath ( )

@inheritDoc

Implements ilCtrlPathInterface.

Definition at line 42 of file class.ilCtrlAbstractPath.php.

                                : ?string
    {
        // cannot use empty(), since '0' would be considered
        // empty and that's an actual cid.
        if (null !== $this->cid_path && '' !== $this->cid_path) {
            return $this->cid_path;
        }
 
        return null;
    }

References $cid_path.

Referenced by getCidArray(), getCidPaths(), and getCurrentCid().

Here is the caller graph for this function:

◆ getCidPaths()

ilCtrlAbstractPath::getCidPaths ( int $order = SORT_DESC )

@inheritDoc

Implements ilCtrlPathInterface.

Definition at line 88 of file class.ilCtrlAbstractPath.php.

                                                       : array
    {
        if (null === $this->getCidPath()) {
            return [];
        }
 
        // cid array must be ascending, because the
        // paths should always begin at the baseclass.
        $cid_array = $this->getCidArray(SORT_ASC);
        $cid_paths = [];
 
        foreach ($cid_array as $index => $cid) {
            $cid_paths[] = (0 !== $index) ?
                $this->appendCid($cid, $cid_paths[$index - 1]) :
                $cid
            ;
        }
 
        if (SORT_DESC === $order) {
            $cid_paths = array_reverse($cid_paths);
        }
 
        return $cid_paths;
    }

References $index, appendCid(), getCidArray(), and getCidPath().

Here is the call graph for this function:

◆ getCurrentCid()

ilCtrlAbstractPath::getCurrentCid ( )

@inheritDoc

Implements ilCtrlPathInterface.

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

                                   : ?string
    {
        if (null !== $this->getCidPath()) {
            // use default order (command- to baseclass) and
            // retrieve the last command class (index 0).
            return $this->getCidArray()[0];
        }
 
        return null;
    }

References getCidArray(), and getCidPath().

Here is the call graph for this function:

◆ getException()

ilCtrlAbstractPath::getException ( )

@inheritDoc

Implements ilCtrlPathInterface.

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

                                  : ?ilCtrlException
    {
        return $this->exception;
    }

References $exception.

◆ getNextCid()

ilCtrlAbstractPath::getNextCid ( string $current_class )

@inheritDoc

Implements ilCtrlPathInterface.

Definition at line 70 of file class.ilCtrlAbstractPath.php.

                                                     : ?string
    {
        $current_cid = $this->structure->getClassCidByName($current_class);
        $cid_array = $this->getCidArray(SORT_ASC);
        $cid_count = count($cid_array);
 
        foreach ($cid_array as $index => $cid) {
            if ($current_cid === $cid && ($index + 1) < $cid_count) {
                return $cid_array[$index + 1];
            }
        }
 
        return null;
    }

References $index, and getCidArray().

Here is the call graph for this function:

◆ getPathToRelatedClassInContext()

ilCtrlAbstractPath::getPathToRelatedClassInContext	(	ilCtrlContextInterface	$context,
		string	$target_class
	)

protected

Returns the path to a class within the given contexts current path that has a relation to the given target.

Parameters

ilCtrlContextInterface	$context
string	$target_class

Returns: string|null

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

                                                                                                            : ?string
    {
        if (null !== $context->getPath()->getCidPath()) {
            foreach ($context->getPath()->getCidArray() as $index => $cid) {
                $current_class = $this->structure->getClassNameByCid($cid);
                if (null !== $current_class && $this->isClassChildOf($target_class, $current_class)) {
                    $cid_paths = $context->getPath()->getCidPaths();
 
                    // return the path to the class related to the
                    // target class.
                    return $cid_paths[$index];
                }
            }
        }
 
        return null;
    }

References $context, $index, and isClassChildOf().

Referenced by ilCtrlArrayClassPath\getCidPathByArray(), and ilCtrlSingleClassPath\getCidPathByClass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isClassChildOf()

ilCtrlAbstractPath::isClassChildOf	(	string	$child_class,
		string	$parent_class
	)

protected

Returns whether the given target class is a child of the other given class.

Parameters

string	$child_class
string	$parent_class

Returns: bool

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

                                                                                : bool
    {
        $children = $this->structure->getChildrenByName($parent_class);
        if (null !== $children) {
            return in_array(strtolower($child_class), $children, true);
        }
 
        return false;
    }

Referenced by getPathToRelatedClassInContext().

Here is the caller graph for this function:

◆ isClassParentOf()

ilCtrlAbstractPath::isClassParentOf	(	string	$parent_class,
		string	$child_class
	)

protected

Returns whether the given target class is a parent of the other given class.

Parameters

string	$parent_class
string	$child_class

Returns: bool

Definition at line 206 of file class.ilCtrlAbstractPath.php.

                                                                                 : bool
    {
        $parents = $this->structure->getParentsByName($child_class);
        if (null !== $parents) {
            return in_array(strtolower($parent_class), $parents, true);
        }
 
        return false;
    }