Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
100.00% |
1 / 1 |
|
100.00% |
0 / 0 |
CRAP | |
100.00% |
0 / 0 |
FieldFormatter | |
100.00% |
1 / 1 |
|
100.00% |
0 / 0 |
0 | |
100.00% |
0 / 0 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\Core\Field\Annotation\FieldFormatter. | |
*/ | |
namespace Drupal\Core\Field\Annotation; | |
use Drupal\Component\Annotation\Plugin; | |
/** | |
* 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(). | |
* | |
* @Annotation | |
* | |
* @see \Drupal\Core\Field\FormatterPluginManager | |
* @see \Drupal\Core\Field\FormatterInterface | |
* | |
* @ingroup field_formatter | |
*/ | |
class FieldFormatter extends Plugin { | |
/** | |
* The plugin ID. | |
* | |
* @var string | |
*/ | |
public $id; | |
/** | |
* The human-readable name of the formatter type. | |
* | |
* @ingroup plugin_translatable | |
* | |
* @var \Drupal\Core\Annotation\Translation | |
*/ | |
public $label; | |
/** | |
* A short description of the formatter type. | |
* | |
* @ingroup plugin_translatable | |
* | |
* @var \Drupal\Core\Annotation\Translation | |
*/ | |
public $description; | |
/** | |
* The name of the field formatter class. | |
* | |
* This is not provided manually, it will be added by the discovery mechanism. | |
* | |
* @var string | |
*/ | |
public $class; | |
/** | |
* An array of field types the formatter supports. | |
* | |
* @var array | |
*/ | |
public $field_types = array(); | |
/** | |
* 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. | |
* | |
* @var int optional | |
*/ | |
public $weight = NULL; | |
} |