1. trait
  2. SilverStripe
  3. \
  4. View
  5. \
  6. AttributesHTML

AttributesHTML

trait AttributesHTML (View source)

This trait can be applied to a ViewableData class to add the logic to render attributes in an SS template.

When applying this trait to a class, you also need to add the following casting configuration.

private static $casting = [
    'AttributesHTML' => 'HTMLFragment',
    'getAttributesHTML' => 'HTMLFragment',
];

Methods

$this
setAttribute($name, $value)

Set an HTML attribute

mixed|null
getAttribute(string $name)

Retrieve the value of an HTML attribute

array
getAttributes()

Allows customization through an 'updateAttributes' hook on the base class.

string
getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to {@link getAttributes()}.

Details

at line 33
$this setAttribute($name, $value)

Set an HTML attribute

Parameters

$name
$value

Return Value

$this

at line 45
mixed|null getAttribute(string $name)

Retrieve the value of an HTML attribute

Parameters

string $name

Return Value

mixed|null

at line 72
array getAttributes()

Allows customization through an 'updateAttributes' hook on the base class.

Existing attributes are passed in as the first argument and can be manipulated, but any attributes added through a subclass implementation won't be included.

Return Value

array

at line 94
string getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to {@link getAttributes()}.

If at least one argument is passed as a string, all arguments act as excludes, by name.

Parameters

array $attributes

Return Value

string