PHP Class Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper

Should be used as the base class for all view helpers which output simple tags, as it provides some convenience methods to register default attributes, ...
Inheritance: extends AbstractViewHelper
Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$escapeOutput boolean Disable escaping of tag based ViewHelpers so that the rendered tag is not htmlspecialchar'd
$tag TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder Tag builder instance
$tagName string Name of the tag to be created by this view helper

Public Methods

Method Description
__construct ( ) Constructor
handleAdditionalArguments ( array $arguments ) : void Handles additional arguments, sorting out any data- prefixed tag attributes and assigning them. Then passes the unassigned arguments to the parent class' method, which in the default implementation will throw an error about "undeclared argument used".
initialize ( ) : void Sets the tag name to $this->tagName.
injectTagBuilder ( TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder $tag ) : void

Protected Methods

Method Description
registerTagAttribute ( string $name, string $type, string $description, boolean $required = false, mixed $defaultValue = null ) : void Register a new tag attribute. Tag attributes are all arguments which will be directly appended to a tag if you call $this->initializeTag()
registerUniversalTagAttributes ( ) : void Registers all standard HTML universal attributes.

Method Details

__construct() public method

Constructor
public __construct ( )

handleAdditionalArguments() public method

Handles additional arguments, sorting out any data- prefixed tag attributes and assigning them. Then passes the unassigned arguments to the parent class' method, which in the default implementation will throw an error about "undeclared argument used".
public handleAdditionalArguments ( array $arguments ) : void
$arguments array
return void

initialize() public method

Additionally, sets all tag attributes which were registered in $this->tagAttributes and additionalArguments. Will be invoked just before the render method.
public initialize ( ) : void
return void

injectTagBuilder() public method

public injectTagBuilder ( TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder $tag ) : void
$tag TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder
return void

registerTagAttribute() protected method

Register a new tag attribute. Tag attributes are all arguments which will be directly appended to a tag if you call $this->initializeTag()
protected registerTagAttribute ( string $name, string $type, string $description, boolean $required = false, mixed $defaultValue = null ) : void
$name string Name of tag attribute
$type string Type of the tag attribute
$description string Description of tag attribute
$required boolean set to TRUE if tag attribute is required. Defaults to FALSE.
$defaultValue mixed Optional, default value of attribute if one applies
return void

registerUniversalTagAttributes() protected method

Should be used inside registerArguments();
protected registerUniversalTagAttributes ( ) : void
return void

Property Details

$escapeOutput protected property

Disable escaping of tag based ViewHelpers so that the rendered tag is not htmlspecialchar'd
protected bool $escapeOutput
return boolean

$tag protected property

Tag builder instance
protected TagBuilder,TYPO3Fluid\Fluid\Core\ViewHelper $tag
return TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder

$tagName protected property

Name of the tag to be created by this view helper
protected string $tagName
return string