class.ilCtrlStructureHelper.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 ilCtrlStructureHelper
{
    protected array $ctrl_structure;

    protected array $base_classes;

    public function __construct(array $base_classes, array $ctrl_structure)
    {
        $this->ctrl_structure = $ctrl_structure;
        $this->base_classes = $base_classes;
    }

    public function mapStructureReferences(): self
    {
        $this->ctrl_structure = (new ilCtrlStructureMapper(
            $this->ctrl_structure
        ))->getStructure();

        return $this;
    }

    public function filterUnnecessaryEntries(): self
    {
        $this->ctrl_structure = array_filter(
            $this->ctrl_structure,
            function (array $value, string $key): bool {
                // if the entry is not a baseclass and has no
                // references, the entry will be removed.
                return !(
                    !in_array($key, $this->base_classes, true) &&
                    empty($value[ilCtrlStructureInterface::KEY_CLASS_CHILDREN]) &&
                    empty($value[ilCtrlStructureInterface::KEY_CLASS_PARENTS])
                );
            },
            ARRAY_FILTER_USE_BOTH
        );

        return $this;
    }

    public function getStructure(): array
    {
        return $this->ctrl_structure;
    }
}