PHP Interface FluidTYPO3\Vhs\ViewHelpers\Asset\AssetInterface

Datei anzeigen Open project: fluidtypo3/vhs Interface Usage Examples

Public Methods

Method Description
assertAddNameCommentWithChunk ( ) : boolean Returns TRUE if settings specify that the name of each Asset should be placed above the built content when placed in merged Asset cache files.
assertAllowedInFooter ( ) : boolean
assertDebugEnabled ( ) : boolean Returns TRUE if the current Asset should be debugged as commanded by settings in TypoScript and/or ViewHelper attributes.
assertFluidEnabled ( ) : boolean Returns TRUE if settings specify that the source of this Asset should be rendered as if it were a Fluid template, using variables from the "arguments" attribute
assertHasBeenRemoved ( ) : boolean
build ( ) : mixed Build this asset. Override this method in the specific implementation of an Asset in order to:
getAssetSettings ( ) : array
getDebugInformation ( ) : array Allows public access to debug this particular Asset instance later, when including the Asset in the page.
getDependencies ( ) : array
getName ( ) : string
getSettings ( ) : array Returns the settings used by this particular Asset during inclusion. Public access allows later inspection of the TypoScript values which were applied to the Asset.
getType ( ) : string
getVariables ( ) : array
render ( ) : void Render method

Method Details

assertAddNameCommentWithChunk() public method

Returns TRUE if settings specify that the name of each Asset should be placed above the built content when placed in merged Asset cache files.
public assertAddNameCommentWithChunk ( ) : boolean
return boolean

assertAllowedInFooter() public method

public assertAllowedInFooter ( ) : boolean
return boolean

assertDebugEnabled() public method

Returns TRUE if the current Asset should be debugged as commanded by settings in TypoScript and/or ViewHelper attributes.
public assertDebugEnabled ( ) : boolean
return boolean

assertFluidEnabled() public method

Returns TRUE if settings specify that the source of this Asset should be rendered as if it were a Fluid template, using variables from the "arguments" attribute
public assertFluidEnabled ( ) : boolean
return boolean

assertHasBeenRemoved() public method

public assertHasBeenRemoved ( ) : boolean
return boolean

build() public method

- if necessary compile the Asset (LESS, SASS, CoffeeScript etc) - make a final rendering decision based on arguments Note that within this function the ViewHelper and TemplateVariable Containers are not dependable, you cannot use the ControllerContext and RenderingContext and you should therefore also never call renderChildren from within this function. Anything else goes; CLI commands to build, caching implementations - you name it.
public build ( ) : mixed
return mixed

getAssetSettings() public method

public getAssetSettings ( ) : array
return array

getDebugInformation() public method

Allows public access to debug this particular Asset instance later, when including the Asset in the page.
public getDebugInformation ( ) : array
return array

getDependencies() public method

public getDependencies ( ) : array
return array

getName() public method

public getName ( ) : string
return string

getSettings() public method

Returns the settings used by this particular Asset during inclusion. Public access allows later inspection of the TypoScript values which were applied to the Asset.
public getSettings ( ) : array
return array

getType() public method

public getType ( ) : string
return string

getVariables() public method

public getVariables ( ) : array
return array

render() public method

Render method
public render ( ) : void
return void