ComponentEntries.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2016 Timon Amstutz <timon.amstutz@ilub.unibe.ch> Extended GPL, see docs/LICENSE */

namespace ILIAS\UI\Implementation\Crawler\Entry;
use ILIAS\UI\Implementation\Crawler as Crawler;

class ComponentEntries extends AbstractEntryPart implements \Iterator, \Countable, \JsonSerializable
{
        protected $root_entry_id = 'root';

        protected $id_to_entry_map = array();

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

        public function addEntry(ComponentEntry $entry){
                $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){
                foreach($entries as $entry){
                        $this->addEntry($entry);
                }
        }

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

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

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

        public function getEntryById($id = "")
        {
                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($id){
                $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 getParentsOfEntryTitles($id){
                $titles = array();
                foreach ($this->getParentsOfEntry($id) as $parent_id) {
                        $titles[$parent_id] = $this->getEntryById($parent_id)->getTitle();
                }
                return $titles;
        }

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

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

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

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

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

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

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

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

        public function jsonSerialize() {
                return $this->id_to_entry_map;
        }
}