TYPO3\CMS\Core\Package\PackageInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Package\PackageInterface:

Public Member Functions
array	getPackageReplacementKeys ()
bool	isPartOfFactoryDefault ()
bool	isPartOfMinimalUsableSystem ()
mixed null	getValueFromComposerManifest ($key=null)
MetaData	getPackageMetaData ()
string	getPackageKey ()
bool	isProtected ()
	setProtected ($protected)
string	getPackagePath ()

Public Attributes
const	PATTERN_MATCH_PACKAGEKEY = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'
const	PATTERN_MATCH_EXTENSIONKEY = '/^[0-9a-z_-]+$/i'

Detailed Description

Interface for a TYPO3 Package class

Definition at line 21 of file PackageInterface.php.

Member Function Documentation

getPackageKey()

string TYPO3\CMS\Core\Package\PackageInterface::getPackageKey

(

)

Returns the package key of this package.

Returns

‪string

Implemented in TYPO3\CMS\Core\Package\Package.

getPackageMetaData()

MetaData TYPO3\CMS\Core\Package\PackageInterface::getPackageMetaData

(

)

Returns the package meta object of this package.

Returns

‪MetaData

Implemented in TYPO3\CMS\Core\Package\Package.

getPackagePath()

string TYPO3\CMS\Core\Package\PackageInterface::getPackagePath

(

)

Returns the full path to this package's main directory

Returns

‪string Path to this package's main directory

Implemented in TYPO3\CMS\Core\Package\Package.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtLocalconfForExtension(), TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtTablesForExtension(), and TYPO3\CMS\Extensionmanager\Utility\ListUtility\getInstallTypeForPackage().

getPackageReplacementKeys()

array TYPO3\CMS\Core\Package\PackageInterface::getPackageReplacementKeys

(

)

Returns

‪array

Implemented in TYPO3\CMS\Core\Package\Package.

getValueFromComposerManifest()

mixed null TYPO3\CMS\Core\Package\PackageInterface::getValueFromComposerManifest

(

$key = null

)

Returns contents of Composer manifest - or part there of if a key is given.

Parameters

string

$key

‪Optional. Only return the part of the manifest indexed by 'key'

Returns

‪mixed|null

See also

‪json_decode for return values

Implemented in TYPO3\CMS\Core\Package\Package.

isPartOfFactoryDefault()

bool TYPO3\CMS\Core\Package\PackageInterface::isPartOfFactoryDefault

(

)

Tells if the package is part of the default factory configuration and therefor activated at first installation.

Returns

‪bool

Implemented in TYPO3\CMS\Core\Package\Package.

Referenced by TYPO3\CMS\Install\Controller\InstallerController\executeEnvironmentAndFoldersAction().

isPartOfMinimalUsableSystem()

bool TYPO3\CMS\Core\Package\PackageInterface::isPartOfMinimalUsableSystem

(

)

Tells if the package is required for a minimal usable (backend) system and therefor activated if PackageStates is created from scratch for whatever reason.

Returns

‪bool

Implemented in TYPO3\CMS\Core\Package\Package.

Referenced by TYPO3\CMS\Install\Middleware\Maintenance\recreatePackageStatesFileIfMissing().

isProtected()

bool TYPO3\CMS\Core\Package\PackageInterface::isProtected

(

)

Tells if this package is protected and therefore cannot be deactivated or deleted

Returns

‪bool

Implemented in TYPO3\CMS\Core\Package\Package.

setProtected()

TYPO3\CMS\Core\Package\PackageInterface::setProtected

(

$protected

)

Sets the protection flag of the package

Parameters

bool

$protected

‪TRUE if the package should be protected, otherwise FALSE

Implemented in TYPO3\CMS\Core\Package\Package.

Member Data Documentation

PATTERN_MATCH_EXTENSIONKEY

const TYPO3\CMS\Core\Package\PackageInterface::PATTERN_MATCH_EXTENSIONKEY = '/^[0-9a-z_-]+$/i'

Definition at line 25 of file PackageInterface.php.

PATTERN_MATCH_PACKAGEKEY

const TYPO3\CMS\Core\Package\PackageInterface::PATTERN_MATCH_PACKAGEKEY = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'

Definition at line 23 of file PackageInterface.php.