ManifestInterface
in
Table of Contents
- createAsset() : AssetInterface
- createCacheFile() : SplFileInfo
- createDataFile() : SplFileInfo
- createManifestFile() : SplFileInfo
- Returns a handle for a file inside the asset directory of this manifest.
- createUrl() : FarahUrl
- Build a Farah URL for the given path, with this module's URL as base.
- getId() : string
- The Farah URL that represents this module.
- lookupAsset() : AssetInterface
- normalizeManifestElement() : void
- Set any missing attributes according to the AssetBuilderStrategy.
- normalizeManifestTree() : void
Methods
createAsset()
public
createAsset(LeanElement $element) : AssetInterface
Parameters
- $element : LeanElement
Return values
AssetInterface —createCacheFile()
public
createCacheFile(string $fileName[, FarahUrlPath|string $path = null ][, FarahUrlArguments|string $args = null ][, FarahUrlStreamIdentifier|string $fragment = null ]) : SplFileInfo
Parameters
- $fileName : string
- $path : FarahUrlPath|string = null
- $args : FarahUrlArguments|string = null
- $fragment : FarahUrlStreamIdentifier|string = null
Return values
SplFileInfo —createDataFile()
public
createDataFile(string $fileName[, FarahUrlPath|string $path = null ][, FarahUrlArguments|string $args = null ][, FarahUrlStreamIdentifier|string $fragment = null ]) : SplFileInfo
Parameters
- $fileName : string
- $path : FarahUrlPath|string = null
- $args : FarahUrlArguments|string = null
- $fragment : FarahUrlStreamIdentifier|string = null
Return values
SplFileInfo —createManifestFile()
Returns a handle for a file inside the asset directory of this manifest.
public
createManifestFile(string $fileName) : SplFileInfo
Parameters
- $fileName : string
Return values
SplFileInfo —createUrl()
Build a Farah URL for the given path, with this module's URL as base.
public
createUrl([FarahUrlPath|string $path = null ][, FarahUrlArguments|string $args = null ][, FarahUrlStreamIdentifier|string $fragment = null ]) : FarahUrl
Parameters
- $path : FarahUrlPath|string = null
- $args : FarahUrlArguments|string = null
- $fragment : FarahUrlStreamIdentifier|string = null
Return values
FarahUrl —getId()
The Farah URL that represents this module.
public
getId() : string
$this === Module::resolveToManifest($this->getId())
Return values
string —lookupAsset()
public
lookupAsset(FarahUrlPath|string $path) : AssetInterface
Parameters
- $path : FarahUrlPath|string
Return values
AssetInterface —normalizeManifestElement()
Set any missing attributes according to the AssetBuilderStrategy.
public
normalizeManifestElement(LeanElement $parent, LeanElement $child) : void
Parameters
- $parent : LeanElement
- $child : LeanElement
Return values
void —normalizeManifestTree()
public
normalizeManifestTree(LeanElement $root) : void
Parameters
- $root : LeanElement