You are here

Home » API reference » Radioactivity 4.0.x » RadioactivityReferenceWidget.php

class RadioactivityReferenceWidget in Radioactivity 4.0.x

Plugin implementation of the 'radioactivity_reference' widget.

Plugin annotation


@FieldWidget(
  id = "radioactivity_reference",
  label = @Translation("Radioactivity"),
  field_types = {
    "radioactivity_reference"
  }
)

Hierarchy

Expanded class hierarchy of RadioactivityReferenceWidget

File

src/Plugin/Field/FieldWidget/RadioactivityReferenceWidget.php, line 25

Namespace

Drupal\radioactivity\Plugin\Field\FieldWidget
View source 
class RadioactivityReferenceWidget extends WidgetBase {

  /**
   * Indicates whether the current widget instance is in translation.
   *
   * @var bool
   */
  protected $isTranslating;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ElementInfoManagerInterface $element_info) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->elementInfo = $element_info;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('element_info'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $host = $items
      ->getEntity();
    $this
      ->initIsTranslating($form_state, $host);
    $hasTargetEntity = !empty($items[$delta]->target_id) && $items[$delta]->entity;

    // The energy value is stored in the attached radioactivity entity. It is
    // copied from there so it can be managed by the user via the interface.
    $defaultEnergy = $host
      ->getFieldDefinition($items
      ->getName())
      ->getSetting('default_energy');
    if ($hasTargetEntity) {
      $defaultEnergy = $items[$delta]->entity
        ->getEnergy();
    }

    /** @var \Drupal\radioactivity\RadioactivityInterface $radioactivityEntity */
    $radioactivityEntity = $hasTargetEntity ? $items[$delta]->entity : Radioactivity::create([
      'energy' => $defaultEnergy,
    ]);
    if ($this->isTranslating && $items
      ->getFieldDefinition()
      ->isTranslatable()) {

      // If the field is being translated, the translated host entity should
      // refer to a different entity. The current one is replaced by a
      // duplicate with the field's translation language.
      if (!empty($form_state
        ->get('content_translation'))) {
        $radioactivityEntity = $radioactivityEntity
          ->createDuplicate();
        $radioactivityEntity
          ->setLangcode($form_state
          ->get('langcode'));
        $hasTargetEntity = FALSE;
      }
    }
    else {
      $radioactivityEntity
        ->setLangcode($form_state
        ->get('langcode'));
    }
    $elements = [];
    $elements['energy'] = [
      '#type' => 'textfield',
      '#pattern' => '[0-9]+(\\.[0-9]+)?',
      '#default_value' => $defaultEnergy,
    ] + $element;
    $elements['initial_energy'] = [
      '#type' => 'value',
      '#value' => $defaultEnergy,
    ];
    $elements['entity'] = [
      '#type' => 'value',
      '#value' => $radioactivityEntity,
    ];
    if ($hasTargetEntity) {
      $elements['target_id'] = [
        '#type' => 'value',
        '#default_value' => $items[$delta]->target_id,
      ];
    }
    if (!isset($form['advanced'])) {
      return $elements;
    }

    // Put the form elements into the form's "advanced" group.
    $elements += [
      '#type' => 'details',
      '#title' => $elements['energy']['#title'],
      '#group' => 'advanced',
      '#required' => TRUE,
      '#weight' => 40,
    ];
    return $elements;
  }

  /**
   * Initializes the translation form state.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   * @param \Drupal\Core\Entity\EntityInterface $host
   *   Host entity of the field.
   */
  protected function initIsTranslating(FormStateInterface $form_state, EntityInterface $host) {
    if ($this->isTranslating != NULL) {
      return;
    }
    $this->isTranslating = FALSE;
    if (!$host
      ->isTranslatable()) {
      return;
    }
    if (!$host
      ->getEntityType()
      ->hasKey('default_langcode')) {
      return;
    }
    $default_langcode_key = $host
      ->getEntityType()
      ->getKey('default_langcode');
    if (!$host
      ->hasField($default_langcode_key)) {
      return;
    }
    if (!empty($form_state
      ->get('content_translation'))) {

      // Adding a language through the ContentTranslationController.
      $this->isTranslating = TRUE;
    }
    if ($host
      ->hasTranslation($form_state
      ->get('langcode')) && $host
      ->getTranslation($form_state
      ->get('langcode'))
      ->get($default_langcode_key)->value == 0) {

      // Editing a translation.
      $this->isTranslating = TRUE;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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 2
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
RadioactivityReferenceWidget::$isTranslating protected property Indicates whether the current widget instance is in translation.
RadioactivityReferenceWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
RadioactivityReferenceWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
RadioactivityReferenceWidget::initIsTranslating protected function Initializes the translation form state.
RadioactivityReferenceWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState