UiComponentGenerator.php 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Ui\Model;
  7. use Magento\Framework\View\Element\UiComponent\ContextFactory;
  8. use Magento\Framework\View\Element\UiComponentFactory;
  9. use Magento\Framework\View\Element\UiComponentInterface;
  10. /**
  11. * Dynamically generate UI Component
  12. *
  13. * Sometimes we need to generate components dynamically (not from layout).
  14. * The basic example, is creating widget UI component, based on CMS page or CMS block
  15. * directive
  16. */
  17. class UiComponentGenerator
  18. {
  19. /**
  20. * @var ContextFactory
  21. */
  22. private $contextFactory;
  23. /**
  24. * @var UiComponentFactory
  25. */
  26. private $uiComponentFactory;
  27. /**
  28. * UiComponentGenerator constructor.
  29. * @param ContextFactory $contextFactory
  30. * @param UiComponentFactory $uiComponentFactory
  31. */
  32. public function __construct(
  33. ContextFactory $contextFactory,
  34. UiComponentFactory $uiComponentFactory
  35. ) {
  36. $this->contextFactory = $contextFactory;
  37. $this->uiComponentFactory = $uiComponentFactory;
  38. }
  39. /**
  40. * Allows to generate Ui component
  41. *
  42. * @param string $name
  43. * @param \Magento\Framework\View\LayoutInterface $layout
  44. * @return UiComponentInterface
  45. * @throws \Magento\Framework\Exception\LocalizedException
  46. */
  47. public function generateUiComponent($name, \Magento\Framework\View\LayoutInterface $layout)
  48. {
  49. $context = $this->contextFactory->create([
  50. 'namespace' => $name,
  51. 'pageLayout' => $layout,
  52. ]);
  53. $component = $this->uiComponentFactory->create(
  54. $name,
  55. null,
  56. [
  57. 'context' => $context
  58. ]
  59. );
  60. return $this->prepareComponent($component);
  61. }
  62. /**
  63. * Call prepare method in the component UI
  64. *
  65. * @param UiComponentInterface $component
  66. * @return UiComponentInterface
  67. */
  68. private function prepareComponent(UiComponentInterface $component)
  69. {
  70. $childComponents = $component->getChildComponents();
  71. if (!empty($childComponents)) {
  72. foreach ($childComponents as $child) {
  73. $this->prepareComponent($child);
  74. }
  75. }
  76. $component->prepare();
  77. return $component;
  78. }
  79. }