Public Member Functions
	__construct (\Magento\Framework\Composer\ComposerInformation $composerInformation, \Magento\Setup\Model\DateTime\TimeZoneProvider $timeZoneProvider, \Magento\Setup\Model\PackagesAuth $packagesAuth, \Magento\Framework\Filesystem $filesystem, \Magento\Setup\Model\ObjectManagerProvider $objectManagerProvider, \Magento\Setup\Model\Grid\TypeMapper $typeMapper)

	syncPackagesData ()

	getInstalledPackages ()

	getPackagesForUpdate ()

	addPackageExtraInfo (array $package)

	getPackagesForInstall ()

	getMetaPackagesMap ()

Data Fields
const	COMPOSER_SHOW = 'show'

const	PARAM_COMMAND = 'command'

const	PARAM_PACKAGE = 'package'

const	PARAM_AVAILABLE = '--available'

Protected Member Functions
	isNewUserPackage ($package, $packageNames)

	unsetDevVersions ($package)

Protected Attributes
	$urlPrefix = 'https://'

Detailed Description

Class PackagesData returns system packages and available for update versions @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 12 of file PackagesData.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Composer\ComposerInformation	$composerInformation,
		\Magento\Setup\Model\DateTime\TimeZoneProvider	$timeZoneProvider,
		\Magento\Setup\Model\PackagesAuth	$packagesAuth,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Setup\Model\ObjectManagerProvider	$objectManagerProvider,
		\Magento\Setup\Model\Grid\TypeMapper	$typeMapper
	)

PackagesData constructor.

Parameters

\Magento\Framework\Composer\ComposerInformation $composerInformation

Definition at line 73 of file PackagesData.php.

       {
         $this->objectManagerProvider = $objectManagerProvider;
         $this->composerInformation = $composerInformation;
         $this->timeZoneProvider = $timeZoneProvider;
         $this->packagesAuth = $packagesAuth;
         $this->filesystem = $filesystem;
         $this->typeMapper = $typeMapper;
     }

Member Function Documentation

◆ addPackageExtraInfo()

addPackageExtraInfo ( array $package )

Add package extra info

Parameters

array $package

Returns: array

Definition at line 321 of file PackagesData.php.

     {
         $extraInfo = $this->getPackageExtraInfo($package['name'], $package['version']);
 
         $package['package_title'] =  isset($extraInfo['x-magento-ext-title']) ?
             $extraInfo['x-magento-ext-title'] : $package['name'];
         $package['package_type'] = isset($extraInfo['x-magento-ext-type']) ? $extraInfo['x-magento-ext-type'] :
             $this->typeMapper->map($package['type']);
         $package['package_link'] = isset($extraInfo['x-magento-ext-package-link']) ?
             $extraInfo['x-magento-ext-package-link'] : '';
 
         return $package;
     }

◆ getInstalledPackages()

getInstalledPackages ( )

Get list of manually installed package

Returns: array

Definition at line 177 of file PackagesData.php.

     {
         $installedPackages = array_intersect_key(
             $this->composerInformation->getInstalledMagentoPackages(),
             $this->composerInformation->getRootPackage()->getRequires()
         );
 
         foreach ($installedPackages as &$package) {
             $package = $this->addPackageExtraInfo($package);
         }
 
         return $this->filterPackagesList($installedPackages);
     }

◆ getMetaPackagesMap()

getMetaPackagesMap ( )

Get all metapackages

Returns: array

Definition at line 451 of file PackagesData.php.

     {
         if ($this->metapackagesMap === null) {
             $packages = $this->getPackagesJson();
             array_walk($packages, function ($packageVersions) {
                 $package = array_shift($packageVersions);
                 if ($package['type'] == \Magento\Framework\Composer\ComposerInformation::METAPACKAGE_PACKAGE_TYPE
                     && isset($package['require'])
                 ) {
                     foreach (array_keys($package['require']) as $key) {
                         $this->metapackagesMap[$key] = $package['name'];
                     }
                 }
             });
         }
 
         return $this->metapackagesMap;
     }

◆ getPackagesForInstall()

getPackagesForInstall ( )

Sync list of available for install versions for packages

Returns: array

Exceptions

Definition at line 378 of file PackagesData.php.

     {
         $actualInstallPackages = [];
 
         try {
             $installPackages = $this->syncPackagesForInstall()['packages'];
             $metaPackageByPackage = $this->getMetaPackageForPackage($installPackages);
             foreach ($installPackages as $package) {
                 $package['metapackage'] =
                     isset($metaPackageByPackage[$package['name']]) ? $metaPackageByPackage[$package['name']] : '';
                 $actualInstallPackages[$package['name']] = $package;
                 $actualInstallPackages[$package['name']]['version'] = $package['versions'][0];
             }
             $installPackagesInfo['packages'] = $actualInstallPackages;
             return $installPackagesInfo;
         } catch (\Exception $e) {
             throw new \RuntimeException('Error in getting new packages to install');
         }
     }

◆ getPackagesForUpdate()

getPackagesForUpdate ( )

Get packages that need updates

Returns: array

Definition at line 196 of file PackagesData.php.

     {
         $packagesForUpdate = [];
         $packages = $this->getInstalledPackages();
 
         foreach ($packages as $package) {
             $latestProductVersion = $this->getLatestNonDevVersion($package['name']);
             if ($latestProductVersion && version_compare($latestProductVersion, $package['version'], '>')) {
                 $availableVersions = $this->getPackageAvailableVersions($package['name']);
                 $package['latestVersion'] = $latestProductVersion;
                 $package['versions'] = array_filter($availableVersions, function ($version) use ($package) {
                     return version_compare($version, $package['version'], '>');
                 });
                 $packagesForUpdate[$package['name']] = $package;
             }
         }
 
         return $packagesForUpdate;
     }

◆ isNewUserPackage()

isNewUserPackage	(	$package,
		$packageNames
	)

protected

Check if this new user package

Parameters

array	$package
array	$packageNames

Returns: bool

Definition at line 342 of file PackagesData.php.

     {
         if (!in_array($package['name'], $packageNames) &&
             in_array($package['type'], $this->composerInformation->getPackagesTypes()) &&
             strpos($package['name'], 'magento/product-') === false &&
             strpos($package['name'], 'magento/project-') === false
         ) {
             return true;
         }
         return false;
     }

◆ syncPackagesData()

syncPackagesData ( )

Returns: array|bool|mixed

Exceptions

Definition at line 93 of file PackagesData.php.

     {
         try {
             $lastSyncData = [];
             $lastSyncData['lastSyncDate'] = $this->getLastSyncDate();
             $lastSyncData['packages'] = $this->getPackagesForUpdate();
             $packagesForInstall = $this->syncPackagesForInstall();
             $lastSyncData = $this->formatLastSyncData($packagesForInstall, $lastSyncData);
             return $lastSyncData;
         } catch (\Exception $e) {
             throw new \RuntimeException($e->getMessage());
         }
     }

◆ unsetDevVersions()

unsetDevVersions ( $package )

protected

Unset dev versions

Parameters

array $package

Returns: array

Definition at line 360 of file PackagesData.php.

     {
         foreach ($package as $key => $version) {
             if (strpos($key, 'dev') !== false) {
                 unset($package[$key]);
             }
         }
         unset($version);
 
         return $package;
     }

Field Documentation

◆ $urlPrefix

$urlPrefix = 'https://'

protected

Definition at line 31 of file PackagesData.php.

◆ COMPOSER_SHOW

const COMPOSER_SHOW = 'show'

#+ Composer command params and options

Definition at line 17 of file PackagesData.php.

◆ PARAM_AVAILABLE

const PARAM_AVAILABLE = '--available'

Definition at line 20 of file PackagesData.php.

◆ PARAM_COMMAND

const PARAM_COMMAND = 'command'

Definition at line 18 of file PackagesData.php.

◆ PARAM_PACKAGE

const PARAM_PACKAGE = 'package'

Definition at line 19 of file PackagesData.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPackageExtraInfo()

◆ getInstalledPackages()

◆ getMetaPackagesMap()

◆ getPackagesForInstall()

◆ getPackagesForUpdate()

◆ isNewUserPackage()

◆ syncPackagesData()

◆ unsetDevVersions()

Field Documentation

◆ $urlPrefix

◆ COMPOSER_SHOW

◆ PARAM_AVAILABLE

◆ PARAM_COMMAND

◆ PARAM_PACKAGE