PHP Интерфейс Neos\Flow\Package\PackageManagerInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
activatePackage ( string $packageKey ) : void Activates a package
createPackage ( string $packageKey, array $manifest = [], string $packagesPath = null ) : Neos\Flow\Package\PackageInterface Create a new package, given the package key
deactivatePackage ( string $packageKey ) : void Deactivates a package if it is in the list of active packages
deletePackage ( string $packageKey ) : void Removes a package from registry and deletes it from filesystem
freezePackage ( string $packageKey ) : void Freezes a package
getActivePackages ( ) : array Returns an array of PackageInterface objects of all active packages.
getAvailablePackages ( ) : array Returns an array of PackageInterface objects of all available packages.
getCaseSensitivePackageKey ( string $unknownCasedPackageKey ) : mixed Returns the upper camel cased version of the given package key or FALSE if no such package is available.
getFilteredPackages ( string $packageState = 'available', string $packagePath = null, string $packageType = null ) : array Returns an array of PackageInterface objects of all packages that match the given package state, path, and type filters. All three filters must match, if given.
getPackage ( string $packageKey ) : Neos\Flow\Package\PackageInterface Returns a PackageInterface object for the specified package.
initialize ( Bootstrap $bootstrap ) : void Initializes the package manager
isPackageActive ( string $packageKey ) : boolean Returns TRUE if a package is activated or FALSE if it's not.
isPackageAvailable ( string $packageKey ) : boolean Returns TRUE if a package is available (the package's files exist in the packages directory) or FALSE if it's not. If a package is available it doesn't mean necessarily that it's active!
isPackageFrozen ( string $packageKey ) : boolean Tells if a package is frozen
isPackageKeyValid ( string $packageKey ) Check the conformance of the given package key
refreezePackage ( string $packageKey ) : void Refreezes a package
unfreezePackage ( string $packageKey ) : void Unfreezes a package

Описание методов

activatePackage() публичный Метод

Activates a package
public activatePackage ( string $packageKey ) : void
$packageKey string The package to activate
Результат void

createPackage() публичный Метод

Create a new package, given the package key
public createPackage ( string $packageKey, array $manifest = [], string $packagesPath = null ) : Neos\Flow\Package\PackageInterface
$packageKey string The package key to use for the new package
$manifest array composer manifest data
$packagesPath string If specified, the package will be created in this path
Результат Neos\Flow\Package\PackageInterface The newly created package

deactivatePackage() публичный Метод

Deactivates a package if it is in the list of active packages
public deactivatePackage ( string $packageKey ) : void
$packageKey string The package to deactivate
Результат void

deletePackage() публичный Метод

Removes a package from registry and deletes it from filesystem
public deletePackage ( string $packageKey ) : void
$packageKey string package to delete
Результат void

freezePackage() публичный Метод

Freezes a package
public freezePackage ( string $packageKey ) : void
$packageKey string The package to freeze
Результат void

getActivePackages() публичный Метод

A package is active, if it is available and has been activated in the package manager settings.
public getActivePackages ( ) : array
Результат array

getAvailablePackages() публичный Метод

A package is available, if the package directory contains valid meta information.
public getAvailablePackages ( ) : array
Результат array

getCaseSensitivePackageKey() публичный Метод

Returns the upper camel cased version of the given package key or FALSE if no such package is available.
public getCaseSensitivePackageKey ( string $unknownCasedPackageKey ) : mixed
$unknownCasedPackageKey string The package key to convert
Результат mixed The upper camel cased package key or FALSE if no such package exists

getFilteredPackages() публичный Метод

Returns an array of PackageInterface objects of all packages that match the given package state, path, and type filters. All three filters must match, if given.
public getFilteredPackages ( string $packageState = 'available', string $packagePath = null, string $packageType = null ) : array
$packageState string defaults to available
$packagePath string
$packageType string
Результат array

getPackage() публичный Метод

A package is available, if the package directory contains valid meta information.
public getPackage ( string $packageKey ) : Neos\Flow\Package\PackageInterface
$packageKey string
Результат Neos\Flow\Package\PackageInterface

initialize() публичный Метод

Initializes the package manager
public initialize ( Bootstrap $bootstrap ) : void
$bootstrap Neos\Flow\Core\Bootstrap The current bootstrap
Результат void

isPackageActive() публичный Метод

Returns TRUE if a package is activated or FALSE if it's not.
public isPackageActive ( string $packageKey ) : boolean
$packageKey string The key of the package to check
Результат boolean TRUE if package is active, otherwise FALSE

isPackageAvailable() публичный Метод

Returns TRUE if a package is available (the package's files exist in the packages directory) or FALSE if it's not. If a package is available it doesn't mean necessarily that it's active!
public isPackageAvailable ( string $packageKey ) : boolean
$packageKey string The key of the package to check
Результат boolean TRUE if the package is available, otherwise FALSE

isPackageFrozen() публичный Метод

Tells if a package is frozen
public isPackageFrozen ( string $packageKey ) : boolean
$packageKey string The package to check
Результат boolean

isPackageKeyValid() публичный Метод

Check the conformance of the given package key
public isPackageKeyValid ( string $packageKey )
$packageKey string The package key to validate

refreezePackage() публичный Метод

Refreezes a package
public refreezePackage ( string $packageKey ) : void
$packageKey string The package to refreeze
Результат void

unfreezePackage() публичный Метод

Unfreezes a package
public unfreezePackage ( string $packageKey ) : void
$packageKey string The package to unfreeze
Результат void