PackageInfo Class Reference

Public Member Functions
	__construct (Dir\Reader $reader, ComponentRegistrar $componentRegistrar, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	getModuleName ($packageName)
	getNonExistingDependencies ()
	getPackageName ($moduleName)
	getRequire ($moduleName)
	getRequiredBy ($requiredModuleName)
	getConflict ($moduleName)
	getVersion ($moduleName)

Protected Member Functions
	addNonExistingDependency ($dependency)
	convertPackageNameToModuleName ($packageName)
	isMagentoPackage ($packageName)

Protected Attributes
	$nonExistingDependencies = []

Detailed Description

Provide information of dependencies and conflicts in composer.json files, mapping of package name to module name, and mapping of module name to package version

Definition at line 14 of file PackageInfo.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Dir\Reader	$reader,
		ComponentRegistrar	$componentRegistrar,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Parameters

Dir\Reader	$reader
ComponentRegistrar	$componentRegistrar
\Magento\Framework\Serialize\Serializer\Json | null	$serializer

Exceptions

Definition at line 72 of file PackageInfo.php.

      {
        $this->reader = $reader;
        $this->componentRegistrar = $componentRegistrar;
        $this->serializer = $serializer?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
    }

Member Function Documentation

addNonExistingDependency()

addNonExistingDependency (   $dependency )

protected

Add non existing dependency

Parameters

string

$dependency

Returns

void

Definition at line 153 of file PackageInfo.php.

    {
        if (!isset($this->nonExistingDependencies[$dependency])) {
            $this->nonExistingDependencies[$dependency] = $dependency;
        }
    }

convertPackageNameToModuleName()

convertPackageNameToModuleName (   $packageName )

protected

Build module name based on internal package name

Parameters

string

$packageName

Returns

string|null

Definition at line 176 of file PackageInfo.php.

    {
        $moduleName = str_replace('magento/module-', '', $packageName);
        $moduleName = str_replace('-', ' ', $moduleName);
        $moduleName = str_replace(' ', '', ucwords($moduleName));

        return 'Magento_' . $moduleName;
    }

getConflict()

getConflict

(

$moduleName

)

Get all module names a module conflicts

Parameters

string

$moduleName

Returns

array

Definition at line 264 of file PackageInfo.php.

    {
        $this->load();
        $conflict = [];
        if (isset($this->conflictMap[$moduleName])) {
            $conflict = array_combine(
                $this->convertToModuleNames(array_keys($this->conflictMap[$moduleName])),
                $this->conflictMap[$moduleName]
            );
        }
        return $conflict;
    }

getModuleName()

getModuleName

(

$packageName

)

Get module name of a package

Parameters

string

$packageName

Returns

string

Definition at line 132 of file PackageInfo.php.

    {
        $this->load();

        $moduleName = null;
        if (isset($this->packageModuleMap[$packageName])) {
            $moduleName = $this->packageModuleMap[$packageName];
        } elseif ($this->isMagentoPackage($packageName)) {
            $moduleName = $this->convertPackageNameToModuleName($packageName);
            $this->addNonExistingDependency($moduleName);
        }

        return $moduleName;
    }

getNonExistingDependencies()

getNonExistingDependencies

(

)

Return list of non existing dependencies

Returns

array

Definition at line 165 of file PackageInfo.php.

    {
        return $this->nonExistingDependencies;
    }

getPackageName()

getPackageName

(

$moduleName

)

Get package name of a module

Parameters

string

$moduleName

Returns

string

Definition at line 202 of file PackageInfo.php.

    {
        $this->load();
        return array_search($moduleName, $this->packageModuleMap) ?: '';
    }

getRequire()

getRequire

(

$moduleName

)

Get all module names a module requires

Parameters

string

$moduleName

Returns

array

Definition at line 229 of file PackageInfo.php.

    {
        $this->load();
        $require = [];
        if (isset($this->requireMap[$moduleName])) {
            $require = $this->convertToModuleNames($this->requireMap[$moduleName]);
        }
        return $require;
    }

getRequiredBy()

getRequiredBy

(

$requiredModuleName

)

Get all module names a module required by

Parameters

string

$requiredModuleName

Returns

array

Definition at line 245 of file PackageInfo.php.

    {
        $this->load();
        $requiredBy = [];
        foreach ($this->requireMap as $moduleName => $moduleRequireList) {
            if (in_array($requiredModuleName, $moduleRequireList)) {
                $requiredBy[] = $moduleName;
            }
        }

        return $requiredBy;
    }

getVersion()

getVersion

(

$moduleName

)

Get package version of a module

Parameters

string

$moduleName

Returns

string

Definition at line 283 of file PackageInfo.php.

    {
        $this->load();
        return $this->modulePackageVersionMap[$moduleName] ?? '';
    }

isMagentoPackage()

isMagentoPackage (   $packageName )

protected

Check if package is internal magento module

Parameters

string

$packageName

Returns

bool

Definition at line 191 of file PackageInfo.php.

    {
        return strpos($packageName, 'magento/module-') === 0;
    }

Field Documentation

$nonExistingDependencies

$nonExistingDependencies = []

protected

Definition at line 59 of file PackageInfo.php.

---

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

• vendor/magento/framework/Module/PackageInfo.php