PackageInterface

Interface for a TYPO3 Package class

Table of Contents

Constants

PATTERN_MATCH_COMPOSER_NAME  = '{^[a-z0-9_.-]+/[a-z0-9_.-]+$}D'
See https://github.com/composer/composer/blob/2.1.6/src/Composer/Command/InitCommand.php#L100
PATTERN_MATCH_EXTENSIONKEY  = '/^[0-9a-z_-]+$/i'
PATTERN_MATCH_PACKAGEKEY  = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'

Methods

getPackageIcon()  : string|null
Find package icon location relative to the package path or null if nothing was found.
getPackageKey()  : string
Returns the package key of this package.
getPackageMetaData()  : MetaData
Returns the package meta object of this package.
getPackagePath()  : string
Returns the full path to this package's main directory
getPackageReplacementKeys()  : array<string|int, mixed>
getValueFromComposerManifest()  : mixed
Returns contents of Composer manifest - or part there of if a key is given.
isPartOfFactoryDefault()  : bool
Tells if the package is part of the default factory configuration and therefor activated at first installation.
isPartOfMinimalUsableSystem()  : bool
Tells if the package is required for a minimal usable (backend) system and therefor activated if PackageStates is created from scratch for whatever reason.
isProtected()  : bool
Tells if this package is protected and therefore cannot be deactivated or deleted
setProtected()  : void
Sets the protection flag of the package

Constants

PATTERN_MATCH_COMPOSER_NAME

See https://github.com/composer/composer/blob/2.1.6/src/Composer/Command/InitCommand.php#L100

public mixed PATTERN_MATCH_COMPOSER_NAME = '{^[a-z0-9_.-]+/[a-z0-9_.-]+$}D'

PATTERN_MATCH_EXTENSIONKEY

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

PATTERN_MATCH_PACKAGEKEY

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

Methods

getPackageIcon()

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

public getPackageIcon() : string|null
Return values
string|null

getPackageKey()

Returns the package key of this package.

public getPackageKey() : string
Return values
string

getPackageMetaData()

Returns the package meta object of this package.

public getPackageMetaData() : MetaData
Internal
Return values
MetaData

getPackagePath()

Returns the full path to this package's main directory

public getPackagePath() : string
Return values
string —

Path to this package's main directory

getPackageReplacementKeys()

public getPackageReplacementKeys() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed>

getValueFromComposerManifest()

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

public getValueFromComposerManifest([string|null $key = null ]) : mixed
Parameters
$key : string|null = null

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

Internal
Tags
see
json_decode

for return values

isPartOfFactoryDefault()

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

public isPartOfFactoryDefault() : bool
Internal
Return values
bool

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.

public isPartOfMinimalUsableSystem() : bool
Internal
Return values
bool

isProtected()

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

public isProtected() : bool
Return values
bool

setProtected()

Sets the protection flag of the package

public setProtected(bool $protected) : void
Parameters
$protected : bool

TRUE if the package should be protected, otherwise FALSE


        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results