VirtualAppPackage extends Package

FinalYes

This represents the app package (root package in Composer terms)

Internal

Only to be used in TYPO3\CMS\Core\Package and TYPO3\CMS\Core\SystemResource namespace

Table of Contents

Constants

APP_PACKAGE_KEY  = 'typo3/app'

Properties

$composerManifest  : stdClass|null
$isRelativePackagePath  : bool
$packageKey  : string
Unique key of this package.
$packageMetaData  : MetaData
Meta information about this package
$packagePath  : string
Full path to this package's main directory
$partOfFactoryDefault  : bool
If this package is part of factory default, it will be activated during first installation.
$partOfMinimalUsableSystem  : bool
If this package is part of minimal usable system, it will be activated if PackageStates is created from scratch.
$protected  : bool
If this package is protected and therefore cannot be deactivated or deleted
$providesPackages  : array<string|int, mixed>
Composer Packages this package provides in classic mode The composer.json property is public, the implementation here is private
$resources  : ResourceCollectionInterface
$serviceProvider  : string|null
ServiceProvider class name. This property and the corresponding composer.json setting is internal and therefore no api (yet).

Methods

__construct()  : mixed
getPackageIcon()  : string|null
Find package icon location relative to the package path
getPackageKey()  : string
Returns the package key of this package.
getPackageMetaData()  : MetaData
Returns the package meta data object of this package.
getPackagePath()  : string
Returns the full path to this package's main directory
getPackageReplacementKeys()  : array<string|int, mixed>
Returns an array of packages this package replaces
getResources()  : ResourceCollectionInterface
getServiceProvider()  : string
Get the Service Provider class name
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
makePathRelative()  : void
Used by PackageArtifactBuilder to make package path relative
setProtected()  : void
Sets the protection flag of the package
createPackageMetaData()  : void
Creates the package meta data object of this package.
createResources()  : void
getResourceDefinitions()  : Closure|null
loadFlagsFromComposerManifest()  : void
Loads package management related flags from the "extra:typo3/cms:Package" section of extensions composer.json files into local properties

Constants

APP_PACKAGE_KEY

public mixed APP_PACKAGE_KEY = 'typo3/app'

Properties

$composerManifest

protected stdClass|null $composerManifest

$isRelativePackagePath

protected bool $isRelativePackagePath = false

$packageKey

Unique key of this package.

protected string $packageKey

$packageMetaData

Meta information about this package

protected MetaData $packageMetaData

$packagePath

Full path to this package's main directory

protected string $packagePath

$partOfFactoryDefault

If this package is part of factory default, it will be activated during first installation.

protected bool $partOfFactoryDefault = false

$partOfMinimalUsableSystem

If this package is part of minimal usable system, it will be activated if PackageStates is created from scratch.

protected bool $partOfMinimalUsableSystem = false

$protected

If this package is protected and therefore cannot be deactivated or deleted

protected bool $protected = false

$providesPackages

Composer Packages this package provides in classic mode The composer.json property is public, the implementation here is private

protected array<string|int, mixed> $providesPackages = []
Internal

$serviceProvider

ServiceProvider class name. This property and the corresponding composer.json setting is internal and therefore no api (yet).

protected string|null $serviceProvider
Internal

Methods

__construct()

public __construct(PackageManager $packageManager, string $packagePath, string $relativePublicPath) : mixed
Parameters
$packageManager : PackageManager

the package manager which knows this package

$packagePath : string

Absolute path to the location of the package's composer manifest

$relativePublicPath : string

getPackageIcon()

Find package icon location relative to the package path

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 data 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()

Returns an array of packages this package replaces

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

getServiceProvider()

Get the Service Provider class name

public getServiceProvider() : string
Internal
Return values
string

getValueFromComposerManifest()

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

public getValueFromComposerManifest([string $key = null ]) : mixed
Parameters
$key : string = 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

makePathRelative()

Used by PackageArtifactBuilder to make package path relative

public makePathRelative(Filesystem $filesystem, string $composerRootPath) : void
Parameters
$filesystem : Filesystem
$composerRootPath : string
Internal

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

createPackageMetaData()

Creates the package meta data object of this package.

protected createPackageMetaData(PackageManager $packageManager[, bool $isBuildingPackageArtifact = false ]) : void
Parameters
$packageManager : PackageManager
$isBuildingPackageArtifact : bool = false

createResources()

protected createResources() : void

getResourceDefinitions()

protected getResourceDefinitions(string $configPath) : Closure|null
Parameters
$configPath : string
Return values
Closure|null

loadFlagsFromComposerManifest()

Loads package management related flags from the "extra:typo3/cms:Package" section of extensions composer.json files into local properties

protected loadFlagsFromComposerManifest([bool $ignoreProvidesPackages = false ]) : void
Parameters
$ignoreProvidesPackages : bool = false 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results