BasePackageInfo Class Reference

Public Member Functions
	__construct (ReadFactory $readFactory)
	getPaths ()

Data Fields
const	MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE = 'magento/magento2-base/composer.json'
const	COMPOSER_KEY_EXTRA = 'extra'
const	COMPOSER_KEY_MAP = 'map'

Detailed Description

Information about the Magento base package.

Definition at line 14 of file BasePackageInfo.php.

Constructor & Destructor Documentation

__construct()

__construct

(

ReadFactory

$readFactory

)

Constructor

Parameters

ReadFactory

$readFactory

Definition at line 32 of file BasePackageInfo.php.

    {
        $this->reader = $readFactory->create(BP);
    }

Member Function Documentation

getPaths()

getPaths

(

)

Get the list of files and directory paths from magento-base extra/map section.

Returns

string []

Exceptions

Definition at line 43 of file BasePackageInfo.php.

    {
        // Locate composer.json for magento2-base module
        $filesPathList = [];
        $vendorDir = require VENDOR_PATH;
        $basePackageComposerFilePath = $vendorDir . '/' . self::MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE;
        if (!$this->reader->isExist($basePackageComposerFilePath)) {
            throw new \Magento\Setup\Exception(
                'Could not locate ' . self::MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE . ' file.'
            );
        }
        if (!$this->reader->isReadable($basePackageComposerFilePath)) {
            throw new \Magento\Setup\Exception(
                'Could not read ' . self::MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE . ' file.'
            );
        }

        // Fill array with list of files and directories from extra/map section
        $composerJsonFileData = json_decode($this->reader->readFile($basePackageComposerFilePath), true);
        if (!isset($composerJsonFileData[self::COMPOSER_KEY_EXTRA][self::COMPOSER_KEY_MAP])) {
            return $filesPathList;
        }
        $extraMappings = $composerJsonFileData[self::COMPOSER_KEY_EXTRA][self::COMPOSER_KEY_MAP];
        foreach ($extraMappings as $map) {
            $filesPathList[] = $map[1];
        }
        return $filesPathList;
    }

Field Documentation

COMPOSER_KEY_EXTRA

const COMPOSER_KEY_EXTRA = 'extra'

Definition at line 18 of file BasePackageInfo.php.

COMPOSER_KEY_MAP

const COMPOSER_KEY_MAP = 'map'

Definition at line 20 of file BasePackageInfo.php.

MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE

const MAGENTO_BASE_PACKAGE_COMPOSER_JSON_FILE = 'magento/magento2-base/composer.json'

Definition at line 16 of file BasePackageInfo.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/BasePackageInfo.php