• Home
• FluidTYPO3
• Vhs
• Asset

PHP Class FluidTYPO3\Vhs\Asset

Class to create Assets in PHP. ### Examples: $asset = $this->objectManager->get('FluidTYPO3\\Vhs\\Asset'); OR you can use the static factory method which works anywhere including outside of Extbase. $asset = \FluidTYPO3\Vhs\Asset::getInstance(); $asset->setPath('fileadmin/test.js')->setStandalone(TRUE)->finalize(); Or simply: $this->objectManager->get('FluidTYPO3\\Vhs\\Asset')->setPath('...')->finalize(); And you can create clean instances: Depending on how you need to access the Asset afterwards, you will want wo switch between these methods. Or if you have all settings in an array (with members named according to the properties on this class: \FluidTYPO3\Vhs\Asset::createFromSettings($settings)->finalize(); Finally, if your Asset is file based, VHS can perform a few detections to set initial attributes like standalone, external (if file contains protocol), type (based on extension) and name (base name of file). \FluidTYPO3\Vhs\Asset::createFromFile($filePathAndFilename); \FluidTYPO3\Vhs\Asset::createFromUrl($urlToExternalFile); You can chain all setters on the class before finally calling finalize() to register the Asset (you can still modify the Asset afterwards, but an Asset that has not been finalize()'ed will never show up or be processed - which is a lot friendlier than requiring you to use remove() on unwanted Assets). > Note: the "createFrom..." suite of methods automatically calls finalize() > on your Asset just before returning it. You can of course keep modifying > the instance after it is returned - but when using a "createFrom"... method > VHS assumes you always want your Asset included in the output. Show file Open project: fluidtypo3/vhs Class Usage Examples

Protected Properties

Property	Type	Description
$configurationManager	TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
$content	string
$dependencies	array
$external	boolean
$fluid	boolean
$movable	boolean
$name	string
$namedChunks	boolean
$path	string
$removed	boolean
$rewrite	boolean
$settings	array
$standalone	boolean
$type	string
$variables	array

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 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:
createFromContent ( string $content ) : Asset
createFromFile ( string $filePathAndFilename ) : Asset
createFromSettings ( array $settings ) : Asset
createFromUrl ( string $url ) : Asset
finalize ( ) : Asset
getAssetSettings ( ) : array
getContent ( ) : string
getDebugInformation ( ) : array	Allows public access to debug this particular Asset instance later, when including the Asset in the page.
getDependencies ( ) : array
getExternal ( ) : boolean
getFluid ( ) : boolean
getInstance ( ) : Asset
getMovable ( ) : boolean
getName ( ) : string
getNamedChunks ( ) : boolean
getPath ( ) : string
getRemoved ( ) : boolean
getRewrite ( ) : boolean
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.
getStandalone ( ) : boolean
getType ( ) : string
getVariables ( ) : array
injectConfigurationManager ( TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager ) : void
remove ( ) : Asset
render ( ) : mixed	Render method
setContent ( string $content ) : Asset
setDependencies ( array $dependencies ) : Asset
setExternal ( boolean $external ) : Asset
setFluid ( boolean $fluid ) : Asset
setMovable ( boolean $movable )
setName ( string $name ) : Asset
setNamedChunks ( boolean $namedChunks ) : Asset
setPath ( string $path ) : Asset
setRemoved ( boolean $removed ) : Asset
setRewrite ( boolean $rewrite ) : Asset
setSettings ( array $settings ) : Asset
setStandalone ( boolean $standalone ) : Asset
setType ( string $type ) : Asset
setVariables ( array $variables ) : Asset

Method Details

Property Details