interface FlowPackageInterface implements PackageInterface, PackageKeyAwareInterface (View source)

An interface for Flow packages that might have configuration or resources

Constants

DIRECTORY_CLASSES

DIRECTORY_CONFIGURATION

DIRECTORY_TESTS_FUNCTIONAL

DIRECTORY_TESTS_UNIT

DIRECTORY_RESOURCES

Methods

iterable
getClassFiles()

Returns the array of filenames of the class files

string
getComposerName()

Returns the composer name of this package.

array
getNamespaces()

Returns an array of all namespaces declared for this package.

string
getPackagePath()

Returns the full path to this package's main directory

string
getInstalledVersion()

Returns the currently installed version of this package.

mixed
getComposerManifest(string $key = null)

Returns the composer manifest of this package or just contents of a specific key of the full configuration.

string
getPackageKey()

Returns the package key of this package.

string
getResourcesPath()

Returns the full path to this package's Resources directory

string
getConfigurationPath()

Returns the full path to this package's Configuration directory

getFunctionalTestsClassFiles()

Returns a generator of filenames of class files provided by functional tests contained in this package

string
getFunctionalTestsPath()

Returns the full path to this package's functional tests directory

Details

iterable getClassFiles()

Returns the array of filenames of the class files

Return Value

iterable

An array or yields the class names (key) and their filename, including the relative path to the package's directory

string getComposerName()

Returns the composer name of this package.

Return Value

string

array getNamespaces()

Returns an array of all namespaces declared for this package.

Return Value

array

string getPackagePath()

Returns the full path to this package's main directory

Return Value

string

Path to this package's main directory

string getInstalledVersion()

Returns the currently installed version of this package.

Return Value

string

mixed getComposerManifest(string $key = null)

Returns the composer manifest of this package or just contents of a specific key of the full configuration.

Parameters

string $key

Return Value

mixed

string getPackageKey()

Returns the package key of this package.

Return Value

string

string getResourcesPath()

Returns the full path to this package's Resources directory

Return Value

string

Path to this package's Resources directory

string getConfigurationPath()

Returns the full path to this package's Configuration directory

Return Value

string

Path to this package's Configuration directory

Generator getFunctionalTestsClassFiles()

internal  
 

Returns a generator of filenames of class files provided by functional tests contained in this package

Return Value

Generator

string getFunctionalTestsPath()

internal  
 

Returns the full path to this package's functional tests directory

Return Value

string

Path to this package's functional tests directory