-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
Config.php
176 lines (158 loc) · 4.49 KB
/
Config.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\App\Route;
use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
use Magento\Framework\Serialize\SerializerInterface;
/**
* Routes configuration model
*/
class Config implements ConfigInterface, ResetAfterRequestInterface
{
/**
* @var \Magento\Framework\App\Route\Config\Reader
*/
protected $_reader;
/**
* @var \Magento\Framework\Cache\FrontendInterface
*/
protected $_cache;
/**
* @var string
*/
protected $_cacheId;
/**
* @var \Magento\Framework\Config\ScopeInterface
*/
protected $_configScope;
/**
* @var \Magento\Framework\App\AreaList
*/
protected $_areaList;
/**
* @var array|null
*/
protected $_routes;
/**
* @var SerializerInterface|null
*/
private $serializer;
/**
* @param Config\Reader $reader
* @param \Magento\Framework\Config\CacheInterface $cache
* @param \Magento\Framework\Config\ScopeInterface $configScope
* @param \Magento\Framework\App\AreaList $areaList
* @param string $cacheId
*/
public function __construct(
Config\Reader $reader,
\Magento\Framework\Config\CacheInterface $cache,
\Magento\Framework\Config\ScopeInterface $configScope,
\Magento\Framework\App\AreaList $areaList,
$cacheId = 'RoutesConfig'
) {
$this->_reader = $reader;
$this->_cache = $cache;
$this->_cacheId = $cacheId;
$this->_configScope = $configScope;
$this->_areaList = $areaList;
}
/**
* @inheritDoc
*/
public function _resetState(): void
{
$this->_routes = null;
$this->serializer = null;
}
/**
* Fetch routes from configs by area code and router id
*
* @param string $scope
* @return array
*/
protected function _getRoutes($scope = null)
{
$scope = $scope ?: $this->_configScope->getCurrentScope();
if (isset($this->_routes[$scope])) {
return $this->_routes[$scope];
}
$cacheId = $scope . '::' . $this->_cacheId;
$cachedRoutes = $this->_cache->load($cacheId);
if ($cachedRoutes) {
$cachedRoutes = $this->getSerializer()->unserialize($cachedRoutes);
if (is_array($cachedRoutes)) {
$this->_routes[$scope] = $cachedRoutes;
return $cachedRoutes;
}
}
$routers = $this->_reader->read($scope);
$routes = $routers[$this->_areaList->getDefaultRouter($scope)]['routes'] ?? null;
$routesData = $this->getSerializer()->serialize($routes);
$this->_cache->save($routesData, $cacheId);
$this->_routes[$scope] = $routes;
return $routes;
}
/**
* Retrieve route front name
*
* @param string $routeId
* @param null|string $scope
* @return string
*/
public function getRouteFrontName($routeId, $scope = null)
{
$routes = $this->_getRoutes($scope);
return isset($routes[$routeId]) ? $routes[$routeId]['frontName'] : $routeId;
}
/**
* @inheritdoc
*
* @param string $frontName
* @param string $scope
* @return bool|int|string
*/
public function getRouteByFrontName($frontName, $scope = null)
{
foreach ($this->_getRoutes($scope) as $routeId => $routeData) {
if ($routeData['frontName'] == $frontName) {
return $routeId;
}
}
return false;
}
/**
* @inheritdoc
*
* @param string $frontName
* @param string $scope
* @return string[]
*/
public function getModulesByFrontName($frontName, $scope = null)
{
$routes = $this->_getRoutes($scope);
$modules = [];
foreach ($routes as $routeData) {
if ($routeData['frontName'] == $frontName && isset($routeData['modules'])) {
$modules = $routeData['modules'];
break;
}
}
return array_unique($modules);
}
/**
* Get serializer
*
* @return \Magento\Framework\Serialize\SerializerInterface
*/
private function getSerializer()
{
if ($this->serializer === null) {
$this->serializer = \Magento\Framework\App\ObjectManager::getInstance()
->get(SerializerInterface::class);
}
return $this->serializer;
}
}