PHP Class Neos\Neos\Service\HtmlAugmenter
This is used in order to add meta data arguments to content elements in the Backend.
Usage:
$html = '
Some HTML code
';
$result = (new HtmlAugmenter())->addAttributes($html, array('foo' => 'bar', 'bar' => 'baz'));
will return '
Show file
Open project: neos/neos-development-collection
Class Usage Examples
Public Methods
| Method |
Description |
|
|
addAttributes ( string $html, array $attributes, string $fallbackTagName = 'div', array $exclusiveAttributes = null ) : string |
Adds the given $attributes to the $html by augmenting the root element. |
|
Protected Methods
| Method |
Description |
|
|
elementHasAttributes ( DOMNode $element, array $attributes = null ) : boolean |
Checks whether the given $element contains at least one of the specified $attributes (case insensitive) |
|
|
getHtmlRootElement ( string $html ) : DOMNode |
Detects a unique root tag in the given $html string and returns its DOMNode representation - or NULL if no unique root element could be found |
|
|
mergeAttributes ( DOMNode $element, array &$newAttributes ) : void |
Merges the attributes of $element with the given $newAttributes
If an attribute exists in both collections, it is merged to " " (if both values differ) |
|
|
renderAttributes ( array $attributes ) : string |
Renders the given key/value pair to a valid attribute string in the format ="" ="". |
|
Method Details
addAttributes()
public method
Attributes are merged with the existing root element's attributes.
If no unique root node can be determined, a wrapping tag is added with all the given attributes. The name of this
tag can be specified with $fallbackTagName.
|
public addAttributes ( string $html, array $attributes, string $fallbackTagName = 'div', array $exclusiveAttributes = null ) : string |
|
$html |
string |
The HTML code to augment |
|
$attributes |
array |
Attributes to be added to the root element in the format array('' => '', ...) |
|
$fallbackTagName |
string |
The root element tag name if one needs to be added |
|
$exclusiveAttributes |
array |
A list of lowercase(!) attribute names that should be exclusive to the root element. If the existing root element contains one of these a new root element is wrapped |
| return |
string |
|
elementHasAttributes()
protected method
Checks whether the given $element contains at least one of the specified $attributes (case insensitive)
|
protected elementHasAttributes ( DOMNode $element, array $attributes = null ) : boolean |
|
$element |
DOMNode |
|
|
$attributes |
array |
array of attribute names to check (lowercase) |
| return |
boolean |
TRUE if at least one of the $attributes is contained in the given $element, otherwise FALSE |
getHtmlRootElement()
protected method
Detects a unique root tag in the given $html string and returns its DOMNode representation - or NULL if no unique root element could be found
mergeAttributes()
protected method
Merges the attributes of $element with the given $newAttributes
If an attribute exists in both collections, it is merged to "
" (if both values differ)
renderAttributes()
protected method
