class WebformEntityReferenceItem in Webform 6.x

Same name and namespace in other branches

8.5 src/Plugin/Field/FieldType/WebformEntityReferenceItem.php \Drupal\webform\Plugin\Field\FieldType\WebformEntityReferenceItem

Defines the 'webform_entity_reference' entity field type.

Extends EntityReferenceItem and only support targeting webform entities.

Plugin annotation


@FieldType(
  id = "webform",
  label = @Translation("Webform"),
  description = @Translation("A webform containing default submission values."),
  category = @Translation("Reference"),
  default_widget = "webform_entity_reference_select",
  default_formatter = "webform_entity_reference_entity_view",
  list_class = "\Drupal\webform\Plugin\Field\FieldType\WebformEntityReferenceFieldItemList",
)

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\Core\Field\Plugin\Field\FieldType\EntityReferenceItem implements PreconfiguredFieldUiOptionsInterface, OptionsProviderInterface
    class \Drupal\webform\Plugin\Field\FieldType\WebformEntityReferenceItem

Expanded class hierarchy of WebformEntityReferenceItem

2 files declare their use of WebformEntityReferenceItem

WebformEntityReferenceFormatterBase.php in src/Plugin/Field/FieldFormatter/WebformEntityReferenceFormatterBase.php
WebformEntityReferenceItemNormalizer.php in src/Normalizer/WebformEntityReferenceItemNormalizer.php

File

src/Plugin/Field/FieldType/WebformEntityReferenceItem.php, line 27

Namespace

Drupal\webform\Plugin\Field\FieldType

View source

class WebformEntityReferenceItem extends EntityReferenceItem {

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [
      'target_type' => 'webform',
    ] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'target_id' => [
          'description' => 'The ID of the webform entity.',
          'type' => 'varchar_ascii',
          'length' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
        ],
        'default_data' => [
          'description' => 'Default submission data.',
          'type' => 'text',
        ],
        'status' => [
          'description' => 'Flag to control whether this webform should be open, closed, or scheduled for new submissions.',
          'type' => 'varchar',
          'length' => 20,
        ],
        'open' => [
          'description' => 'The open date/time.',
          'type' => 'varchar',
          'length' => 20,
        ],
        'close' => [
          'description' => 'The close date/time.',
          'type' => 'varchar',
          'length' => 20,
        ],
      ],
      'indexes' => [
        'target_id' => [
          'target_id',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);
    $properties['default_data'] = DataDefinition::create('string')
      ->setLabel(t('Default submission data'));
    $properties['status'] = DataDefinition::create('string')
      ->setLabel(t('Status'))
      ->setDescription(t('Flag to control whether this webform should be open or closed to new submissions.'));
    $properties['open'] = DataDefinition::create('datetime_iso8601')
      ->setLabel(t('Open value'));
    $properties['close'] = DataDefinition::create('datetime_iso8601')
      ->setLabel(t('Close value'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public static function getPreconfiguredOptions() {
    return [];
  }

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

    // Get webform options grouped by category.

    /** @var \Drupal\webform\WebformEntityStorageInterface $webform_storage */
    $webform_storage = \Drupal::service('entity_type.manager')
      ->getStorage('webform');
    return $webform_storage
      ->getOptions(FALSE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityReferenceItem::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemBase::calculateDependencies
EntityReferenceItem::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemBase::calculateStorageDependencies
EntityReferenceItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings	1
EntityReferenceItem::fieldSettingsAjaxProcess	public static	function	Render API callback: Processes the field settings form.
EntityReferenceItem::fieldSettingsAjaxProcessElement	public static	function	Adds entity_reference specific properties to AJAX form elements from the field settings form.
EntityReferenceItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm	1
EntityReferenceItem::fieldSettingsFormValidate	public static	function	Form element validation handler; Invokes selection plugin's validation.
EntityReferenceItem::formProcessMergeParent	public static	function	Render API callback: Moves entity_reference specific Form API elements (i.e. 'handler_settings') up a level for easier processing by the validation and submission handlers.
EntityReferenceItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemBase::generateSampleValue	1
EntityReferenceItem::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints
EntityReferenceItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
EntityReferenceItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
EntityReferenceItem::getRandomBundle	protected static	function	Gets a bundle for a given entity type and selection options.
EntityReferenceItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
EntityReferenceItem::getValue	public	function	Gets the data value. Overrides Map::getValue
EntityReferenceItem::hasNewEntity	public	function	Determines whether the item holds an unsaved entity.
EntityReferenceItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
EntityReferenceItem::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
EntityReferenceItem::onChange	public	function	React to changes to a child property or item. Overrides Map::onChange
EntityReferenceItem::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemBase::onDependencyRemoval
EntityReferenceItem::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemBase::preSave	1
EntityReferenceItem::settingsAjax	public static	function	Ajax callback for the handler settings form.
EntityReferenceItem::settingsAjaxSubmit	public static	function	Submit handler for the non-JS case.
EntityReferenceItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
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::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::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
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::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.	4
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::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
WebformEntityReferenceItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides EntityReferenceItem::defaultStorageSettings
WebformEntityReferenceItem::getPreconfiguredOptions	public static	function	Returns preconfigured field options for a field type. Overrides EntityReferenceItem::getPreconfiguredOptions
WebformEntityReferenceItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides EntityReferenceItem::getSettableOptions
WebformEntityReferenceItem::propertyDefinitions	public static	function	Defines field item properties. Overrides EntityReferenceItem::propertyDefinitions
WebformEntityReferenceItem::schema	public static	function	Returns the schema for the field. Overrides EntityReferenceItem::schema
WebformEntityReferenceItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides EntityReferenceItem::storageSettingsForm

You are here