vendor/pimcore/pimcore/lib/Document/Editable/Block/BlockState.php line 29

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Document\Editable\Block;
  20. /**
  21.  * @internal
  22.  *
  23.  * Keeps track of the current block nesting level and index (will be used from
  24.  * editables to build their hierarchical editable name).
  25.  *
  26.  * On sub requests, a new BlockState is added to the state stack which is valid
  27.  * for the sub request.
  28.  */
  29. final class BlockState implements \JsonSerializable
  30. {
  31.     /**
  32.      * @var BlockName[]
  33.      */
  34.     private $blocks = [];
  36.     /**
  37.      * @var int[]
  38.      */
  39.     private $indexes = [];
  41.     /**
  42.      * @return BlockName[]
  43.      */
  44.     public function getBlocks(): array
  45.     {
  46.         return $this->blocks;
  47.     }
  49.     public function hasBlocks(): bool
  50.     {
  51.         return !empty($this->blocks);
  52.     }
  54.     public function pushBlock(BlockName $block)
  55.     {
  56.         array_push($this->blocks, $block);
  57.     }
  59.     public function popBlock(): BlockName
  60.     {
  61.         if (empty($this->blocks)) {
  62.             throw new \UnderflowException('There are no blocks to pop from as blocks list is empty');
  63.         }
  65.         return array_pop($this->blocks);
  66.     }
  68.     public function clearBlocks()
  69.     {
  70.         $this->blocks = [];
  71.     }
  73.     /**
  74.      * @return int[]
  75.      */
  76.     public function getIndexes(): array
  77.     {
  78.         return $this->indexes;
  79.     }
  81.     public function hasIndexes(): bool
  82.     {
  83.         return !empty($this->indexes);
  84.     }
  86.     public function pushIndex(int $index)
  87.     {
  88.         array_push($this->indexes, $index);
  89.     }
  91.     public function popIndex(): int
  92.     {
  93.         if (empty($this->indexes)) {
  94.             throw new \UnderflowException('There are no indexes to pop from as index list is empty');
  95.         }
  97.         return array_pop($this->indexes);
  98.     }
  100.     public function clearIndexes()
  101.     {
  102.         $this->indexes = [];
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function jsonSerialize()
  109.     {
  110.         return [
  111.             'blocks' => $this->blocks,
  112.             'indexes' => $this->indexes,
  113.         ];
  114.     }
  115. }