class EntityReferenceDisplayItem in Entity Reference Display 8

Plugin implementation of the 'entity_reference_display' field type.

Plugin annotation


@FieldType(
  id = "entity_reference_display",
  label = @Translation("Display mode"),
  description = @Translation("This field allows you to specify a display mode for entity reference field."),
  category = @Translation("Reference"),
  default_widget = "options_select",
  default_formatter = "list_default"
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\entity_reference_display\Plugin\Field\FieldType\EntityReferenceDisplayItem implements OptionsProviderInterface

Expanded class hierarchy of EntityReferenceDisplayItem

File

src/Plugin/Field/FieldType/EntityReferenceDisplayItem.php, line 25

Namespace

Drupal\entity_reference_display\Plugin\Field\FieldType

View source

class EntityReferenceDisplayItem extends FieldItemBase implements OptionsProviderInterface {

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    return [
      'value' => DataDefinition::create('string')
        ->setLabel(new TranslatableMarkup('Display mode'))
        ->setRequired(TRUE),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'value' => [
          'type' => 'varchar',
          'length' => 255,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'exclude' => [],
      'negate' => FALSE,
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = [];

    // Prepare select element with all options.
    $element['exclude'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Excluded display modes'),
      '#description' => $this
        ->t('Select all display modes which will not be offered.'),
      '#options' => $this
        ->getAllDisplayModes(),
      '#default_value' => $this
        ->getSetting('exclude'),
      '#multiple' => TRUE,
    ];
    $element['negate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include selected display modes instead of excluding'),
      '#description' => $this
        ->t('If checked, only display modes selected above will be offered.'),
      '#default_value' => $this
        ->getSetting('negate'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('value')
      ->getValue();
    return $value === NULL || $value === '';
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleValues(AccountInterface $account = NULL) {

    // Get values from possible options.
    return array_keys($this
      ->getPossibleOptions($account));
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleOptions(AccountInterface $account = NULL) {

    // Get all display modes in alphabetical order.
    $display_modes = $this
      ->getAllDisplayModes();

    // Get displays to exclude from options.
    $exclude = $this
      ->getSetting('exclude');

    // Check if display modes should be negated.
    $negate = !empty($this
      ->getSetting('negate'));

    // Get options array.
    $options = [];
    foreach ($display_modes as $key => $display_mode) {

      // Only if display is not excluded or it's negated and included.
      if (!$negate && !isset($exclude[$key]) || $negate && isset($exclude[$key])) {

        // Add display between options.
        $options[$key] = $display_mode;
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableValues(AccountInterface $account = NULL) {

    // Get values from settable options.
    return array_keys($this
      ->getSettableOptions($account));
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableOptions(AccountInterface $account = NULL) {

    // Get the same as from possible options.
    return $this
      ->getPossibleOptions($account);
  }

  /**
   * Get all display modes in alphabetical order with Default as first.
   */
  private function getAllDisplayModes() {

    // Get all display modes grouped by entity types.
    $display_modes = \Drupal::service('entity_display.repository')
      ->getAllViewModes();

    // Get basic information about display modes.
    $result = [];
    foreach ($display_modes as $modes) {
      foreach ($modes as $mode => $info) {

        // If display mode is not already in result set.
        if (!isset($result[$mode])) {
          $result[$mode] = $info['label'];
        }
      }
    }

    // Sort display modes in alphabetical order.
    asort($result);

    // Return array of all display modes prepended by Default.
    return [
      'default' => 'Default',
    ] + $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityReferenceDisplayItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
EntityReferenceDisplayItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
EntityReferenceDisplayItem::getAllDisplayModes	private	function	Get all display modes in alphabetical order with Default as first.
EntityReferenceDisplayItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
EntityReferenceDisplayItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
EntityReferenceDisplayItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
EntityReferenceDisplayItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
EntityReferenceDisplayItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
EntityReferenceDisplayItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
EntityReferenceDisplayItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
FieldItemBase::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies	1
FieldItemBase::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings	10
FieldItemBase::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemInterface::delete	2
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemInterface::generateSampleValue	18
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName	8
FieldItemBase::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval	1
FieldItemBase::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
FieldItemBase::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm	8
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
Map::onChange	public	function	Overrides TraversableTypedDataInterface::onChange	4
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
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.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class EntityReferenceDisplayItem in Entity Reference Display 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation