PHP Class FluidTYPO3\Vhs\ViewHelpers\Asset\AbstractAssetViewHelper

Note: building of all Assets takes place in the class FluidTYPO3\Vhs\Service\AssetService with two reasons: - A "buildAll" method should never be possible to call from any Asset ViewHelper; it should only be possible from a single class. - The method but must be public and non-static and thus cannot be hidden from access by subclasses if placed in this class.

Inheritance: extends TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper, implements FluidTYPO3\Vhs\ViewHelpers\Asset\AssetInterface, use trait FluidTYPO3\Vhs\Traits\ArrayConsumingViewHelperTrait

Afficher le fichier Open project: fluidtypo3/vhs Class Usage Examples

Protected Properties

Свойство	Type	Description
$assetService	FluidTYPO3\Vhs\Service\AssetService
$configurationManager	TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
$content	string
$localSettings	array
$objectManager	TYPO3\CMS\Extbase\Object\ObjectManagerInterface
$tagBuilder	TYPO3\CMS\Fluid\Core\ViewHelper\TagBuilder
$type	string	If a LESS stylesheet is being compiled the "type" would be "css" because this will group the compiled LESS stylesheet with other CSS - allowing it to be merged with other CSS.

Méthodes publiques

Méthode	Description
__toString ( ) : string
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 an/ord ViewHelper attributes.
assertFluidEnabled ( ) : boolean	Returns TRUE of 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
getGroup ( ) : string
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
initializeArguments ( ) : void
injectAssetService ( AssetService $assetService ) : void
injectConfigurationManager ( TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager ) : void
injectObjectManager ( TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager ) : void
render ( ) : void	Render method
setSettings ( array \| ArrayAccess $settings )

Méthodes protégées

Méthode	Description
debug ( ) : mixed
finalize ( ) : void	Saves this Asset or perhaps discards it if overriding is disabled and an identically named Asset already exists.
getContent ( ) : string
getOverwrite ( ) : boolean
getTagWithContent ( ) : string

Method Details

__toString() public méthode

public __toString ( ) : string
Résultat	string

assertAddNameCommentWithChunk() public méthode

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
Résultat	boolean

assertAllowedInFooter() public méthode

public assertAllowedInFooter ( ) : boolean
Résultat	boolean

assertDebugEnabled() public méthode

Returns TRUE if the current Asset should be debugged as commanded by settings in TypoScript an/ord ViewHelper attributes.

public assertDebugEnabled ( ) : boolean
Résultat	boolean

assertFluidEnabled() public méthode

Returns TRUE of 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
Résultat	boolean

assertHasBeenRemoved() public méthode

public assertHasBeenRemoved ( ) : boolean
Résultat	boolean

build() public méthode

- 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
Résultat	mixed

debug() protected méthode

protected debug ( ) : mixed
Résultat	mixed

finalize() protected méthode

Performed from every Asset's render() for it to work.

protected finalize ( ) : void
Résultat	void

getAssetSettings() public méthode

public getAssetSettings ( ) : array
Résultat	array

getContent() protected méthode

protected getContent ( ) : string
Résultat	string

getDebugInformation() public méthode

Allows public access to debug this particular Asset instance later, when including the Asset in the page.

public getDebugInformation ( ) : array
Résultat	array

getDependencies() public méthode

public getDependencies ( ) : array
Résultat	array

getGroup() public méthode

public getGroup ( ) : string
Résultat	string

getName() public méthode

public getName ( ) : string
Résultat	string

getOverwrite() protected méthode

protected getOverwrite ( ) : boolean
Résultat	boolean

getSettings() public méthode

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
Résultat	array

getTagWithContent() protected méthode

protected getTagWithContent ( ) : string
Résultat	string

getType() public méthode

public getType ( ) : string
Résultat	string

getVariables() public méthode

public getVariables ( ) : array
Résultat	array

initializeArguments() public méthode

public initializeArguments ( ) : void
Résultat	void

injectAssetService() public méthode

public injectAssetService ( AssetService $assetService ) : void
$assetService	FluidTYPO3\Vhs\Service\AssetService
Résultat	void

injectConfigurationManager() public méthode

public injectConfigurationManager ( TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager ) : void
$configurationManager	TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
Résultat	void

injectObjectManager() public méthode

public injectObjectManager ( TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager ) : void
$objectManager	TYPO3\CMS\Extbase\Object\ObjectManagerInterface
Résultat	void

render() public méthode

Render method

public render ( ) : void
Résultat	void

setSettings() public méthode

public setSettings ( array \| ArrayAccess $settings )
$settings	array \| ArrayAccess

Property Details

$assetService protected_oe property

protected AssetService,FluidTYPO3\Vhs\Service $assetService
Résultat	FluidTYPO3\Vhs\Service\AssetService

$configurationManager protected_oe property

protected ConfigurationManagerInterface,TYPO3\CMS\Extbase\Configuration $configurationManager
Résultat	TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface

$content protected_oe property

protected string $content
Résultat	string

$localSettings protected_oe property

protected array $localSettings
Résultat	array

$objectManager protected_oe property

protected ObjectManagerInterface,TYPO3\CMS\Extbase\Object $objectManager
Résultat	TYPO3\CMS\Extbase\Object\ObjectManagerInterface

$tagBuilder protected_oe property

protected TagBuilder,TYPO3\CMS\Fluid\Core\ViewHelper $tagBuilder
Résultat	TYPO3\CMS\Fluid\Core\ViewHelper\TagBuilder

$type protected_oe property

If a LESS stylesheet is being compiled the "type" would be "css" because this will group the compiled LESS stylesheet with other CSS - allowing it to be merged with other CSS.

protected string $type
Résultat	string