core/lib/Thelia/TaxEngine/OrderProductTaxCollection.php line 60

  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\TaxEngine;
  15. use Thelia\Model\OrderProductTax;
  17. /**
  18.  * @author Etienne Roudeix <eroudeix@openstudio.fr>
  19.  */
  20. class OrderProductTaxCollection implements \Iterator
  21. {
  22.     private $position;
  23.     protected $taxes = [];
  25.     public function __construct()
  26.     {
  27.         foreach (\func_get_args() as $tax) {
  28.             $this->addTax($tax);
  29.         }
  30.     }
  32.     public function isEmpty()
  33.     {
  34.         return \count($this->taxes) == 0;
  35.     }
  37.     /**
  38.      * @return OrderProductTaxCollection
  39.      */
  40.     public function addTax(OrderProductTax $tax)
  41.     {
  42.         $this->taxes[] = $tax;
  44.         return $this;
  45.     }
  47.     public function getCount()
  48.     {
  49.         return \count($this->taxes);
  50.     }
  52.     /**
  53.      * (PHP 5 &gt;= 5.0.0)<br/>
  54.      * Return the current element.
  55.      *
  56.      * @see http://php.net/manual/en/iterator.current.php
  57.      *
  58.      * @return OrderProductTax
  59.      */
  60.     public function current()
  61.     {
  62.         return $this->taxes[$this->position];
  63.     }
  65.     /**
  66.      * (PHP 5 &gt;= 5.0.0)<br/>
  67.      * Move forward to next element.
  68.      *
  69.      * @see http://php.net/manual/en/iterator.next.php
  70.      *
  71.      * @return void any returned value is ignored
  72.      */
  73.     public function next(): void
  74.     {
  75.         ++$this->position;
  76.     }
  78.     /**
  79.      * (PHP 5 &gt;= 5.0.0)<br/>
  80.      * Return the key of the current element.
  81.      *
  82.      * @see http://php.net/manual/en/iterator.key.php
  83.      *
  84.      * @return mixed scalar on success, or null on failure
  85.      */
  86.     public function key()
  87.     {
  88.         return $this->position;
  89.     }
  91.     /**
  92.      * (PHP 5 &gt;= 5.0.0)<br/>
  93.      * Checks if current position is valid.
  94.      *
  95.      * @see http://php.net/manual/en/iterator.valid.php
  96.      *
  97.      * @return bool The return value will be casted to boolean and then evaluated.
  98.      *              Returns true on success or false on failure.
  99.      */
  100.     public function valid(): bool
  101.     {
  102.         return isset($this->taxes[$this->position]);
  103.     }
  105.     /**
  106.      * (PHP 5 &gt;= 5.0.0)<br/>
  107.      * Rewind the Iterator to the first element.
  108.      *
  109.      * @see http://php.net/manual/en/iterator.rewind.php
  110.      *
  111.      * @return void any returned value is ignored
  112.      */
  113.     public function rewind(): void
  114.     {
  115.         $this->position = 0;
  116.     }
  118.     public function getKey($key)
  119.     {
  120.         return $this->taxes[$key] ?? null;
  121.     }
  122. }