class.ilCtrlSingleClassPath.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilCtrlSingleClassPath extends ilCtrlAbstractPath
{
    private ilCtrlContextInterface $context;

    public function __construct(ilCtrlStructureInterface $structure, ilCtrlContextInterface $context, string $target_class)
    {
        parent::__construct($structure);

        $this->context = $context;

        try {
            $this->cid_path = $this->getCidPathByClass($target_class);
        } catch (ilCtrlException $exception) {
            $this->exception = $exception;
        }
    }

    private function getCidPathByClass(string $target_class): 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()}'");
    }
}