vendor/elao/form-translation-bundle/Model/FormTree.php line 21

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the ElaoFormTranslation bundle.
  5.  *
  6.  * Copyright (C) Elao
  7.  *
  8.  * @author Elao <contact@elao.com>
  9.  */
  11. namespace Elao\Bundle\FormTranslationBundle\Model;
  13. /**
  14.  * A form Tree
  15.  *
  16.  * @author Thomas Jarrand <thomas.jarrand@gmail.com>
  17.  *
  18.  * @implements \Iterator<FormTreeNode>
  19.  * @implements \ArrayAccess<int,FormTreeNode>
  20.  */
  21. class FormTree implements \Iterator, \Countable, \ArrayAccess
  22. {
  23.     /**
  24.      * The FormTreeNode elements
  25.      *
  26.      * @var array<FormTreeNode>
  27.      */
  28.     private array $nodes;
  30.     /**
  31.      * Current position in the loop
  32.      */
  33.     private int $position = 0;
  35.     /**
  36.      * @param array<FormTreeNode> $nodes
  37.      */
  38.     public function __construct(array $nodes = [])
  39.     {
  40.         $this->nodes = $nodes;
  41.     }
  43.     /**
  44.      * Add a parent node to the beginning of the tree
  45.      *
  46.      * @param FormTreeNode $node The node
  47.      *
  48.      * @return int The new number of elements in the Tree
  49.      */
  50.     public function addParent(FormTreeNode $node): int
  51.     {
  52.         return array_unshift($this->nodes, $node);
  53.     }
  55.     /**
  56.      * Add a child node to the end of the tree
  57.      *
  58.      * @param FormTreeNode $node The node
  59.      *
  60.      * @return int The new number of elements in the Tree
  61.      */
  62.     public function addChild(FormTreeNode $node): int
  63.     {
  64.         return array_push($this->nodes, $node);
  65.     }
  67.     /**
  68.      * Set the loop back to the start
  69.      */
  70.     #[\ReturnTypeWillChange]
  71.     public function rewind(): void
  72.     {
  73.         $this->position = 0;
  74.     }
  76.     /**
  77.      * Return the length of the tree
  78.      */
  79.     public function count(): int
  80.     {
  81.         return \count($this->nodes);
  82.     }
  84.     /**
  85.      * Return the current Node in the loop
  86.      */
  87.     #[\ReturnTypeWillChange]
  88.     public function current(): FormTreeNode
  89.     {
  90.         return $this->nodes[$this->position];
  91.     }
  93.     /**
  94.      * Return the current position in the loop
  95.      */
  96.     #[\ReturnTypeWillChange]
  97.     public function key(): int
  98.     {
  99.         return $this->position;
  100.     }
  102.     /**
  103.      * Increment current position
  104.      */
  105.     #[\ReturnTypeWillChange]
  106.     public function next(): void
  107.     {
  108.         ++$this->position;
  109.     }
  111.     /**
  112.      * Return whether or not the current position is valid
  113.      */
  114.     #[\ReturnTypeWillChange]
  115.     public function valid(): bool
  116.     {
  117.         return $this->offsetExists($this->position);
  118.     }
  120.     /**
  121.      * Return whether or not the given offset exists
  122.      */
  123.     #[\ReturnTypeWillChange]
  124.     public function offsetExists($offset): bool
  125.     {
  126.         return isset($this->nodes[$offset]);
  127.     }
  129.     /**
  130.      * Get the node at the given offset
  131.      */
  132.     #[\ReturnTypeWillChange]
  133.     public function offsetGet($offset): ?FormTreeNode
  134.     {
  135.         return $this->offsetExists($offset) ? $this->nodes[$offset] : null;
  136.     }
  138.     /**
  139.      * Set the node at the given offset
  140.      */
  141.     #[\ReturnTypeWillChange]
  142.     public function offsetSet($offset, $value): void
  143.     {
  144.         /* Not implemented: Use addParent and addChild methods */
  145.     }
  147.     /**
  148.      * Unset node at the given offset
  149.      */
  150.     #[\ReturnTypeWillChange]
  151.     public function offsetUnset($offset): void
  152.     {
  153.         /* Not implemented: FormTree nodes should not be unsetable */
  154.     }
  155. }