FieldFormatter
class FieldFormatter extends Plugin (View source)
Defines a FieldFormatter annotation object.
Formatters handle the display of field values. They are typically instantiated and invoked by an EntityDisplay object.
Additional annotation keys for formatters can be defined in hook_field_formatter_info_alter().
Properties
| protected array | $definition | The plugin definition read from the class annotation. |
from Plugin |
| string | $id | The plugin ID. |
|
| Translation | $label | The human-readable name of the formatter type. |
|
| Translation | $description | A short description of the formatter type. |
|
| string | $class | The name of the field formatter class. |
|
| array | $field_types | An array of field types the formatter supports. |
|
| int | $weight | An integer to determine the weight of this formatter relative to other formatter in the Field UI when selecting a formatter for a given field instance. |
Methods
Details
in
Plugin at line 35
__construct($values)
Constructs a Plugin object.
Builds up the plugin definition and invokes the get() method for any classed annotations that were used.
in
Plugin at line 54
protected array
parse(array $values)
Parses an annotation into its definition.
in
Plugin at line 73
get()
Gets the value of an annotation.
in
Plugin at line 80
string
getProvider()
Gets the name of the provider of the annotated class.
in
Plugin at line 87
setProvider(string $provider)
Sets the name of the provider of the annotated class.
in
Plugin at line 94
string
getId()
Gets the unique ID for this annotated class.
string
getClass()
Gets the class of the annotated class.
setClass(string $class)
Sets the class of the annotated class.