‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Package\PackageInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Core\Package\PackageInterface:
TYPO3\CMS\Core\Package\Package

Public Member Functions

 getPackageReplacementKeys ()
 
 isPartOfFactoryDefault ()
 
 isPartOfMinimalUsableSystem ()
 
 getValueFromComposerManifest (string $key=null)
 
 getPackageMetaData ()
 
string getPackageKey ()
 
bool isProtected ()
 
 setProtected (bool $protected)
 
string getPackagePath ()
 
 getPackageIcon ()
 

Public Attributes

const PATTERN_MATCH_COMPOSER_NAME = '{^[a-z0-9_.-]+/[a-z0-9_.-]+$}D'
 
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 23 of file PackageInterface.php.

Member Function Documentation

◆ getPackageIcon()

TYPO3\CMS\Core\Package\PackageInterface::getPackageIcon ( )

Find package icon location relative to the package path or null if nothing was found.

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

◆ getPackageKey()

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

Returns the package key of this package.

Returns
‪string

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

Referenced by TYPO3\CMS\Core\Tests\Unit\Page\ImportMapTest\mockPackageManager().

◆ getPackageMetaData()

TYPO3\CMS\Core\Package\PackageInterface::getPackageMetaData ( )

Returns the package meta object of this package.

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

Referenced by TYPO3\CMS\Extensionmanager\Utility\ListUtility\getInstallTypeForPackage().

◆ getPackagePath()

◆ getPackageReplacementKeys()

TYPO3\CMS\Core\Package\PackageInterface::getPackageReplacementKeys ( )

◆ getValueFromComposerManifest()

TYPO3\CMS\Core\Package\PackageInterface::getValueFromComposerManifest ( string  $key = null)

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

Parameters
string | null$key‪Optional. Only return the part of the manifest indexed by 'key'
See also
‪json_decode for return values

◆ isPartOfFactoryDefault()

TYPO3\CMS\Core\Package\PackageInterface::isPartOfFactoryDefault ( )

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

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

◆ isPartOfMinimalUsableSystem()

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.

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

◆ 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 ( bool  $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_COMPOSER_NAME

const TYPO3\CMS\Core\Package\PackageInterface::PATTERN_MATCH_COMPOSER_NAME = '{^[a-z0-9_.-]+/[a-z0-9_.-]+$}D'

◆ PATTERN_MATCH_EXTENSIONKEY

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

Definition at line 32 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 30 of file PackageInterface.php.