TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
PackageInterface Interface Reference
Inheritance diagram for PackageInterface:
Package

Public Member Functions

 getPackageReplacementKeys ()
 
 isPartOfFactoryDefault ()
 
 isPartOfMinimalUsableSystem ()
 
 getValueFromComposerManifest ($key=null)
 
 getPackageMetaData ()
 
 getPackageKey ()
 
 isProtected ()
 
 setProtected ($protected)
 
 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 Adapted from FLOW for TYPO3 CMS

Definition at line 21 of file PackageInterface.php.

Member Function Documentation

getPackageKey ( )

Returns the package key of this package.

Returns
string

Implemented in Package.

Referenced by PackageManager\registerActivePackage(), PackageManager\registerPackage(), and PackageManager\unregisterPackage().

getPackageMetaData ( )

Returns the package meta object of this package.

Returns
MetaData

Implemented in Package.

getPackagePath ( )

Returns the full path to this package's main directory

Returns
string Path to this package's main directory

Implemented in Package.

Referenced by ClassLoadingInformationGenerator\buildClassLoadingInformationForPackage(), ListUtility\getInstallTypeForPackage(), and PackageManager\registerActivePackage().

getPackageReplacementKeys ( )
Returns
array

Implemented in Package.

Referenced by PackageManager\registerPackage().

getValueFromComposerManifest (   $key = null)

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

Parameters
string$keyOptional. Only return the part of the manifest indexed by 'key'
Returns
mixed|NULL
See also
json_decode for return values

Implemented in Package.

Referenced by ClassLoadingInformationGenerator\buildClassAliasMapForPackage(), and ClassLoadingInformationGenerator\buildClassLoadingInformationForPackage().

isPartOfFactoryDefault ( )

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

Returns
bool

Implemented in Package.

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 Package.

isProtected ( )

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

Returns
bool

Implemented in Package.

setProtected (   $protected)

Sets the protection flag of the package

Parameters
bool$protectedTRUE if the package should be protected, otherwise FALSE
Returns
void

Implemented in Package.

Member Data Documentation

const PATTERN_MATCH_EXTENSIONKEY = '/^[0-9a-z_-]+$/i'

Definition at line 25 of file PackageInterface.php.

Referenced by PackageManager\isPackageKeyValid().

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

Definition at line 23 of file PackageInterface.php.

Referenced by PackageManager\isPackageKeyValid().