class.ilCtrlArrayClassPath.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

/* Copyright (c) 2021 Thibeau Fuhrer <thf@studer-raimann.ch> Extended GPL, see docs/LICENSE */

class ilCtrlArrayClassPath extends ilCtrlAbstractPath
{
    private ilCtrlContextInterface $context;

    public function __construct(ilCtrlStructureInterface $structure, ilCtrlContextInterface $context, array $target_classes)
    {
        parent::__construct($structure);

        $this->context = $context;

        try {
            $this->cid_path = $this->getCidPathByArray($target_classes);
        } catch (ilCtrlException $exception) {
            $this->exception = $exception;
        }
    }

    private function getCidPathByArray(array $target_classes): 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);
    }
}