PHP Class Neos\Flow\Command\PackageCommandController

Inheritance: extends Neos\Flow\Cli\CommandController
Datei anzeigen Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$bootstrap Neos\Flow\Core\Bootstrap
$packageManager Neos\Flow\Package\PackageManagerInterface
$settings array

Public Methods

Method Description
activateCommand ( string $packageKey ) : string Activate an available package
createCommand ( string $packageKey, string $packageType = PackageInterface::DEFAULT_COMPOSER_TYPE ) : string Create a new package
deactivateCommand ( string $packageKey ) : string Deactivate a package
deleteCommand ( string $packageKey ) : string Delete an existing package
freezeCommand ( string $packageKey = 'all' ) : void Freeze a package
injectBootstrap ( Bootstrap $bootstrap ) : void
injectPackageManager ( Neos\Flow\Package\PackageManagerInterface $packageManager ) : void
injectSettings ( array $settings ) : void
listCommand ( boolean $loadingOrder = false ) : string List available packages
refreezeCommand ( string $packageKey = 'all' ) : void Refreeze a package
rescanCommand ( ) Rescan package availability and recreates the PackageStates configuration.
unfreezeCommand ( string $packageKey = 'all' ) : void Unfreeze a package

Method Details

activateCommand() public method

This command activates an existing, but currently inactive package.
public activateCommand ( string $packageKey ) : string
$packageKey string The package key of the package to create
return string

createCommand() public method

This command creates a new package which contains only the mandatory directories and files.
public createCommand ( string $packageKey, string $packageType = PackageInterface::DEFAULT_COMPOSER_TYPE ) : string
$packageKey string The package key of the package to create
$packageType string The package type of the package to create
return string

deactivateCommand() public method

This command deactivates a currently active package.
public deactivateCommand ( string $packageKey ) : string
$packageKey string The package key of the package to create
return string

deleteCommand() public method

This command deletes an existing package identified by the package key.
public deleteCommand ( string $packageKey ) : string
$packageKey string The package key of the package to create
return string

freezeCommand() public method

This function marks a package as frozen in order to improve performance in a development context. While a package is frozen, any modification of files within that package won't be tracked and can lead to unexpected behavior. File monitoring won't consider the given package. Further more, reflection data for classes contained in the package is cached persistently and loaded directly on the first request after caches have been flushed. The precompiled reflection data is stored in the Configuration directory of the respective package. By specifying all as a package key, all currently frozen packages are frozen (the default).
public freezeCommand ( string $packageKey = 'all' ) : void
$packageKey string Key of the package to freeze
return void

injectBootstrap() public method

public injectBootstrap ( Bootstrap $bootstrap ) : void
$bootstrap Neos\Flow\Core\Bootstrap
return void

injectPackageManager() public method

public injectPackageManager ( Neos\Flow\Package\PackageManagerInterface $packageManager ) : void
$packageManager Neos\Flow\Package\PackageManagerInterface
return void

injectSettings() public method

public injectSettings ( array $settings ) : void
$settings array The Flow settings
return void

listCommand() public method

Lists all locally available packages. Displays the package key, version and package title and its state – active or inactive.
public listCommand ( boolean $loadingOrder = false ) : string
$loadingOrder boolean The returned packages are ordered by their loading order.
return string The list of packages

refreezeCommand() public method

Refreezes a currently frozen package: all precompiled information is removed and file monitoring will consider the package exactly once, on the next request. After that request, the package remains frozen again, just with the updated data. By specifying all as a package key, all currently frozen packages are refrozen (the default).
public refreezeCommand ( string $packageKey = 'all' ) : void
$packageKey string Key of the package to refreeze, or 'all'
return void

rescanCommand() public method

Rescan package availability and recreates the PackageStates configuration.
public rescanCommand ( )

unfreezeCommand() public method

Unfreezes a previously frozen package. On the next request, this package will be considered again by the file monitoring and related services – if they are enabled in the current context. By specifying all as a package key, all currently frozen packages are unfrozen (the default).
public unfreezeCommand ( string $packageKey = 'all' ) : void
$packageKey string Key of the package to unfreeze, or 'all'
return void

Property Details

$bootstrap protected_oe property

protected Bootstrap,Neos\Flow\Core $bootstrap
return Neos\Flow\Core\Bootstrap

$packageManager protected_oe property

protected PackageManagerInterface,Neos\Flow\Package $packageManager
return Neos\Flow\Package\PackageManagerInterface

$settings protected_oe property

protected array $settings
return array