You are here

class ExampleFormattedField in Extra Field 8.2

Same name and namespace in other branches
  1. 8 modules/extra_field_example/src/Plugin/ExtraField/Display/ExampleFormattedField.php \Drupal\extra_field_example\Plugin\ExtraField\Display\ExampleFormattedField

Example Extra field with formatted output.

Plugin annotation


@ExtraFieldDisplay(
  id = "formatted_field",
  label = @Translation("Data formatted as field with label"),
  description = @Translation("An extra field to display multiple text items."),
  bundles = {
    "node.article",
  }
)

Hierarchy

Expanded class hierarchy of ExampleFormattedField

File

modules/extra_field_example/src/Plugin/ExtraField/Display/ExampleFormattedField.php, line 21

Namespace

Drupal\extra_field_example\Plugin\ExtraField\Display
View source
class ExampleFormattedField extends ExtraFieldDisplayFormattedBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this
      ->t('Three items');
  }

  /**
   * {@inheritdoc}
   */
  public function getLabelDisplay() {
    return 'above';
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(ContentEntityInterface $entity) {
    return [
      [
        '#markup' => 'One',
      ],
      [
        '#markup' => 'Two',
      ],
      [
        '#markup' => 'Three',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ExampleFormattedField::getLabel public function The label of the field. Overrides ExtraFieldDisplayFormattedBase::getLabel
ExampleFormattedField::getLabelDisplay public function How to display the field label will be displayed. Overrides ExtraFieldDisplayFormattedBase::getLabelDisplay
ExampleFormattedField::viewElements public function Returns the renderable array of the field item(s). Overrides ExtraFieldDisplayFormattedInterface::viewElements
ExtraFieldDisplayBase::$entity protected property The field's parent entity.
ExtraFieldDisplayBase::$entityViewDisplay protected property The entity view display.
ExtraFieldDisplayBase::$viewMode protected property The view mode the entity is rendered in.
ExtraFieldDisplayBase::getEntity public function Returns the field's parent entity. Overrides ExtraFieldDisplayInterface::getEntity
ExtraFieldDisplayBase::getEntityViewDisplay public function Returns the entity view display object of the field's host entity. Overrides ExtraFieldDisplayInterface::getEntityViewDisplay
ExtraFieldDisplayBase::getViewMode public function Returns the entity view mode object of the field's host entity. Overrides ExtraFieldDisplayInterface::getViewMode
ExtraFieldDisplayBase::setEntity public function Stores the field's parent entity. Overrides ExtraFieldDisplayInterface::setEntity
ExtraFieldDisplayBase::setEntityViewDisplay public function Stores the entity view display. Overrides ExtraFieldDisplayInterface::setEntityViewDisplay
ExtraFieldDisplayBase::setViewMode public function Stores the entity view mode. Overrides ExtraFieldDisplayInterface::setViewMode
ExtraFieldDisplayFormattedBase::$isEmpty protected property Flag to indicate that the extra field has no content.
ExtraFieldDisplayFormattedBase::$langcode protected property The langcode of the field values.
ExtraFieldDisplayFormattedBase::$languageManager protected property The language manager.
ExtraFieldDisplayFormattedBase::getFieldName public function The machine name of the field. Overrides ExtraFieldDisplayFormattedInterface::getFieldName 1
ExtraFieldDisplayFormattedBase::getFieldType public function The type of field. Overrides ExtraFieldDisplayFormattedInterface::getFieldType 1
ExtraFieldDisplayFormattedBase::getLangcode public function Gets the langcode of the field values. Overrides ExtraFieldDisplayFormattedInterface::getLangcode 1
ExtraFieldDisplayFormattedBase::isEmpty public function Check if the extra field has data. Overrides ExtraFieldDisplayFormattedInterface::isEmpty
ExtraFieldDisplayFormattedBase::isTranslatable public function The field is translatable. Overrides ExtraFieldDisplayFormattedInterface::isTranslatable 1
ExtraFieldDisplayFormattedBase::setLangcode public function Set the language code.
ExtraFieldDisplayFormattedBase::view public function Builds a renderable array for the field. Overrides ExtraFieldDisplayInterface::view
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.