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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\SampleData\Model;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Component\ComponentRegistrarInterface;
use Magento\Framework\Composer\ComposerInformation;
use Magento\Framework\Config\Composer\Package;
use Magento\Framework\Config\Composer\PackageFactory;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\ReadFactory;
/**
* Sample Data dependency
*/
class Dependency
{
/**
* Sample data version text
*/
const SAMPLE_DATA_SUGGEST = 'Sample Data version:';
/**
* @var ComposerInformation
*/
protected $composerInformation;
/**
* @var PackageFactory
*/
private $packageFactory;
/**
* @var ComponentRegistrarInterface
*/
private $componentRegistrar;
/**
* @var ReadFactory
*/
private $directoryReadFactory;
/**
* Initialize dependencies.
*
* @param ComposerInformation $composerInformation
* @param Filesystem $filesystem @deprecated 2.3.0 $directoryReadFactory is used instead
* @param PackageFactory $packageFactory
* @param ComponentRegistrarInterface $componentRegistrar
* @param Filesystem\Directory\ReadFactory|null $directoryReadFactory
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function __construct(
ComposerInformation $composerInformation,
Filesystem $filesystem,
PackageFactory $packageFactory,
ComponentRegistrarInterface $componentRegistrar,
\Magento\Framework\Filesystem\Directory\ReadFactory $directoryReadFactory = null
) {
$this->composerInformation = $composerInformation;
$this->packageFactory = $packageFactory;
$this->componentRegistrar = $componentRegistrar;
$this->directoryReadFactory = $directoryReadFactory ?:
ObjectManager::getInstance()->get(ReadFactory::class);
}
/**
* Retrieve list of sample data packages from suggests
*
* @return array
* @throws \Magento\Framework\Exception\FileSystemException
*/
public function getSampleDataPackages()
{
$installExtensions = [];
$suggests = $this->composerInformation->getSuggestedPackages();
$suggests = array_merge($suggests, $this->getSuggestsFromModules());
foreach ($suggests as $name => $version) {
if (strpos($version, self::SAMPLE_DATA_SUGGEST) === 0) {
$installExtensions[$name] = trim(substr($version, strlen(self::SAMPLE_DATA_SUGGEST)));
}
}
return $installExtensions;
}
/**
* Retrieve suggested sample data packages from modules composer.json
*
* @return array
* @throws \Magento\Framework\Exception\FileSystemException
*/
protected function getSuggestsFromModules()
{
$suggests = [];
foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleDir) {
$package = $this->getModuleComposerPackage($moduleDir);
$suggest = json_decode(json_encode($package->get('suggest')), true);
if (!empty($suggest)) {
$suggests += $suggest;
}
}
return $suggests;
}
/**
* Load package
*
* @param string $moduleDir
* @return Package
* @throws \Magento\Framework\Exception\FileSystemException
*/
private function getModuleComposerPackage($moduleDir)
{
/*
* Also look in parent directory of registered module directory to allow modules to follow the pds/skeleton
* standard and have their source code in a "src" subdirectory of the repository
*
* see: https://github.com/php-pds/skeleton
*/
foreach ([$moduleDir, $moduleDir . DIRECTORY_SEPARATOR . '..'] as $dir) {
/** @var Filesystem\Directory\ReadInterface $directory */
$directory = $this->directoryReadFactory->create($dir);
if ($directory->isExist('composer.json') && $directory->isReadable('composer.json')) {
/** @var Package $package */
return $this->packageFactory->create(['json' => json_decode($directory->readFile('composer.json'))]);
}
}
return $this->packageFactory->create(['json' => new \stdClass]);
}
}