core/lib/Thelia/Core/Hook/FragmentBag.php line 43

  1. <?php
  3. /*
  4.  * This file is part of the Thelia package.
  5.  * http://www.thelia.net
  6.  *
  7.  * (c) OpenStudio <info@thelia.net>
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Thelia\Core\Hook;
  15. use Iterator;
  17. /**
  18.  * Class FragmentBag.
  19.  *
  20.  * @author  Julien Chanséaume <jchanseaume@openstudio.fr>
  21.  */
  22. class FragmentBag implements \Iterator
  23. {
  24.     private $position;
  26.     /** @var array */
  27.     protected $fragments;
  29.     public function __construct()
  30.     {
  31.         $this->position = 0;
  32.         $this->fragments = [];
  33.     }
  35.     /**
  36.      * (PHP 5 &gt;= 5.0.0)<br/>
  37.      * Return the current element.
  38.      *
  39.      * @see http://php.net/manual/en/iterator.current.php
  40.      *
  41.      * @return mixed can return any type
  42.      */
  43.     public function current()
  44.     {
  45.         return $this->fragments[$this->position];
  46.     }
  48.     /**
  49.      * (PHP 5 &gt;= 5.0.0)<br/>
  50.      * Move forward to next element.
  51.      *
  52.      * @see http://php.net/manual/en/iterator.next.php
  53.      *
  54.      * @return void any returned value is ignored
  55.      */
  56.     public function next(): void
  57.     {
  58.         ++$this->position;
  59.     }
  61.     /**
  62.      * (PHP 5 &gt;= 5.0.0)<br/>
  63.      * Return the key of the current element.
  64.      *
  65.      * @see http://php.net/manual/en/iterator.key.php
  66.      *
  67.      * @return mixed scalar on success, or null on failure
  68.      */
  69.     public function key()
  70.     {
  71.         return $this->position;
  72.     }
  74.     /**
  75.      * (PHP 5 &gt;= 5.0.0)<br/>
  76.      * Checks if current position is valid.
  77.      *
  78.      * @see http://php.net/manual/en/iterator.valid.php
  79.      *
  80.      * @return bool The return value will be casted to boolean and then evaluated.
  81.      *              Returns true on success or false on failure.
  82.      */
  83.     public function valid(): bool
  84.     {
  85.         return isset($this->fragments[$this->position]);
  86.     }
  88.     /**
  89.      * (PHP 5 &gt;= 5.0.0)<br/>
  90.      * Rewind the Iterator to the first element.
  91.      *
  92.      * @see http://php.net/manual/en/iterator.rewind.php
  93.      *
  94.      * @return void any returned value is ignored
  95.      */
  96.     public function rewind(): void
  97.     {
  98.         $this->position = 0;
  99.     }
  101.     /**
  102.      * Clears all parameters.
  103.      *
  104.      * @api
  105.      */
  106.     public function clear(): void
  107.     {
  108.         $this->position = 0;
  109.         $this->fragments = [];
  110.     }
  112.     public function isEmpty()
  113.     {
  114.         return \count($this->fragments) == 0;
  115.     }
  117.     public function getCount()
  118.     {
  119.         return \count($this->fragments);
  120.     }
  122.     public function add($data): void
  123.     {
  124.         $fragment = new Fragment($data);
  125.         $this->addFragment($fragment);
  126.     }
  128.     public function addFragment(Fragment $fragment): void
  129.     {
  130.         $this->fragments[] = $fragment;
  131.     }
  133.     /**
  134.      * Gets the all keys fragment.
  135.      *
  136.      * @return array An array of parameters
  137.      *
  138.      * @api
  139.      */
  140.     public function keys()
  141.     {
  142.         return array_keys($this->fragments);
  143.     }
  144. }