PHP Interface Neos\Flow\Package\PackageInterface

Show file Open project: neos/flow-development-collection Interface Usage Examples

Public Methods

Method Description
boot ( Bootstrap $bootstrap ) : void Invokes custom PHP code directly after the package manager has been initialized.
getClassFiles ( ) : array Returns the array of filenames of the class files
getComposerManifest ( string $key = null ) : mixed Returns the composer manifest of this package or just contents of a specific key of the full configuration.
getComposerName ( ) : string Returns the composer name of this package.
getConfigurationPath ( ) : string Returns the full path to this package's Configuration directory
getInstalledVersion ( ) : string Returns the currently installed version of this package.
getNamespaces ( ) : array Returns an array of all namespaces declared for this package.
getPackageKey ( ) : string Returns the package key of this package.
getPackagePath ( ) : string Returns the full path to this package's main directory
getResourcesPath ( ) : string Returns the full path to this package's Resources directory
isObjectManagementEnabled ( ) : boolean Tells if files in the Classes directory should be registered and object management enabled for this package.
isProtected ( ) : boolean Tells if this package is protected and therefore cannot be deactivated or deleted
setProtected ( boolean $protected ) : void Sets the protection flag of the package

Method Details

boot() public method

Invokes custom PHP code directly after the package manager has been initialized.
public boot ( Bootstrap $bootstrap ) : void
$bootstrap Neos\Flow\Core\Bootstrap The current bootstrap
return void

getClassFiles() public method

Returns the array of filenames of the class files
public getClassFiles ( ) : array
return array An array of class names (key) and their filename, including the relative path to the package's directory

getComposerManifest() public method

Returns the composer manifest of this package or just contents of a specific key of the full configuration.
public getComposerManifest ( string $key = null ) : mixed
$key string
return mixed

getComposerName() public method

Returns the composer name of this package.
public getComposerName ( ) : string
return string

getConfigurationPath() public method

Returns the full path to this package's Configuration directory
public getConfigurationPath ( ) : string
return string Path to this package's Configuration directory

getInstalledVersion() public method

Returns the currently installed version of this package.
public getInstalledVersion ( ) : string
return string

getNamespaces() public method

Returns an array of all namespaces declared for this package.
public getNamespaces ( ) : array
return array

getPackageKey() public method

Returns the package key of this package.
public getPackageKey ( ) : string
return string

getPackagePath() public method

Returns the full path to this package's main directory
public getPackagePath ( ) : string
return string Path to this package's main directory

getResourcesPath() public method

Returns the full path to this package's Resources directory
public getResourcesPath ( ) : string
return string Path to this package's Resources directory

isObjectManagementEnabled() public method

Tells if files in the Classes directory should be registered and object management enabled for this package.
public isObjectManagementEnabled ( ) : boolean
return boolean

isProtected() public method

Tells if this package is protected and therefore cannot be deactivated or deleted
public isProtected ( ) : boolean
return boolean

setProtected() public method

Sets the protection flag of the package
public setProtected ( boolean $protected ) : void
$protected boolean TRUE if the package should be protected, otherwise FALSE
return void