core/lib/Thelia/Core/Template/Element/LoopResult.php line 138

  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\Element;
  15. use Propel\Runtime\Collection\ObjectCollection;
  16. use Propel\Runtime\Util\PropelModelPager;
  18. class LoopResult implements \Iterator, \JsonSerializable
  19. {
  20.     private $position;
  21.     protected $collection = [];
  23.     public $resultsCollection;
  25.     protected $versioned = false;
  26.     protected $timestamped = false;
  27.     protected $countable = false;
  29.     public function __construct($resultsCollection)
  30.     {
  31.         $this->position = 0;
  32.         $this->resultsCollection = $resultsCollection;
  33.     }
  35.     /**
  36.      * @param bool $countable
  37.      */
  38.     public function setCountable($countable = true): void
  39.     {
  40.         $this->countable = true === $countable;
  41.     }
  43.     /**
  44.      * @param bool $timestamped
  45.      */
  46.     public function setTimestamped($timestamped = true): void
  47.     {
  48.         $this->timestamped = true === $timestamped;
  49.     }
  51.     /**
  52.      * @param bool $versioned
  53.      */
  54.     public function setVersioned($versioned = true): void
  55.     {
  56.         $this->versioned = true === $versioned;
  57.     }
  59.     public function isEmpty()
  60.     {
  61.         return \count($this->collection) == 0;
  62.     }
  64.     public function addRow(LoopResultRow $row): void
  65.     {
  66.         if (true === $this->versioned) {
  67.             foreach ($this->getVersionOutputs() as $output) {
  68.                 $row->set($output[0], $row->model->{$output[1]}());
  69.             }
  70.         }
  71.         if (true === $this->timestamped) {
  72.             foreach ($this->getTimestampOutputs() as $output) {
  73.                 $row->set($output[0], $row->model->{$output[1]}());
  74.             }
  75.         }
  76.         if (true === $this->countable) {
  77.             $row->set('LOOP_COUNT', 1 + $this->getCount());
  78.             $row->set('LOOP_TOTAL', $this->getResultDataCollectionCount());
  79.         }
  81.         $this->collection[] = $row;
  82.     }
  84.     /**
  85.      * @param int $key
  86.      */
  87.     public function remove($key): void
  88.     {
  89.         if (isset($this->collection[$key])) {
  90.             unset($this->collection[$key]);
  91.         }
  92.     }
  94.     /**
  95.      * Adjust the collection once all results have been added.
  96.      */
  97.     public function finalizeRows(): void
  98.     {
  99.         // Fix rows LOOP_TOTAL if parseResults() did not added all resultsCollection items to the collection array
  100.         // see https://github.com/thelia/thelia/issues/2337
  101.         if (true === $this->countable && $this->getResultDataCollectionCount() !== $realCount = $this->getCount()) {
  102.             foreach ($this->collection as &$item) {
  103.                 $item->set('LOOP_TOTAL', $realCount);
  104.             }
  105.         }
  106.     }
  108.     public function getCount()
  109.     {
  110.         return \count($this->collection);
  111.     }
  113.     public function getResultDataCollectionCount()
  114.     {
  115.         if ($this->resultsCollection instanceof ObjectCollection || $this->resultsCollection instanceof PropelModelPager) {
  116.             return $this->resultsCollection->count();
  117.         }
  118.         if (\is_array($this->resultsCollection)) {
  119.             return \count($this->resultsCollection);
  120.         }
  122.         return 0;
  123.     }
  125.     public function getResultDataCollection()
  126.     {
  127.         return $this->resultsCollection;
  128.     }
  130.     /**
  131.      * (PHP 5 &gt;= 5.0.0)<br/>
  132.      * Return the current element.
  133.      *
  134.      * @see http://php.net/manual/en/iterator.current.php
  135.      *
  136.      * @return \Thelia\Core\Template\Element\LoopResultRow
  137.      */
  138.     public function current()
  139.     {
  140.         return $this->collection[$this->position];
  141.     }
  143.     /**
  144.      * (PHP 5 &gt;= 5.0.0)<br/>
  145.      * Move forward to next element.
  146.      *
  147.      * @see http://php.net/manual/en/iterator.next.php
  148.      *
  149.      * @return void any returned value is ignored
  150.      */
  151.     public function next(): void
  152.     {
  153.         ++$this->position;
  154.     }
  156.     /**
  157.      * (PHP 5 &gt;= 5.0.0)<br/>
  158.      * Return the key of the current element.
  159.      *
  160.      * @see http://php.net/manual/en/iterator.key.php
  161.      *
  162.      * @return mixed scalar on success, or null on failure
  163.      */
  164.     public function key()
  165.     {
  166.         return $this->position;
  167.     }
  169.     /**
  170.      * (PHP 5 &gt;= 5.0.0)<br/>
  171.      * Checks if current position is valid.
  172.      *
  173.      * @see http://php.net/manual/en/iterator.valid.php
  174.      *
  175.      * @return bool The return value will be casted to boolean and then evaluated.
  176.      *              Returns true on success or false on failure.
  177.      */
  178.     public function valid(): bool
  179.     {
  180.         return isset($this->collection[$this->position]);
  181.     }
  183.     /**
  184.      * (PHP 5 &gt;= 5.0.0)<br/>
  185.      * Rewind the Iterator to the first element.
  186.      *
  187.      * @see http://php.net/manual/en/iterator.rewind.php
  188.      *
  189.      * @return void any returned value is ignored
  190.      */
  191.     public function rewind(): void
  192.     {
  193.         $this->position = 0;
  194.     }
  196.     protected function getTimestampOutputs()
  197.     {
  198.         return [
  199.             ['CREATE_DATE', 'getCreatedAt'],
  200.             ['UPDATE_DATE', 'getUpdatedAt'],
  201.         ];
  202.     }
  204.     protected function getVersionOutputs()
  205.     {
  206.         return [
  207.             ['VERSION', 'getVersion'],
  208.             ['VERSION_DATE', 'getVersionCreatedAt'],
  209.             ['VERSION_AUTHOR', 'getVersionCreatedBy'],
  210.         ];
  211.     }
  213.     /**
  214.      * {@inheritdoc}
  215.      */
  216.     public function jsonSerialize()
  217.     {
  218.         $return = [];
  219.         foreach ($this->collection as $collection) {
  220.             $return[] = $collection->getVarVal();
  221.         }
  223.         return $return;
  224.     }
  225. }