Dependency Class Reference

Public Member Functions
	__construct (ComposerInformation $composerInformation, Filesystem $filesystem, PackageFactory $packageFactory, ComponentRegistrarInterface $componentRegistrar, \Magento\Framework\Filesystem\Directory\ReadFactory $directoryReadFactory=null)
	getSampleDataPackages ()

Data Fields
const	SAMPLE_DATA_SUGGEST = 'Sample Data version:'

Protected Member Functions
	getSuggestsFromModules ()

Protected Attributes
	$composerInformation

Detailed Description

Sample Data dependency

Definition at line 20 of file Dependency.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ComposerInformation	$composerInformation,
		Filesystem	$filesystem,
		PackageFactory	$packageFactory,
		ComponentRegistrarInterface	$componentRegistrar,
		\Magento\Framework\Filesystem\Directory\ReadFactory	$directoryReadFactory = null
	)

Initialize dependencies.

Parameters

ComposerInformation	$composerInformation
Filesystem	$filesystem

Deprecated:

2.3.0 $directoryReadFactory is used instead

Parameters

PackageFactory	$packageFactory
ComponentRegistrarInterface	$componentRegistrar
Filesystem\Directory\ReadFactory | null	$directoryReadFactory	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 57 of file Dependency.php.

      {
        $this->composerInformation = $composerInformation;
        $this->packageFactory = $packageFactory;
        $this->componentRegistrar = $componentRegistrar;
        $this->directoryReadFactory = $directoryReadFactory ?:
            ObjectManager::getInstance()->get(ReadFactory::class);
    }

Member Function Documentation

getSampleDataPackages()

getSampleDataPackages

(

)

Retrieve list of sample data packages from suggests

Returns

array

Exceptions

Definition at line 77 of file Dependency.php.

    {
        $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;
    }

getSuggestsFromModules()

getSuggestsFromModules ( )

protected

Retrieve suggested sample data packages from modules composer.json

Returns

array

Exceptions

Definition at line 96 of file Dependency.php.

    {
        $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;
    }

Field Documentation

$composerInformation

$composerInformation

protected

Definition at line 30 of file Dependency.php.

SAMPLE_DATA_SUGGEST

const SAMPLE_DATA_SUGGEST = 'Sample Data version:'

Sample data version text

Definition at line 25 of file Dependency.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sample-data/Model/Dependency.php