AreaList.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. <?php
  2. /**
  3. * Application area list
  4. *
  5. * Copyright © Magento, Inc. All rights reserved.
  6. * See COPYING.txt for license details.
  7. */
  8. namespace Magento\Framework\App;
  9. class AreaList
  10. {
  11. /**
  12. * Area configuration list
  13. *
  14. * @var array
  15. */
  16. protected $_areas = [];
  17. /**
  18. * @var \Magento\Framework\App\AreaInterface[]
  19. */
  20. protected $_areaInstances = [];
  21. /**
  22. * @var string
  23. */
  24. protected $_defaultAreaCode;
  25. /**
  26. * @var Area\FrontNameResolverFactory
  27. */
  28. protected $_resolverFactory;
  29. /**
  30. * @var \Magento\Framework\ObjectManagerInterface
  31. */
  32. protected $objectManager;
  33. /**
  34. * @param \Magento\Framework\ObjectManagerInterface $objectManager
  35. * @param Area\FrontNameResolverFactory $resolverFactory
  36. * @param array $areas
  37. * @param string|null $default
  38. */
  39. public function __construct(
  40. \Magento\Framework\ObjectManagerInterface $objectManager,
  41. Area\FrontNameResolverFactory $resolverFactory,
  42. array $areas = [],
  43. $default = null
  44. ) {
  45. $this->objectManager = $objectManager;
  46. $this->_resolverFactory = $resolverFactory;
  47. if ($areas) {
  48. $this->_areas = $areas;
  49. }
  50. if ($default) {
  51. $this->_defaultAreaCode = $default;
  52. }
  53. }
  54. /**
  55. * Retrieve area code by front name
  56. *
  57. * @param string $frontName
  58. * @return null|string
  59. * @api
  60. */
  61. public function getCodeByFrontName($frontName)
  62. {
  63. foreach ($this->_areas as $areaCode => &$areaInfo) {
  64. if (!isset($areaInfo['frontName']) && isset($areaInfo['frontNameResolver'])) {
  65. $resolver = $this->_resolverFactory->create($areaInfo['frontNameResolver']);
  66. $areaInfo['frontName'] = $resolver->getFrontName(true);
  67. }
  68. if ($areaInfo['frontName'] == $frontName) {
  69. return $areaCode;
  70. }
  71. }
  72. return $this->_defaultAreaCode;
  73. }
  74. /**
  75. * Retrieve area front name by code
  76. *
  77. * @param string $areaCode
  78. * @return string
  79. * @api
  80. */
  81. public function getFrontName($areaCode)
  82. {
  83. return $this->_areas[$areaCode]['frontName'] ?? null;
  84. }
  85. /**
  86. * Retrieve area codes
  87. *
  88. * @return string[]
  89. * @api
  90. */
  91. public function getCodes()
  92. {
  93. return array_keys($this->_areas);
  94. }
  95. /**
  96. * Retrieve default area router id
  97. *
  98. * @param string $areaCode
  99. * @return string
  100. * @api
  101. */
  102. public function getDefaultRouter($areaCode)
  103. {
  104. return $this->_areas[$areaCode]['router'] ?? null;
  105. }
  106. /**
  107. * Retrieve application area
  108. *
  109. * @param string $code
  110. * @return \Magento\Framework\App\Area
  111. */
  112. public function getArea($code)
  113. {
  114. if (!isset($this->_areaInstances[$code])) {
  115. $this->_areaInstances[$code] = $this->objectManager->create(
  116. \Magento\Framework\App\AreaInterface::class,
  117. ['areaCode' => $code]
  118. );
  119. }
  120. return $this->_areaInstances[$code];
  121. }
  122. }