vendor/symfony/form/FormView.php line 22

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form;
  14. use Symfony\Component\Form\Exception\BadMethodCallException;
  16. /**
  17.  * @author Bernhard Schussek <bschussek@gmail.com>
  18.  *
  19.  * @implements \ArrayAccess<int|string, FormView>
  20.  * @implements \IteratorAggregate<int|string, FormView>
  21.  */
  22. class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
  23. {
  24.     /**
  25.      * The variables assigned to this view.
  26.      */
  27.     public $vars = [
  28.         'value' => null,
  29.         'attr' => [],
  30.     ];
  32.     /**
  33.      * The parent view.
  34.      */
  35.     public $parent;
  37.     /**
  38.      * The child views.
  39.      *
  40.      * @var array<int|string, FormView>
  41.      */
  42.     public $children = [];
  44.     /**
  45.      * Is the form attached to this renderer rendered?
  46.      *
  47.      * Rendering happens when either the widget or the row method was called.
  48.      * Row implicitly includes widget, however certain rendering mechanisms
  49.      * have to skip widget rendering when a row is rendered.
  50.      */
  51.     private bool $rendered = false;
  53.     private bool $methodRendered = false;
  55.     public function __construct(self $parent = null)
  56.     {
  57.         $this->parent = $parent;
  58.     }
  60.     /**
  61.      * Returns whether the view was already rendered.
  62.      */
  63.     public function isRendered(): bool
  64.     {
  65.         if (true === $this->rendered || 0 === \count($this->children)) {
  66.             return $this->rendered;
  67.         }
  69.         foreach ($this->children as $child) {
  70.             if (!$child->isRendered()) {
  71.                 return false;
  72.             }
  73.         }
  75.         return $this->rendered = true;
  76.     }
  78.     /**
  79.      * Marks the view as rendered.
  80.      *
  81.      * @return $this
  82.      */
  83.     public function setRendered(): static
  84.     {
  85.         $this->rendered = true;
  87.         return $this;
  88.     }
  90.     public function isMethodRendered(): bool
  91.     {
  92.         return $this->methodRendered;
  93.     }
  95.     public function setMethodRendered()
  96.     {
  97.         $this->methodRendered = true;
  98.     }
  100.     /**
  101.      * Returns a child by name (implements \ArrayAccess).
  102.      *
  103.      * @param int|string $name The child name
  104.      */
  105.     public function offsetGet(mixed $name): self
  106.     {
  107.         return $this->children[$name];
  108.     }
  110.     /**
  111.      * Returns whether the given child exists (implements \ArrayAccess).
  112.      *
  113.      * @param int|string $name The child name
  114.      */
  115.     public function offsetExists(mixed $name): bool
  116.     {
  117.         return isset($this->children[$name]);
  118.     }
  120.     /**
  121.      * Implements \ArrayAccess.
  122.      *
  123.      * @throws BadMethodCallException always as setting a child by name is not allowed
  124.      */
  125.     public function offsetSet(mixed $name, mixed $value): void
  126.     {
  127.         throw new BadMethodCallException('Not supported.');
  128.     }
  130.     /**
  131.      * Removes a child (implements \ArrayAccess).
  132.      *
  133.      * @param int|string $name The child name
  134.      */
  135.     public function offsetUnset(mixed $name): void
  136.     {
  137.         unset($this->children[$name]);
  138.     }
  140.     /**
  141.      * Returns an iterator to iterate over children (implements \IteratorAggregate).
  142.      *
  143.      * @return \ArrayIterator<int|string, FormView>
  144.      */
  145.     public function getIterator(): \ArrayIterator
  146.     {
  147.         return new \ArrayIterator($this->children);
  148.     }
  150.     public function count(): int
  151.     {
  152.         return \count($this->children);
  153.     }
  154. }