core/lib/Thelia/Condition/ConditionCollection.php line 66

  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\Condition;
  15. use ArrayAccess;
  16. use Countable;
  17. use Iterator;
  18. use Thelia\Condition\Implementation\ConditionInterface;
  20. /**
  21.  * Manage a set of ConditionInterface.
  22.  *
  23.  * @author  Guillaume MOREL <gmorel@openstudio.fr>
  24.  */
  25. class ConditionCollection implements \Iterator, \Countable, \ArrayAccess
  26. {
  27.     /** @var ConditionInterface[] */
  28.     protected $conditions = [];
  30.     /**
  31.      * (PHP 5 &gt;= 5.0.0)
  32.      * Return the current element.
  33.      *
  34.      * @see http://php.net/manual/en/iterator.current.php
  35.      *
  36.      * @return mixed can return any type
  37.      */
  38.     public function current()
  39.     {
  40.         $var = current($this->conditions);
  42.         return $var;
  43.     }
  45.     /**
  46.      * (PHP 5 &gt;= 5.0.0)
  47.      * Move forward to next element.
  48.      *
  49.      * @see http://php.net/manual/en/iterator.next.php
  50.      *
  51.      * @return void any returned value is ignored
  52.      */
  53.     public function next(): void
  54.     {
  55.         next($this->conditions);
  56.     }
  58.     /**
  59.      * (PHP 5 &gt;= 5.0.0)
  60.      * Return the key of the current element.
  61.      *
  62.      * @see http://php.net/manual/en/iterator.key.php
  63.      *
  64.      * @return mixed scalar on success, or null on failure
  65.      */
  66.     public function key()
  67.     {
  68.         $var = key($this->conditions);
  70.         return $var;
  71.     }
  73.     /**
  74.      * (PHP 5 &gt;= 5.0.0)
  75.      * Checks if current position is valid.
  76.      *
  77.      * @see http://php.net/manual/en/iterator.valid.php
  78.      *
  79.      * @return bool The return value will be casted to boolean and then evaluated.
  80.      *              Returns true on success or false on failure.
  81.      */
  82.     public function valid(): bool
  83.     {
  84.         $key = key($this->conditions);
  86.         return $key !== null;
  87.     }
  89.     /**
  90.      * (PHP 5 &gt;= 5.0.0)
  91.      * Rewind the Iterator to the first element.
  92.      *
  93.      * @see http://php.net/manual/en/iterator.rewind.php
  94.      *
  95.      * @return void any returned value is ignored
  96.      */
  97.     public function rewind(): void
  98.     {
  99.         reset($this->conditions);
  100.     }
  102.     /**
  103.      * (PHP 5 &gt;= 5.1.0)
  104.      * Count elements of an object.
  105.      *
  106.      * @see http://php.net/manual/en/countable.count.php
  107.      *
  108.      * @return int The custom count as an integer.
  109.      *             The return value is cast to an integer.
  110.      */
  111.     public function count(): int
  112.     {
  113.         return \count($this->conditions);
  114.     }
  116.     /**
  117.      * (PHP 5 >= 5.0.0)
  118.      * Whether a offset exists.
  119.      *
  120.      * @see http://php.net/manual/en/arrayaccess.offsetexists.php
  121.      *
  122.      * @param mixed $offset
  123.      *                      An offset to check for
  124.      *
  125.      * @return bool true on success or false on failure.
  126.      *              The return value will be casted to boolean if non-boolean was returned.
  127.      */
  128.     public function offsetExists($offset): bool
  129.     {
  130.         return isset($this->conditions[$offset]);
  131.     }
  133.     /**
  134.      * (PHP 5 >= 5.0.0)
  135.      * Offset to retrieve.
  136.      *
  137.      * @see http://php.net/manual/en/arrayaccess.offsetget.php
  138.      *
  139.      * @param mixed $offset
  140.      *                      The offset to retrieve
  141.      *
  142.      * @return mixed can return all value types
  143.      */
  144.     public function offsetGet($offset)
  145.     {
  146.         return $this->conditions[$offset] ?? null;
  147.     }
  149.     /**
  150.      * (PHP 5 >= 5.0.0)
  151.      * Offset to set.
  152.      *
  153.      * @see http://php.net/manual/en/arrayaccess.offsetset.php
  154.      *
  155.      * @param mixed $offset
  156.      *                      The offset to assign the value to
  157.      * @param mixed $value
  158.      *                      The value to set
  159.      */
  160.     public function offsetSet($offset, $value): void
  161.     {
  162.         if (null === $offset) {
  163.             $this->conditions[] = $value;
  164.         } else {
  165.             $this->conditions[$offset] = $value;
  166.         }
  167.     }
  169.     /**
  170.      * (PHP 5 >= 5.0.0)
  171.      * Offset to unset.
  172.      *
  173.      * @see http://php.net/manual/en/arrayaccess.offsetunset.php
  174.      *
  175.      * @param mixed $offset
  176.      *                      The offset to unset
  177.      */
  178.     public function offsetUnset($offset): void
  179.     {
  180.         unset($this->conditions[$offset]);
  181.     }
  183.     /**
  184.      * Allow to compare 2 set of conditions.
  185.      *
  186.      * @return string Jsoned data
  187.      */
  188.     public function __toString()
  189.     {
  190.         $arrayToSerialize = [];
  191.         /** @var ConditionInterface $condition */
  192.         foreach ($this as $condition) {
  193.             $arrayToSerialize[] = $condition->getSerializableCondition();
  194.         }
  196.         return json_encode($arrayToSerialize);
  197.     }
  198. }