Pool.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Ui\DataProvider\Modifier;
  7. use Magento\Framework\Exception\LocalizedException;
  8. /**
  9. * Class Pool
  10. */
  11. class Pool implements \Magento\Ui\DataProvider\Modifier\PoolInterface
  12. {
  13. /**
  14. * @var array
  15. */
  16. protected $modifiers = [];
  17. /**
  18. * @var array
  19. */
  20. protected $modifiersInstances = [];
  21. /**
  22. * @var ModifierFactory
  23. */
  24. protected $factory;
  25. /**
  26. * @param ModifierFactory $factory
  27. * @param array $modifiers
  28. */
  29. public function __construct(
  30. ModifierFactory $factory,
  31. array $modifiers = []
  32. ) {
  33. $this->factory = $factory;
  34. $this->modifiers = $this->sort($modifiers);
  35. }
  36. /**
  37. * Retrieve modifiers
  38. *
  39. * @return array
  40. */
  41. public function getModifiers()
  42. {
  43. return $this->modifiers;
  44. }
  45. /**
  46. * Retrieve modifiers instantiated
  47. *
  48. * @return ModifierInterface[]
  49. * @throws LocalizedException
  50. */
  51. public function getModifiersInstances()
  52. {
  53. if ($this->modifiersInstances) {
  54. return $this->modifiersInstances;
  55. }
  56. foreach ($this->modifiers as $modifier) {
  57. if (empty($modifier['class'])) {
  58. throw new LocalizedException(__('The parameter "class" is missing. Set the "class" and try again.'));
  59. }
  60. if (empty($modifier['sortOrder'])) {
  61. throw new LocalizedException(
  62. __('The parameter "sortOrder" is missing. Set the "sortOrder" and try again.')
  63. );
  64. }
  65. $this->modifiersInstances[$modifier['class']] = $this->factory->create($modifier['class']);
  66. }
  67. return $this->modifiersInstances;
  68. }
  69. /**
  70. * Sorting modifiers according to sort order
  71. *
  72. * @param array $data
  73. * @return array
  74. */
  75. protected function sort(array $data)
  76. {
  77. usort($data, function (array $a, array $b) {
  78. return $this->getSortOrder($a) <=> $this->getSortOrder($b);
  79. });
  80. return $data;
  81. }
  82. /**
  83. * Retrieve sort order from array
  84. *
  85. * @param array $variable
  86. * @return int
  87. */
  88. protected function getSortOrder(array $variable)
  89. {
  90. return !empty($variable['sortOrder']) ? $variable['sortOrder'] : 0;
  91. }
  92. }