vendor/pimcore/pimcore/lib/Document/Editable/Block/BlockStateStack.php line 32

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. * Handles block state (current block level, current block index)
  24. */
  25. final class BlockStateStack implements \Countable, \JsonSerializable
  26. {
  27. /**
  28. * @var BlockState[]
  29. */
  30. private $states = [];
  32. public function __construct()
  33. {
  34. // we need to make sure there's a default state on the stack
  35. $this->push();
  36. }
  38. /**
  39. * Adds a new state to the stack
  40. *
  41. * @param BlockState|null $blockState
  42. */
  43. public function push(BlockState $blockState = null)
  44. {
  45. if (null === $blockState) {
  46. $blockState = new BlockState();
  47. }
  49. array_push($this->states, $blockState);
  50. }
  52. /**
  53. * Removes current state from the stack
  54. *
  55. * @return BlockState
  56. */
  57. public function pop(): BlockState
  58. {
  59. if (count($this->states) <= 1) {
  60. throw new \LogicException('Can\'t pop the last state off the stack');
  61. }
  63. return array_pop($this->states);
  64. }
  66. /**
  67. * Returns current state
  68. *
  69. * @return BlockState
  70. */
  71. public function getCurrentState(): BlockState
  72. {
  73. if (empty($this->states)) {
  74. // this should never happen
  75. throw new \RuntimeException('State stack is empty');
  76. }
  78. return array_slice($this->states, -1)[0];
  79. }
  81. public function count(): int
  82. {
  83. return count($this->states);
  84. }
  86. /**
  87. * {@inheritdoc}
  88. */
  89. public function jsonSerialize()
  90. {
  91. return $this->states;
  92. }
  94. public function loadArray(array $array)
  95. {
  96. $this->states = [];
  98. foreach ($array as $blockStateData) {
  99. $blockState = new BlockState();
  101. foreach ($blockStateData['blocks'] as $blockData) {
  102. $blockState->pushBlock(new BlockName($blockData['name'], $blockData['realName']));
  103. }
  105. foreach ($blockStateData['indexes'] as $indexData) {
  106. $blockState->pushIndex($indexData);
  107. }
  109. $this->states[] = $blockState;
  110. }
  111. }
  112. }