AssetInterface
in
Tags
Table of Contents
Methods
- __toString() : string
- createUrl() : FarahUrl
- Create a FarahUrl for this asset, with arguments and stream set as supplied.
- getAssetChildren() : array<string|int, AssetInterface>
- Get all child assets.
- getFileInfo() : FarahUrlPath|null
- Get the filesystem entry for this asset.
- getManifestElement() : LeanElement
- getSuppliedParameters() : iterable<string|int, mixed>
- Get the parameters supplied by this assets's ParameterSupplierStrategy.
- getUrlPath() : FarahUrlPath|null
- Get the FarahUrlPath for this asset.
- isImportChildrenInstruction() : bool
- isImportSelfInstruction() : bool
- isLinkModuleInstruction() : bool
- isLinkScriptInstruction() : bool
- isLinkStylesheetInstruction() : bool
- isParameterSupplierInstruction() : bool
- isUseDocumentInstruction() : bool
- isUseManifestInstruction() : bool
- isUseTemplateInstruction() : bool
- lookupExecutable() : ExecutableInterface
- Create the executable for this asset, with the arguments supplied.
- normalizeManifestElement() : void
- Set any missing attributes according to the manifest's AssetBuilderStrategy.
- traverseTo() : AssetInterface
- Traverse to a descendant asset.
Methods
__toString()
public
__toString() : string
Return values
stringcreateUrl()
Create a FarahUrl for this asset, with arguments and stream set as supplied.
public
createUrl([FarahUrlArguments|string $args = null ][, FarahUrlStreamIdentifier|string $fragment = null ]) : FarahUrl
Parameters
- $args : FarahUrlArguments|string = null
- $fragment : FarahUrlStreamIdentifier|string = null
Return values
FarahUrlgetAssetChildren()
Get all child assets.
public
getAssetChildren() : array<string|int, AssetInterface>
Return values
array<string|int, AssetInterface>getFileInfo()
Get the filesystem entry for this asset.
public
getFileInfo() : FarahUrlPath|null
This might be a file, a directory, or it might not physically exist.
Return values
FarahUrlPath|nullgetManifestElement()
public
getManifestElement() : LeanElement
Return values
LeanElementgetSuppliedParameters()
Get the parameters supplied by this assets's ParameterSupplierStrategy.
public
getSuppliedParameters() : iterable<string|int, mixed>
Return values
iterable<string|int, mixed>getUrlPath()
Get the FarahUrlPath for this asset.
public
getUrlPath() : FarahUrlPath|null
Return values
FarahUrlPath|nullisImportChildrenInstruction()
public
isImportChildrenInstruction() : bool
Return values
boolisImportSelfInstruction()
public
isImportSelfInstruction() : bool
Return values
boolisLinkModuleInstruction()
public
isLinkModuleInstruction() : bool
Return values
boolisLinkScriptInstruction()
public
isLinkScriptInstruction() : bool
Return values
boolisLinkStylesheetInstruction()
public
isLinkStylesheetInstruction() : bool
Return values
boolisParameterSupplierInstruction()
public
isParameterSupplierInstruction() : bool
Return values
boolisUseDocumentInstruction()
public
isUseDocumentInstruction() : bool
Return values
boolisUseManifestInstruction()
public
isUseManifestInstruction() : bool
Return values
boolisUseTemplateInstruction()
public
isUseTemplateInstruction() : bool
Return values
boollookupExecutable()
Create the executable for this asset, with the arguments supplied.
public
lookupExecutable([FarahUrlArguments $args = null ]) : ExecutableInterface
Parameters
- $args : FarahUrlArguments = null
Return values
ExecutableInterfacenormalizeManifestElement()
Set any missing attributes according to the manifest's AssetBuilderStrategy.
public
normalizeManifestElement(LeanElement $child) : void
Parameters
- $child : LeanElement
traverseTo()
Traverse to a descendant asset.
public
traverseTo(string $path) : AssetInterface
Parameters
- $path : string