Documentation

Manifest
in package
implements ManifestInterface

Interfaces, Classes and Traits

ManifestInterface

Table of Contents

ATTR_ALIAS  = 'as'
ATTR_ASSETPATH  = 'assetpath'
ATTR_HREF  = 'href'
ATTR_ID  = 'url'
ATTR_NAME  = 'name'
ATTR_PARAM_KEY  = 'name'
ATTR_PARAM_VAL  = 'value'
ATTR_PATH  = 'path'
ATTR_REALPATH  = 'realpath'
ATTR_REFERENCE  = 'ref'
ATTR_SRC  = 'src'
ATTR_TYPE  = 'type'
ATTR_USE  = 'use'
ATTR_USE_DOCUMENT  = 'document'
ATTR_USE_MANIFEST  = 'manifest'
ATTR_USE_SCRIPT  = 'script'
ATTR_USE_STYLESHEET  = 'stylesheet'
ATTR_USE_TEMPLATE  = 'template'
EVENT_SET_PARAMETER  = 'set-parameter'
EVENT_USE_DOCUMENT  = 'use-document'
EVENT_USE_SCRIPT  = 'use-script'
EVENT_USE_STYLESHEET  = 'use-stylesheet'
EVENT_USE_TEMPLATE  = 'use-template'
FILE_MANIFEST  = 'manifest.xml'
TAG_ASSET_ROOT  = 'assets'
TAG_CLOSURE  = 'closure'
TAG_CONTAINER  = 'container'
TAG_CUSTOM_ASSET  = 'custom-asset'
TAG_DAEMON  = 'daemon'
TAG_DIRECTORY  = 'directory'
TAG_DOCUMENT  = 'document'
TAG_ERROR  = 'error'
TAG_EXTERNAL_RESOURCE  = 'external-resource'
TAG_FRAGMENT  = 'fragment'
TAG_IMPORT  = 'import'
TAG_LINK_MODULE  = 'link-module'
TAG_LINK_SCRIPT  = 'link-script'
TAG_LINK_STYLESHEET  = 'link-stylesheet'
TAG_OPTIONS  = 'options'
TAG_PARAM  = 'param'
TAG_RESOURCE  = 'resource'
TAG_RESOURCE_DIRECTORY  = 'resource-directory'
TAG_SOURCE  = 'source'
TAG_TEMPLATE_RESOURCE  = 'template-resource'
TAG_USE_DOCUMENT  = 'use-document'
TAG_USE_MANIFEST  = 'use-manifest'
TAG_USE_TEMPLATE  = 'use-template'
TEMPLATE_ERROR  = 'slothsoft@farah/xsl/error'
__construct()  : mixed
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
normalizeElement()  : void
normalizeManifestElement()  : void
Set any missing attributes according to the AssetBuilderStrategy.
normalizeManifestTree()  : void

Constants

ATTR_ALIAS

public mixed ATTR_ALIAS = 'as'

ATTR_ASSETPATH

public mixed ATTR_ASSETPATH = 'assetpath'

ATTR_HREF

public mixed ATTR_HREF = 'href'

ATTR_NAME

public mixed ATTR_NAME = 'name'

ATTR_PARAM_KEY

public mixed ATTR_PARAM_KEY = 'name'

ATTR_PARAM_VAL

public mixed ATTR_PARAM_VAL = 'value'

ATTR_PATH

public mixed ATTR_PATH = 'path'

ATTR_REALPATH

public mixed ATTR_REALPATH = 'realpath'

ATTR_REFERENCE

public mixed ATTR_REFERENCE = 'ref'

ATTR_TYPE

public mixed ATTR_TYPE = 'type'

ATTR_USE_DOCUMENT

public mixed ATTR_USE_DOCUMENT = 'document'

ATTR_USE_MANIFEST

public mixed ATTR_USE_MANIFEST = 'manifest'

ATTR_USE_SCRIPT

public mixed ATTR_USE_SCRIPT = 'script'

ATTR_USE_STYLESHEET

public mixed ATTR_USE_STYLESHEET = 'stylesheet'

ATTR_USE_TEMPLATE

public mixed ATTR_USE_TEMPLATE = 'template'

EVENT_SET_PARAMETER

public mixed EVENT_SET_PARAMETER = 'set-parameter'

EVENT_USE_DOCUMENT

public mixed EVENT_USE_DOCUMENT = 'use-document'

EVENT_USE_SCRIPT

public mixed EVENT_USE_SCRIPT = 'use-script'

EVENT_USE_STYLESHEET

public mixed EVENT_USE_STYLESHEET = 'use-stylesheet'

EVENT_USE_TEMPLATE

public mixed EVENT_USE_TEMPLATE = 'use-template'

FILE_MANIFEST

public mixed FILE_MANIFEST = 'manifest.xml'

TAG_ASSET_ROOT

public mixed TAG_ASSET_ROOT = 'assets'

TAG_CLOSURE

public mixed TAG_CLOSURE = 'closure'

TAG_CONTAINER

public mixed TAG_CONTAINER = 'container'

TAG_CUSTOM_ASSET

public mixed TAG_CUSTOM_ASSET = 'custom-asset'

TAG_DAEMON

public mixed TAG_DAEMON = 'daemon'

TAG_DIRECTORY

public mixed TAG_DIRECTORY = 'directory'

TAG_DOCUMENT

public mixed TAG_DOCUMENT = 'document'

TAG_ERROR

public mixed TAG_ERROR = 'error'

TAG_EXTERNAL_RESOURCE

public mixed TAG_EXTERNAL_RESOURCE = 'external-resource'

TAG_FRAGMENT

public mixed TAG_FRAGMENT = 'fragment'

TAG_IMPORT

public mixed TAG_IMPORT = 'import'
public mixed TAG_LINK_MODULE = 'link-module'
public mixed TAG_LINK_SCRIPT = 'link-script'
public mixed TAG_LINK_STYLESHEET = 'link-stylesheet'

TAG_OPTIONS

public mixed TAG_OPTIONS = 'options'

TAG_PARAM

public mixed TAG_PARAM = 'param'

TAG_RESOURCE

public mixed TAG_RESOURCE = 'resource'

TAG_RESOURCE_DIRECTORY

public mixed TAG_RESOURCE_DIRECTORY = 'resource-directory'

TAG_SOURCE

public mixed TAG_SOURCE = 'source'

TAG_TEMPLATE_RESOURCE

public mixed TAG_TEMPLATE_RESOURCE = 'template-resource'

TAG_USE_DOCUMENT

public mixed TAG_USE_DOCUMENT = 'use-document'

TAG_USE_MANIFEST

public mixed TAG_USE_MANIFEST = 'use-manifest'

TAG_USE_TEMPLATE

public mixed TAG_USE_TEMPLATE = 'use-template'

TEMPLATE_ERROR

public mixed TEMPLATE_ERROR = 'slothsoft@farah/xsl/error'

Methods

createCacheFile()

public createCacheFile(string $fileName[, mixed $path = null ][, mixed $args = null ][, mixed $fragment = null ]) : SplFileInfo
Parameters
$fileName : string
$path : mixed = null
$args : mixed = null
$fragment : mixed = null
Return values
SplFileInfo

createDataFile()

public createDataFile(string $fileName[, mixed $path = null ][, mixed $args = null ][, mixed $fragment = null ]) : SplFileInfo
Parameters
$fileName : string
$path : mixed = null
$args : mixed = null
$fragment : mixed = 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([mixed $path = null ][, mixed $args = null ][, mixed $fragment = null ]) : FarahUrl
Parameters
$path : mixed = null
$args : mixed = null
$fragment : mixed = null
Return values
FarahUrl

getId()

The Farah URL that represents this module.

public getId() : string

$this === Module::resolveToManifest($this->getId())

Return values
string

normalizeElement()

public normalizeElement(LeanElement $parent, LeanElement $element) : void
Parameters
$parent : LeanElement
$element : LeanElement
Return values
void

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
Return values
void

Search results