class TestFieldDefaultFormatter

Plugin implementation of the 'field_test_default' formatter.

Plugin annotation


@Plugin(
  id = "field_test_default",
  module = "field_test",
  label = @Translation("Default"),
  description = @Translation("Default formatter"),
  field_types = {
    "test_field"
  },
  settings = {
    "test_formatter_setting" = "dummy test string"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
  - class \Drupal\field\Plugin\Type\Formatter\FormatterBase implements FormatterInterface
    class \Drupal\field_test\Plugin\field\formatter\TestFieldDefaultFormatter

Expanded class hierarchy of TestFieldDefaultFormatter

File

drupal/core/modules/field/tests/modules/field_test/lib/Drupal/field_test/Plugin/field/formatter/TestFieldDefaultFormatter.php, line 31: Definition of Drupal\field_test\Plugin\field\formatter\TestFieldDefaultFormatter.

Namespace

Drupal\field_test\Plugin\field\formatter

View source

class TestFieldDefaultFormatter extends FormatterBase {

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm().
   */
  public function settingsForm(array $form, array &$form_state) {
    $element['test_formatter_setting'] = array(
      '#title' => t('Setting'),
      '#type' => 'textfield',
      '#size' => 20,
      '#default_value' => $this
        ->getSetting('test_formatter_setting'),
      '#required' => TRUE,
    );
    return $element;
  }

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm().
   */
  public function settingsSummary() {
    return t('@setting: @value', array(
      '@setting' => 'test_formatter_setting',
      '@value' => $this
        ->getSetting('test_formatter_setting'),
    ));
  }

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::viewElements().
   */
  public function viewElements(EntityInterface $entity, $langcode, array $items) {
    $elements = array();
    foreach ($items as $delta => $item) {
      $elements[$delta] = array(
        '#markup' => $this
          ->getSetting('test_formatter_setting') . '|' . $item['value'],
      );
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FormatterBase::$field	protected	property	The field definition.
FormatterBase::$instance	protected	property	The field instance definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::$weight	protected	property	The formatter weight.
FormatterBase::prepareView	public	function	Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::prepareView(). Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::view(). Overrides FormatterInterface::view
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$discovery	protected	property	The discovery object.
PluginBase::$plugin_id	protected	property	The plugin_id.
PluginBase::getDefinition	public	function	Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId	public	function	Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::getDefaultSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface::getDefaultSettings
PluginSettingsBase::getSetting	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::setSetting	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface::setSettings
TestFieldDefaultFormatter::settingsForm	public	function	Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm(). Overrides FormatterBase::settingsForm
TestFieldDefaultFormatter::settingsSummary	public	function	Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm(). Overrides FormatterBase::settingsSummary
TestFieldDefaultFormatter::viewElements	public	function	Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::viewElements(). Overrides FormatterInterface::viewElements

Main menu

Search Drupal 9.x

API Navigation

class TestFieldDefaultFormatter

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 9.x

API Navigation

class TestFieldDefaultFormatter

Plugin annotation

Hierarchy

File

Namespace

Members