PHP Класс Neos\Flow\Package\Package

Наследование: implements Neos\Flow\Package\PackageInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$autoloadConfiguration array
$autoloadTypes string[]
$composerName string composer name for this package
$flattenedAutoloadConfiguration array
$namespace string The namespace of the classes contained in this package
$namespaces string[] Array of all declared autoload namespaces contained in this package
$objectManagementEnabled boolean Disable this flag if you don't need object management for your package and want to save some memory.
$packageKey string Unique key of this package. Example for the Flow package: "Neos.Flow"
$packagePath string Full path to this package's main directory
$protected boolean If this package is protected and therefore cannot be deactivated or deleted

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

Метод Описание
__construct ( string $packageKey, string $composerName, string $packagePath, array $autoloadConfiguration = [] ) Constructor
boot ( Bootstrap $bootstrap ) : void Invokes custom PHP code directly after the package manager has been initialized.
getAutoloadConfiguration ( ) : array Get the autoload configuration for this package. Any valid composer "autoload" configuration.
getAutoloadPaths ( ) : array
getAutoloadTypes ( ) : string[]
getClassFiles ( ) : Generator Returns the array of filenames of the class files
getComposerManifest ( string $key = null ) : array | mixed Returns contents of Composer manifest - or part there of.
getComposerName ( ) : string Returns the packages composer name
getConfigurationPath ( ) : string Returns the full path to this package's Configuration directory
getFlattenedAutoloadConfiguration ( ) : array Get a flattened array of autoload configurations that have a predictable pattern (PSR-0, PSR-4)
getFunctionalTestsClassFiles ( ) : array Returns the array of filenames of class files provided by functional tests contained in this package
getFunctionalTestsPath ( ) : string Returns the full path to this package's functional tests directory
getInstalledVersion ( ) : string Get the installed package version (from composer) and as fallback the version given by composer manifest.
getNamespaces ( ) : array Returns array of all declared autoload namespaces contained in 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

Защищенные методы

Метод Описание
explodeAutoloadConfiguration ( ) : void Brings the composer autoload configuration into an easy to use format for various parts of Flow.
getClassesInNormalizedAutoloadPath ( string $baseAutoloadPath, string $autoloadNamespace ) : Generator
isPathAutoloadEntryPoint ( string $path ) : boolean
normalizeAutoloadPath ( string $autoloadType, string $autoloadNamespace, string $autoloadPath ) : string

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

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

Constructor
public __construct ( string $packageKey, string $composerName, string $packagePath, array $autoloadConfiguration = [] )
$packageKey string Key of this package
$composerName string
$packagePath string Absolute path to the location of the package's composer manifest
$autoloadConfiguration array

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

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
Результат void

explodeAutoloadConfiguration() защищенный Метод

Brings the composer autoload configuration into an easy to use format for various parts of Flow.
protected explodeAutoloadConfiguration ( ) : void
Результат void

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

Get the autoload configuration for this package. Any valid composer "autoload" configuration.
public getAutoloadConfiguration ( ) : array
Результат array

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

public getAutoloadPaths ( ) : array
Результат array

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

public getAutoloadTypes ( ) : string[]
Результат string[]

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

Returns the array of filenames of the class files
public getClassFiles ( ) : Generator
Результат Generator A Generator for class names (key) and their filename, including the absolute path.

getClassesInNormalizedAutoloadPath() защищенный Метод

protected getClassesInNormalizedAutoloadPath ( string $baseAutoloadPath, string $autoloadNamespace ) : Generator
$baseAutoloadPath string
$autoloadNamespace string
Результат Generator

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

Returns contents of Composer manifest - or part there of.
public getComposerManifest ( string $key = null ) : array | mixed
$key string Optional. Only return the part of the manifest indexed by 'key'
Результат array | mixed

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

Returns the packages composer name
public getComposerName ( ) : string
Результат string

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

Returns the full path to this package's Configuration directory
public getConfigurationPath ( ) : string
Результат string Path to this package's Configuration directory

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

Get a flattened array of autoload configurations that have a predictable pattern (PSR-0, PSR-4)
public getFlattenedAutoloadConfiguration ( ) : array
Результат array Keys: "namespace", "classPath", "mappingType"

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

Returns the array of filenames of class files provided by functional tests contained in this package
public getFunctionalTestsClassFiles ( ) : array
Результат array An array of class names (key) and their filename, including the relative path to the package's directory

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

Returns the full path to this package's functional tests directory
public getFunctionalTestsPath ( ) : string
Результат string Path to this package's functional tests directory

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

Get the installed package version (from composer) and as fallback the version given by composer manifest.
public getInstalledVersion ( ) : string
Результат string

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

Returns array of all declared autoload namespaces contained in this package
public getNamespaces ( ) : array
Результат array

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

Returns the package key of this package.
public getPackageKey ( ) : string
Результат string

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

Returns the full path to this package's main directory
public getPackagePath ( ) : string
Результат string Path to this package's main directory

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

Returns the full path to this package's Resources directory
public getResourcesPath ( ) : string
Результат string Path to this package's Resources directory

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

Tells if files in the Classes directory should be registered and object management enabled for this package.
public isObjectManagementEnabled ( ) : boolean
Результат boolean

isPathAutoloadEntryPoint() защищенный Метод

protected isPathAutoloadEntryPoint ( string $path ) : boolean
$path string
Результат boolean

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

Tells if this package is protected and therefore cannot be deactivated or deleted
public isProtected ( ) : boolean
Результат boolean

normalizeAutoloadPath() защищенный Метод

protected normalizeAutoloadPath ( string $autoloadType, string $autoloadNamespace, string $autoloadPath ) : string
$autoloadType string
$autoloadNamespace string
$autoloadPath string
Результат string

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

Sets the protection flag of the package
public setProtected ( boolean $protected ) : void
$protected boolean TRUE if the package should be protected, otherwise FALSE
Результат void

Описание свойств

$autoloadConfiguration защищенное свойство

protected array $autoloadConfiguration
Результат array

$autoloadTypes защищенное свойство

protected string[] $autoloadTypes
Результат string[]

$composerName защищенное свойство

composer name for this package
protected string $composerName
Результат string

$flattenedAutoloadConfiguration защищенное свойство

protected array $flattenedAutoloadConfiguration
Результат array

$namespace защищенное свойство

The namespace of the classes contained in this package
protected string $namespace
Результат string

$namespaces защищенное свойство

Array of all declared autoload namespaces contained in this package
protected string[] $namespaces
Результат string[]

$objectManagementEnabled защищенное свойство

Disable this flag if you don't need object management for your package and want to save some memory.
protected bool $objectManagementEnabled
Результат boolean

$packageKey защищенное свойство

Unique key of this package. Example for the Flow package: "Neos.Flow"
protected string $packageKey
Результат string

$packagePath защищенное свойство

Full path to this package's main directory
protected string $packagePath
Результат string

$protected защищенное свойство

If this package is protected and therefore cannot be deactivated or deleted
protected bool $protected
Результат boolean