ComponentEntries.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Crawler\Entry;

use ILIAS\UI\Implementation\Crawler as Crawler;
use Iterator;
use Countable;
use JsonSerializable;

class ComponentEntries extends AbstractEntryPart implements Iterator, Countable, JsonSerializable
{
    protected array $id_to_entry_map = [];

    protected string $root_entry_id = 'root';

    public function __construct()
    {
        parent::__construct();
        $this->rewind();
    }

    public function addEntry(ComponentEntry $entry): void
    {
        $this->assert()->isNotIndex($entry->getId(), $this->id_to_entry_map);
        if (count($this) == 0) {
            $this->setRootEntryId($entry->getId());
        }
        $this->id_to_entry_map[$entry->getId()] = $entry;
    }

    public function addEntries(ComponentEntries $entries): void
    {
        foreach ($entries as $entry) {
            $this->addEntry($entry);
        }
    }

    public function addEntriesFromArray(array $entries): void
    {
        foreach ($entries as $entry_array) {
            $this->addEntry(new Crawler\Entry\ComponentEntry($entry_array));
        }
    }

    public function setRootEntryId(string $root_entry_id): void
    {
        $this->root_entry_id = $root_entry_id;
    }

    public function getRootEntryId(): string
    {
        return $this->root_entry_id;
    }

    public function getRootEntry(): ComponentEntry
    {
        return $this->getEntryById($this->getRootEntryId());
    }

    public function getEntryById(string $id = ""): ComponentEntry
    {
        if (array_key_exists($id, $this->id_to_entry_map)) {
            return $this->id_to_entry_map[$id];
        }
        throw $this->f->exception(Crawler\Exception\CrawlerException::INVALID_ID, $id);
    }

    public function getParentsOfEntry(string $id): array
    {
        $parent_id = $this->getEntryById($id)->getParent();

        if (!$parent_id) {
            return array();
        } else {
            $parents = $this->getParentsOfEntry($parent_id);
            array_push($parents, $parent_id);
            return $parents;
        }
    }

    public function isParentOfEntry(string $parent_id, string $entry_id): bool
    {
        return in_array($parent_id, $this->getParentsOfEntry($entry_id));
    }

    public function getParentsOfEntryTitles(string $id): array
    {
        $titles = array();
        foreach ($this->getParentsOfEntry($id) as $parent_id) {
            $titles[$parent_id] = $this->getEntryById($parent_id)->getTitle();
        }
        return $titles;
    }

    public function getDescendantsOfEntry(string $id): array
    {
        $children = $this->getEntryById($id)->getChildren();
        foreach ($this->getEntryById($id)->getChildren() as $child) {
            $children = array_merge($children, $this->getDescendantsOfEntry($child));
        }
        return $children;
    }

    public function getChildrenOfEntry(string $id): array
    {
        $children = [];
        foreach ($this->getEntryById($id)->getChildren() as $child_id) {
            $children[] = $this->getEntryById($child_id);
        }
        return $children;
    }

    public function getDescendantsOfEntryTitles(string $id): array
    {
        $titles = array();
        foreach ($this->getDescendantsOfEntry($id) as $parent_id) {
            $titles[$parent_id] = $this->getEntryById($parent_id)->getTitle();
        }
        return $titles;
    }

    public function expose(): array
    {
        return get_object_vars($this);
    }

    public function valid(): bool
    {
        return current($this->id_to_entry_map) !== false;
    }

    public function key(): string
    {
        return key($this->id_to_entry_map);
    }

    public function current(): ComponentEntry
    {
        return current($this->id_to_entry_map);
    }

    public function next(): void
    {
        next($this->id_to_entry_map);
    }

    public function rewind(): void
    {
        reset($this->id_to_entry_map);
    }

    public function count(): int
    {
        return count($this->id_to_entry_map);
    }

    public function jsonSerialize(): array
    {
        $serialized = [];
        foreach ($this->id_to_entry_map as $id => $item) {
            $serialized[$id] = $item->jsonSerialize();
        }
        return $serialized;
    }
}