TYPO3\CMS\Core\Package\Cache\PackageCacheEntry Class Reference

Public Member Functions
	serialize ()
	getIdentifier ()
	withIdentifier (string $identifier)
	getConfiguration ()
	getAliasMap ()
	getComposerNameMap ()
PackageInterface[]	getPackages ()

Static Public Member Functions
static	ensureValidPackageConfiguration (array $configuration)
static	fromPackageData (array $packageStatesConfiguration, array $packageAliasMap, array $composerNameToPackageKeyMap, array $packageObjects)
static	fromCache (array $packageData)

Private Member Functions
	__construct (array $configuration, array $aliasMap, array $composerNameMap, array $packages)

Private Attributes
array	$configuration
array	$aliasMap
array	$composerNameMap
array	$packages
string	$identifier = null

Detailed Description

A TYPO3 Package cache entry. Represents a concrete state of TYPO3 packages. It interfaces between PackageManager and PackageCacheInterface.

Definition at line 34 of file PackageCacheEntry.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::__construct ( array  $configuration, array  $aliasMap, array  $composerNameMap, array  $packages  )

private

Definition at line 66 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$aliasMap, TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$composerNameMap, TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$configuration, and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$packages.

Member Function Documentation

ensureValidPackageConfiguration()

static TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::ensureValidPackageConfiguration ( array  $configuration )

static

Validates whether the configuration has the correct version

Exceptions

PackageStatesUnavailableException

Definition at line 83 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$configuration.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\fromCache(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\fromPackageData().

fromCache()

static TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::fromCache ( array  $packageData )

static

Definition at line 106 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\ensureValidPackageConfiguration().

Referenced by TYPO3\CMS\Core\Package\Cache\PackageStatesPackageCache\fetch().

fromPackageData()

static TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::fromPackageData ( array  $packageStatesConfiguration, array  $packageAliasMap, array  $composerNameToPackageKeyMap, array  $packageObjects  )

static

Definition at line 90 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\ensureValidPackageConfiguration().

getAliasMap()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::getAliasMap

(

)

Definition at line 164 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$aliasMap.

getComposerNameMap()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::getComposerNameMap

(

)

Definition at line 169 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$composerNameMap.

getConfiguration()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::getConfiguration

(

)

Definition at line 159 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$configuration.

getIdentifier()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::getIdentifier

(

)

Definition at line 146 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$identifier.

getPackages()

PackageInterface [] TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::getPackages

(

)

Returns

‪PackageInterface[]

Definition at line 177 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$packages.

serialize()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::serialize

(

)

Definition at line 132 of file PackageCacheEntry.php.

withIdentifier()

TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::withIdentifier

(

string

$identifier

)

Definition at line 151 of file PackageCacheEntry.php.

References TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\$identifier.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageStatesPackageCache\store().

Member Data Documentation

$aliasMap

array TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::$aliasMap

private

Alternative names for packages mapping to the package key. Typically filled from replace section in composer.json

Definition at line 46 of file PackageCacheEntry.php.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\__construct(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\getAliasMap().

$composerNameMap

array TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::$composerNameMap

private

Map from composer name of a package (key in this array) to its package key (value)

Definition at line 51 of file PackageCacheEntry.php.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\__construct(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\getComposerNameMap().

$configuration

array TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::$configuration

private

Package configuration. Used by the PackageManager to identify "active" packages. Every key in this array represents an active extension.

Definition at line 40 of file PackageCacheEntry.php.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\__construct(), TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\ensureValidPackageConfiguration(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\getConfiguration().

$identifier

string TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::$identifier = null

private

Identifier for the current state, which can optionally stored in the cache entry or artifact. Currently, only used in Composer mode, where the identifier is comprised from the composer.lock file and stored alongside the artifact.

Definition at line 64 of file PackageCacheEntry.php.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\getIdentifier(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\withIdentifier().

$packages

array TYPO3\CMS\Core\Package\Cache\PackageCacheEntry::$packages

private

Definition at line 56 of file PackageCacheEntry.php.

Referenced by TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\__construct(), and TYPO3\CMS\Core\Package\Cache\PackageCacheEntry\getPackages().