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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Model;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Framework\Module\FullModuleList;
use Magento\Framework\Setup\ConfigOptionsListInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
/**
* Collects all ConfigOptionsList class in modules and setup
*/
class ConfigOptionsListCollector
{
/**
* Directory List
*
* @var DirectoryList
*/
private $directoryList;
/**
* Filesystem
*
* @var Filesystem
*/
private $filesystem;
/**
* Module list including enabled and disabled modules
*
* @var FullModuleList
*/
private $fullModuleList;
/**
* Object manager provider
*
* @var ObjectManagerProvider
*/
private $objectManagerProvider;
/**
* Service locator
*
* @var ServiceLocatorInterface
*/
private $serviceLocator;
/**
* Constructor
*
* @param DirectoryList $directoryList
* @param Filesystem $filesystem
* @param FullModuleList $fullModuleList
* @param ObjectManagerProvider $objectManagerProvider
* @param ServiceLocatorInterface $serviceLocator
*/
public function __construct(
DirectoryList $directoryList,
Filesystem $filesystem,
FullModuleList $fullModuleList,
ObjectManagerProvider $objectManagerProvider,
ServiceLocatorInterface $serviceLocator
) {
$this->directoryList = $directoryList;
$this->filesystem = $filesystem;
$this->fullModuleList = $fullModuleList;
$this->objectManagerProvider = $objectManagerProvider;
$this->serviceLocator = $serviceLocator;
}
/**
* Auto discover ConfigOptionsList class and collect them.
* These classes should reside in <module>/Setup directories.
*
* @return \Magento\Framework\Setup\ConfigOptionsListInterface[]
*/
public function collectOptionsLists()
{
$optionsList = [];
// go through modules
foreach ($this->fullModuleList->getNames() as $moduleName) {
$optionsClassName = str_replace('_', '\\', $moduleName) . '\Setup\ConfigOptionsList';
if (class_exists($optionsClassName)) {
$optionsClass = $this->objectManagerProvider->get()->create($optionsClassName);
if ($optionsClass instanceof ConfigOptionsListInterface) {
$optionsList[$moduleName] = $optionsClass;
}
}
}
// check Setup
$setupOptionsClassName = \Magento\Setup\Model\ConfigOptionsList::class;
if (class_exists($setupOptionsClassName)) {
$setupOptionsClass = $this->serviceLocator->get($setupOptionsClassName);
if ($setupOptionsClass instanceof ConfigOptionsListInterface) {
$optionsList['setup'] = $setupOptionsClass;
}
}
return $optionsList;
}
}