PHP Class FluidTYPO3\Flux\FluxPackage

Inheritance: implements FluidTYPO3\Flux\Package\FluxPackageInterface
Afficher le fichier Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Свойство Type Description
$defaultImplementations array
$manifest array

Méthodes publiques

Méthode Description
__construct ( mixed $seedArrayOrExtensionKeyOrManifestPath ) Constructor - takes an array of manifest data in the same structure as in the manifest JSON file, or an extension key in which case the expected manifest is resolved using that and naming convention of the manifest file. Or takes a full path to the manifest file in which case the manifest is read from there.
create ( mixed $seedArrayOrExtensionKeyOrManifestPath ) : FluidTYPO3\Flux\Package\FluxPackageInterface
getExtensionName ( ) : string Must always return the ExtensionName format of the extension key, excluding the vendor name.
getImplementation ( string $implementationName ) : string Get FQN of the class that's designated as an implementation, meaning it is replaceable by Flux Packages via this method.
getNamespacePrefix ( ) : string Must always return the $vendor\$extensioName format of the vendor and extension name, using values from the two preceeding methods.
getVendorName ( ) : string Must always return the vendor name (as used in class namespaces) corresponding to this package.
getViewPaths ( ) : TemplatePaths Returns an instance of Flux's TemplatePaths class with template paths of this package preloaded.
isFeatureEnabled ( string $featureName ) : boolean Asserts whether or not the feature is enabled for this FluxPackage.
isProviderFor ( string $controllerName ) : boolean Asserts whether or not this FluxPackage contains an integration designed for the controller name, e.g.
modify ( array $alternativeManifestDeclaration ) : void Modify properties of this FluxPackage (in this class instance only) by passing an array using the same structure as the constructor and as in the manifest.
upcast ( string $desiredClassName = NULL ) : FluidTYPO3\Flux\Package\FluxPackageInterface Upcasts (promotes) the instance to another class name by creating a new instance of the provided class and passing $this->manifest as seed. If NULL is passed as desired class name the expected final class name is determined based on naming convention.

Méthodes protégées

Méthode Description
loadManifestFile ( string $filePathAndFilename ) : array Load flux.json manifest file by path or reference.

Method Details

__construct() public méthode

Note: applies CompatibilityRegistry-resolved versioned manifest configuration values immediately.
public __construct ( mixed $seedArrayOrExtensionKeyOrManifestPath )
$seedArrayOrExtensionKeyOrManifestPath mixed

create() public static méthode

public static create ( mixed $seedArrayOrExtensionKeyOrManifestPath ) : FluidTYPO3\Flux\Package\FluxPackageInterface
$seedArrayOrExtensionKeyOrManifestPath mixed
Résultat FluidTYPO3\Flux\Package\FluxPackageInterface

getExtensionName() public méthode

Must always return the ExtensionName format of the extension key, excluding the vendor name.
public getExtensionName ( ) : string
Résultat string

getImplementation() public méthode

Get FQN of the class that's designated as an implementation, meaning it is replaceable by Flux Packages via this method.
public getImplementation ( string $implementationName ) : string
$implementationName string
Résultat string

getNamespacePrefix() public méthode

Must always return the $vendor\$extensioName format of the vendor and extension name, using values from the two preceeding methods.
public getNamespacePrefix ( ) : string
Résultat string

getVendorName() public méthode

Must always return the vendor name (as used in class namespaces) corresponding to this package.
public getVendorName ( ) : string
Résultat string

getViewPaths() public méthode

Returns an instance of Flux's TemplatePaths class with template paths of this package preloaded.
public getViewPaths ( ) : TemplatePaths
Résultat FluidTYPO3\Flux\View\TemplatePaths

isFeatureEnabled() public méthode

Asserts whether or not the feature is enabled for this FluxPackage.
public isFeatureEnabled ( string $featureName ) : boolean
$featureName string
Résultat boolean

isProviderFor() public méthode

"Content", "Page" etc.
public isProviderFor ( string $controllerName ) : boolean
$controllerName string
Résultat boolean

loadManifestFile() protected méthode

Load flux.json manifest file by path or reference.
protected loadManifestFile ( string $filePathAndFilename ) : array
$filePathAndFilename string
Résultat array

modify() public méthode

Is used internally when applying compatibility values: the "overlay" type subset of version dependent values is detected based on current version and passed to this function which then assimilates the values.
public modify ( array $alternativeManifestDeclaration ) : void
$alternativeManifestDeclaration array
Résultat void

upcast() public méthode

Upcasts (promotes) the instance to another class name by creating a new instance of the provided class and passing $this->manifest as seed. If NULL is passed as desired class name the expected final class name is determined based on naming convention.
public upcast ( string $desiredClassName = NULL ) : FluidTYPO3\Flux\Package\FluxPackageInterface
$desiredClassName string
Résultat FluidTYPO3\Flux\Package\FluxPackageInterface

Property Details

$defaultImplementations protected_oe property

protected array $defaultImplementations
Résultat array

$manifest protected_oe property

protected array $manifest
Résultat array