core/lib/Thelia/Core/Template/Loop/Argument/ArgumentCollection.php line 122

  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\Template\Loop\Argument;
  15. /**
  16.  * @author Etienne Roudeix <eroudeix@openstudio.fr>
  17.  */
  18. class ArgumentCollection implements \Iterator
  19. {
  20.     private $arguments = [];
  22.     public function __construct()
  23.     {
  24.         $this->addArguments(\func_get_args(), true);
  25.     }
  27.     /**
  28.      * @return bool
  29.      */
  30.     public function hasKey($key)
  31.     {
  32.         return isset($this->arguments[$key]);
  33.     }
  35.     /**
  36.      * @return Argument|null
  37.      */
  38.     public function get($key)
  39.     {
  40.         return $this->hasKey($key) ? $this->arguments[$key] : null;
  41.     }
  43.     /**
  44.      * @return bool
  45.      */
  46.     public function isEmpty()
  47.     {
  48.         return \count($this->arguments) == 0;
  49.     }
  51.     /**
  52.      * @return ArgumentCollection
  53.      */
  54.     public function addArguments(array $argumentList, $force = true)
  55.     {
  56.         foreach ($argumentList as $argument) {
  57.             $this->addArgument($argument, $force);
  58.         }
  60.         return $this;
  61.     }
  63.     /**
  64.      * @return ArgumentCollection
  65.      */
  66.     public function addArgument(Argument $argument, $force = true)
  67.     {
  68.         if (isset($this->arguments[$argument->name]) && !$force) {
  69.             return $this;
  70.         }
  72.         $this->arguments[$argument->name] = $argument;
  74.         return $this;
  75.     }
  77.     /**
  78.      * @param array $argumentNames array with names of arguments to remove
  79.      *
  80.      * @return ArgumentCollection
  81.      *
  82.      * @since 2.2.0-beta1
  83.      */
  84.     public function removeArguments(array $argumentNames)
  85.     {
  86.         foreach ($argumentNames as $argumentName) {
  87.             $this->removeArgument($argumentName);
  88.         }
  90.         return $this;
  91.     }
  93.     /**
  94.      * @param string $argumentName name of the argument to remove
  95.      *
  96.      * @return ArgumentCollection
  97.      *
  98.      * @since 2.2.0-beta1
  99.      */
  100.     public function removeArgument(string $argumentName)
  101.     {
  102.         if (isset($this->arguments[$argumentName])) {
  103.             unset($this->arguments[$argumentName]);
  104.         }
  106.         return $this;
  107.     }
  109.     public function getCount()
  110.     {
  111.         return \count($this->arguments);
  112.     }
  114.     /**
  115.      * (PHP 5 &gt;= 5.0.0)<br/>
  116.      * Return the current element.
  117.      *
  118.      * @see http://php.net/manual/en/iterator.current.php
  119.      *
  120.      * @return Argument
  121.      */
  122.     public function current()
  123.     {
  124.         return current($this->arguments);
  125.     }
  127.     /**
  128.      * (PHP 5 &gt;= 5.0.0)<br/>
  129.      * Move forward to next element.
  130.      *
  131.      * @see http://php.net/manual/en/iterator.next.php
  132.      *
  133.      * @return void any returned value is ignored
  134.      */
  135.     public function next(): void
  136.     {
  137.         next($this->arguments);
  138.     }
  140.     /**
  141.      * (PHP 5 &gt;= 5.0.0)<br/>
  142.      * Return the key of the current element.
  143.      *
  144.      * @see http://php.net/manual/en/iterator.key.php
  145.      *
  146.      * @return mixed scalar on success, or null on failure
  147.      */
  148.     public function key()
  149.     {
  150.         return key($this->arguments);
  151.     }
  153.     /**
  154.      * (PHP 5 &gt;= 5.0.0)<br/>
  155.      * Checks if current position is valid.
  156.      *
  157.      * @see http://php.net/manual/en/iterator.valid.php
  158.      *
  159.      * @return bool The return value will be casted to boolean and then evaluated.
  160.      *              Returns true on success or false on failure.
  161.      */
  162.     public function valid(): bool
  163.     {
  164.         return $this->key() !== null;
  165.     }
  167.     /**
  168.      * (PHP 5 &gt;= 5.0.0)<br/>
  169.      * Rewind the Iterator to the first element.
  170.      *
  171.      * @see http://php.net/manual/en/iterator.rewind.php
  172.      *
  173.      * @return void any returned value is ignored
  174.      */
  175.     public function rewind(): void
  176.     {
  177.         reset($this->arguments);
  178.     }
  180.     public function getHash()
  181.     {
  182.         $arguments = $this->arguments;
  184.         if (\array_key_exists('name', $arguments)) {
  185.             unset($arguments['name']);
  186.         }
  188.         $string = '';
  189.         foreach ($arguments as $key => $argument) {
  190.             $string .= $key.'='.$argument->getRawValue();
  191.         }
  193.         return md5($string);
  194.     }
  195. }