vendor/se7enxweb/admin-ui/src/lib/Component/Registry.php line 92

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. declare(strict_types=1);
  9. namespace Ibexa\AdminUi\Component;
  11. use Ibexa\Contracts\TwigComponents\ComponentInterface;
  12. use Ibexa\TwigComponents\Component\Registry as TwigComponentsRegistry;
  14. /**
  15. * @deprecated 4.6.19 The {@see \Ibexa\AdminUi\Component\Registry} class is deprecated, will be removed in 6.0.
  16. * Use {@see \Ibexa\TwigComponents\Component\Registry} instead
  17. */
  18. class Registry
  19. {
  20. /**
  21. * @var string[]
  22. */
  23. private const COMPONENTS_WHITELIST =
  24. [
  25. 'action-configuration-tabs',
  26. 'attribute-definition-block',
  27. 'attribute-definition-options-block',
  28. 'attribute-group-block',
  29. 'calendar-widget-before',
  30. 'catalog-block',
  31. 'content-create-form-after',
  32. 'content-create-form-before',
  33. 'content-edit-form-after',
  34. 'content-edit-form-before',
  35. 'content-edit-sections',
  36. 'content-form-create-header-actions',
  37. 'content-form-edit-header-actions',
  38. 'content-tree-after',
  39. 'content-tree-before',
  40. 'content-type-edit-sections',
  41. 'content-type-tab-groups',
  42. 'customer-group-block',
  43. 'dashboard-all-tab-groups',
  44. 'dashboard-blocks',
  45. 'dashboard-my-tab-groups',
  46. 'discount-block',
  47. 'discount-condition-code-summary',
  48. 'discount-condition-code-usage-summary',
  49. 'discount-condition-summary',
  50. 'form-content-add-translation-body',
  51. 'global-search',
  52. 'global-search-autocomplete-templates',
  53. 'header-user-menu-middle',
  54. 'image-edit-actions-after',
  55. 'infobar-options-before',
  56. 'layout-content-after',
  57. 'link-manager-block',
  58. 'location-view-content-alerts',
  59. 'location-view-tab-groups',
  60. 'location-view-tabs-after',
  61. 'login-form-after',
  62. 'login-form-before',
  63. 'order-details-summary-grid',
  64. 'order-details-summary-stats',
  65. 'payment-method-tabs',
  66. 'product-block',
  67. 'product-create-form-after',
  68. 'product-create-form-header-actions',
  69. 'product-edit-form-after',
  70. 'product-edit-form-header-actions',
  71. 'product-type-block',
  72. 'script-body',
  73. 'script-head',
  74. 'shipment-summary-grid',
  75. 'shipping-method-block',
  76. 'stylesheet-body',
  77. 'stylesheet-head',
  78. 'systeminfo-tab-groups',
  79. 'user-menu',
  80. 'user-profile-blocks',
  81. ];
  83. private const GROUP_PREFIX = 'admin-ui-';
  85. protected TwigComponentsRegistry $inner;
  87. public function __construct(TwigComponentsRegistry $inner)
  88. {
  89. $this->inner = $inner;
  90. }
  92. public function addComponent(string $group, string $serviceId, ComponentInterface $component): void
  93. {
  94. $this->triggerDeprecation();
  95. $group = $this->prefixGroupIfNeeded($group);
  97. $this->inner->addComponent($group, $serviceId, $component);
  98. }
  100. /**
  101. * @return \Ibexa\Contracts\TwigComponents\ComponentInterface[]
  102. */
  103. public function getComponents(string $group): array
  104. {
  105. $this->triggerDeprecation();
  106. $group = $this->prefixGroupIfNeeded($group);
  108. return $this->inner->getComponents($group);
  109. }
  111. /**
  112. * @param \Ibexa\Contracts\TwigComponents\ComponentInterface[] $components
  113. */
  114. public function setComponents(string $group, array $components)
  115. {
  116. $this->triggerDeprecation();
  117. $group = $this->prefixGroupIfNeeded($group);
  119. $this->inner->setComponents($group, $components);
  120. }
  122. private function triggerDeprecation(): void
  123. {
  124. trigger_deprecation(
  125. 'ibexa/admin-ui',
  126. '4.6.19',
  127. sprintf(
  128. 'The %s is deprecated, will be removed in 5.0. Use %s instead',
  129. self::class,
  130. TwigComponentsRegistry::class
  131. )
  132. );
  133. }
  135. private function prefixGroupIfNeeded(string $group): string
  136. {
  137. if (in_array($group, self::COMPONENTS_WHITELIST, true)) {
  138. return self::GROUP_PREFIX . $group;
  139. }
  141. return $group;
  142. }
  143. }
  145. class_alias(Registry::class, 'EzSystems\EzPlatformAdminUi\Component\Registry');