SystemPackage Class Reference

Public Member Functions
	__construct (MagentoComposerApplicationFactory $composerAppFactory, ComposerInformation $composerInfo)
	getPackageVersions ()
	getAllowedEnterpriseVersions ($currentCE)
	getSystemPackageVersions ($systemPackageInfo)
	sortVersions ($enterpriseVersions)

Data Fields
const	EDITION_COMMUNITY = 'magento/product-community-edition'
const	EDITION_ENTERPRISE = 'magento/product-enterprise-edition'

Detailed Description

Class SystemPackage returns system package and available for update versions

Definition at line 17 of file SystemPackage.php.

Constructor & Destructor Documentation

__construct()

__construct	(	MagentoComposerApplicationFactory	$composerAppFactory,
		ComposerInformation	$composerInfo
	)

Constructor

Parameters

MagentoComposerApplicationFactory	$composerAppFactory
ComposerInformation	$composerInfo

Definition at line 44 of file SystemPackage.php.

      {
        $this->infoCommand = $composerAppFactory->createInfoCommand();
        $this->magentoComposerApplication = $composerAppFactory->create();
        $this->composerInfo = $composerInfo;
    }

Member Function Documentation

getAllowedEnterpriseVersions()

getAllowedEnterpriseVersions

(

$currentCE

)

Retrieve allowed EE versions

Parameters

string

$currentCE

Returns

array

Definition at line 102 of file SystemPackage.php.

    {
        $result = [];
        $enterpriseVersions = $this->infoCommand->run(static::EDITION_ENTERPRISE);
        $eeVersions = [];
        $maxVersion = '';
        if (is_array($enterpriseVersions) && array_key_exists(InfoCommand::AVAILABLE_VERSIONS, $enterpriseVersions)) {
            $enterpriseVersions = $this->sortVersions($enterpriseVersions);
            if (isset($enterpriseVersions[InfoCommand::AVAILABLE_VERSIONS][0])) {
                $maxVersion = $enterpriseVersions[InfoCommand::AVAILABLE_VERSIONS][0];
            }
            $eeVersions = $this->filterEeVersions($currentCE, $enterpriseVersions, $maxVersion);
        }

        if (!empty($eeVersions)) {
            $result[] = [
                'package' => static::EDITION_ENTERPRISE,
                'versions' => $eeVersions,
            ];
        }
        return $result;
    }

getPackageVersions()

getPackageVersions

(

)

Returns system package and available versions

Exceptions

Definition at line 59 of file SystemPackage.php.

    {
        $currentCE = '0';

        $result = [];
        $systemPackages = $this->getInstalledSystemPackages();
        foreach ($systemPackages as $systemPackage) {
            $systemPackageInfo = $this->infoCommand->run($systemPackage);
            if (!$systemPackageInfo) {
                throw new \RuntimeException("We cannot retrieve information on $systemPackage.");
            }

            $versions = $this->getSystemPackageVersions($systemPackageInfo);

            if ($systemPackageInfo['name'] == static::EDITION_COMMUNITY) {
                $currentCE = $systemPackageInfo[InfoCommand::CURRENT_VERSION];
            }

            if (count($versions) > 1) {
                $versions[0]['name'] .= ' (latest)';
            }

            $result[] = [
                'package' => $systemPackageInfo['name'],
                'versions' => $versions,
            ];
        }

        if (!in_array(static::EDITION_ENTERPRISE, $systemPackages)) {
            $result = array_merge($this->getAllowedEnterpriseVersions($currentCE), $result);
        }

        $result = $this->formatPackages($result);

        return $result;
    }

getSystemPackageVersions()

getSystemPackageVersions

(

$systemPackageInfo

)

Retrieve package versions

Parameters

array

$systemPackageInfo

Returns

array

Definition at line 131 of file SystemPackage.php.

    {
        $editionType = '';
        $versions = [];

        if ($systemPackageInfo['name'] == static::EDITION_COMMUNITY) {
            $editionType .= 'CE';
        } elseif ($systemPackageInfo['name'] == static::EDITION_ENTERPRISE) {
            $editionType .= 'EE';
        }

        foreach ($systemPackageInfo[InfoCommand::NEW_VERSIONS] as $version) {
            $versions[] = ['id' => $version, 'name' => 'Version ' . $version . ' ' . $editionType, 'current' => false];
        }

        if ($systemPackageInfo[InfoCommand::CURRENT_VERSION]) {
            $versions[] = [
                'id' => $systemPackageInfo[InfoCommand::CURRENT_VERSION],
                'name' => 'Version ' . $systemPackageInfo[InfoCommand::CURRENT_VERSION] . ' ' . $editionType,
                'current' => true,
            ];
        }
        return  $versions;
    }

sortVersions()

sortVersions

(

$enterpriseVersions

)

Parameters

array

$enterpriseVersions

Returns

array

Definition at line 193 of file SystemPackage.php.

    {
        usort($enterpriseVersions[InfoCommand::AVAILABLE_VERSIONS], function ($versionOne, $versionTwo) {
            if (version_compare($versionOne, $versionTwo, '==')) {
                return 0;
            }
            return (version_compare($versionOne, $versionTwo, '<')) ? 1 : -1;
        });

        return $enterpriseVersions;
    }

Field Documentation

EDITION_COMMUNITY

const EDITION_COMMUNITY = 'magento/product-community-edition'

Definition at line 34 of file SystemPackage.php.

EDITION_ENTERPRISE

const EDITION_ENTERPRISE = 'magento/product-enterprise-edition'

Definition at line 36 of file SystemPackage.php.

---

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

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