You are here

Home » API reference » Inline Entity Form 8 » InlineEntityFormSimple.php

class InlineEntityFormSimple in Inline Entity Form 8

Simple inline widget.

Plugin annotation


@FieldWidget(
  id = "inline_entity_form_simple",
  label = @Translation("Inline entity form - Simple"),
  field_types = {
    "entity_reference",
    "entity_reference_revisions",
  },
  multiple_values = false
)

Hierarchy

Expanded class hierarchy of InlineEntityFormSimple

File

src/Plugin/Field/FieldWidget/InlineEntityFormSimple.php, line 27

Namespace

Drupal\inline_entity_form\Plugin\Field\FieldWidget
View source 
class InlineEntityFormSimple extends InlineEntityFormBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Trick inline_entity_form_form_alter() into attaching the handlers,
    // WidgetSubmit will be needed once extractFormValues fills the $form_state.
    $parents = array_merge($element['#field_parents'], [
      $items
        ->getName(),
    ]);
    $ief_id = $this
      ->makeIefId($parents);
    $form_state
      ->set([
      'inline_entity_form',
      $ief_id,
    ], []);
    $element = [
      '#type' => $this
        ->getSetting('collapsible') ? 'details' : 'fieldset',
      '#field_title' => $this->fieldDefinition
        ->getLabel(),
      '#after_build' => [
        [
          get_class($this),
          'removeTranslatabilityClue',
        ],
      ],
    ] + $element;
    if ($element['#type'] == 'details') {

      // If there's user input, keep the details open. Otherwise, use settings.
      $element['#open'] = $form_state
        ->getUserInput() ?: !$this
        ->getSetting('collapsed');
    }
    $item = $items
      ->get($delta);
    if ($item->target_id && !$item->entity) {
      $element['warning']['#markup'] = $this
        ->t('Unable to load the referenced entity.');
      return $element;
    }
    $entity = $item->entity;
    $op = $entity ? 'edit' : 'add';
    $langcode = $items
      ->getEntity()
      ->language()
      ->getId();
    $parents = array_merge($element['#field_parents'], [
      $items
        ->getName(),
      $delta,
      'inline_entity_form',
    ]);
    $bundle = $this
      ->getBundle();
    $element['inline_entity_form'] = $this
      ->getInlineEntityForm($op, $bundle, $langcode, $delta, $parents, $entity);
    if ($op == 'edit') {

      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
      if (!$entity
        ->access('update')) {

        // The user isn't allowed to edit the entity, but still needs to see
        // it, to be able to reorder values.
        $element['entity_label'] = [
          '#type' => 'markup',
          '#markup' => $entity
            ->label(),
        ];

        // Hide the inline form. getInlineEntityForm() still needed to be
        // called because otherwise the field re-ordering doesn't work.
        $element['inline_entity_form']['#access'] = FALSE;
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
    $element = parent::formMultipleElements($items, $form, $form_state);

    // If we're using unlimited cardinality we don't display one empty item.
    // Form validation will kick in if left empty which essentially means
    // people won't be able to submit without creating another entity.
    if (!$form_state
      ->isSubmitted() && $element['#cardinality'] == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && $element['#max_delta'] > 0) {
      $max = $element['#max_delta'];
      unset($element[$max]);
      $element['#max_delta'] = $max - 1;
      $items
        ->removeItem($max);

      // Decrement the items count.
      $field_name = $element['#field_name'];
      $parents = $element[0]['#field_parents'];
      $field_state = static::getWidgetState($parents, $field_name, $form_state);
      $field_state['items_count']--;
      static::setWidgetState($parents, $field_name, $form_state, $field_state);
    }

    // Remove add options if the user cannot add new entities.
    if (!$this
      ->canAddNew()) {
      if (isset($element['add_more'])) {
        unset($element['add_more']);
      }
      foreach (Element::children($element) as $delta) {
        if (isset($element[$delta]['inline_entity_form'])) {
          if ($element[$delta]['inline_entity_form']['#op'] == 'add') {
            unset($element[$delta]);
          }
        }
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    if ($this
      ->isDefaultValueWidget($form_state)) {
      $items
        ->filterEmptyItems();
      return;
    }
    $field_name = $this->fieldDefinition
      ->getName();
    $parents = array_merge($form['#parents'], [
      $field_name,
    ]);
    $submitted_values = $form_state
      ->getValue($parents);
    $values = [];
    foreach ($items as $delta => $value) {
      $element = NestedArray::getValue($form, [
        $field_name,
        'widget',
        $delta,
      ]);

      /** @var \Drupal\Core\Entity\EntityInterface $entity */
      $entity = $element['inline_entity_form']['#entity'];
      $weight = isset($submitted_values[$delta]['_weight']) ? $submitted_values[$delta]['_weight'] : 0;
      $values[$weight] = [
        'entity' => $entity,
      ];
    }

    // Sort items base on weights.
    ksort($values);
    $values = array_values($values);

    // Let the widget massage the submitted values.
    $values = $this
      ->massageFormValues($values, $form, $form_state);

    // Assign the values and remove the empty ones.
    $items
      ->setValue($values);
    $items
      ->filterEmptyItems();

    // Populate the IEF form state with $items so that WidgetSubmit can
    // perform the necessary saves.
    $ief_id = $this
      ->makeIefId($parents);
    $widget_state = [
      'instance' => $this->fieldDefinition,
      'delete' => [],
      'entities' => [],
    ];
    foreach ($items as $delta => $value) {
      TranslationHelper::updateEntityLangcode($value->entity, $form_state);
      $widget_state['entities'][$delta] = [
        'entity' => $value->entity,
        'needs_save' => TRUE,
      ];
    }
    $form_state
      ->set([
      'inline_entity_form',
      $ief_id,
    ], $widget_state);

    // Put delta mapping in $form_state, so that flagErrors() can use it.
    $field_name = $this->fieldDefinition
      ->getName();
    $field_state = WidgetBase::getWidgetState($form['#parents'], $field_name, $form_state);
    foreach ($items as $delta => $item) {
      $field_state['original_deltas'][$delta] = isset($item->_original_delta) ? $item->_original_delta : $delta;
      unset($item->_original_delta, $item->weight);
    }
    WidgetBase::setWidgetState($form['#parents'], $field_name, $form_state, $field_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $handler_settings = $field_definition
      ->getSettings()['handler_settings'];
    $target_entity_type_id = $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    $target_entity_type = \Drupal::entityTypeManager()
      ->getDefinition($target_entity_type_id);

    // The target entity type doesn't use bundles, no need to validate them.
    if (!$target_entity_type
      ->getKey('bundle')) {
      return TRUE;
    }
    if (empty($handler_settings['target_bundles'])) {
      return FALSE;
    }
    if (count($handler_settings['target_bundles']) != 1) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Gets the bundle for the inline entity.
   *
   * @return string|null
   *   The bundle, or NULL if not known.
   */
  protected function getBundle() {
    if (!empty($this
      ->getFieldSetting('handler_settings')['target_bundles'])) {
      return reset($this
        ->getFieldSetting('handler_settings')['target_bundles']);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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.
InlineEntityFormBase::$entityDisplayRepository protected property The entity display repository.
InlineEntityFormBase::$entityTypeBundleInfo protected property The entity type bundle info.
InlineEntityFormBase::$entityTypeManager protected property The entity type manager.
InlineEntityFormBase::$iefId protected property The inline entity form id.
InlineEntityFormBase::$inlineFormHandler protected property The inline entity from handler.
InlineEntityFormBase::addIefSubmitCallbacks public static function Adds submit callbacks to the inline entity form.
InlineEntityFormBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
InlineEntityFormBase::canAddNew protected function Determines if the current user can add any new entities.
InlineEntityFormBase::canBuildForm protected function Checks whether we can build entity form at all.
InlineEntityFormBase::create public static function Creates an instance of the plugin. Overrides WidgetBase::create 1
InlineEntityFormBase::createInlineFormHandler protected function Creates an instance of the inline form handler for the current entity type.
InlineEntityFormBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
InlineEntityFormBase::form public function Creates a form element for a field. Overrides WidgetBase::form
InlineEntityFormBase::getAccessHandler protected function Gets the access handler for the target entity type.
InlineEntityFormBase::getCreateBundles protected function Gets the bundles for which the current user has create access.
InlineEntityFormBase::getEntityFormMode protected function Gets the entity form mode instance for this widget.
InlineEntityFormBase::getEntityTypeLabels protected function Gets the entity type managed by this handler.
InlineEntityFormBase::getIefId protected function Gets inline entity form ID.
InlineEntityFormBase::getInlineEntityForm protected function Gets inline entity form element.
InlineEntityFormBase::getTargetBundles protected function Gets the target bundles for the current field.
InlineEntityFormBase::isTranslating protected function Determines whether there's a translation in progress.
InlineEntityFormBase::makeIefId protected function Makes an IEF ID from array parents.
InlineEntityFormBase::prepareFormState protected function Prepares the form state for the current widget.
InlineEntityFormBase::removeTranslatabilityClue public static function After-build callback for removing the translatability clue from the widget.
InlineEntityFormBase::setIefId protected function Sets inline entity form ID.
InlineEntityFormBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm 1
InlineEntityFormBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary 1
InlineEntityFormBase::submitSaveEntity public static function Marks created/edited entity with "needs save" flag.
InlineEntityFormBase::__construct public function Constructs an InlineEntityFormBase object. Overrides WidgetBase::__construct 1
InlineEntityFormBase::__sleep public function Overrides DependencySerializationTrait::__sleep
InlineEntityFormBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
InlineEntityFormSimple::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
InlineEntityFormSimple::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
InlineEntityFormSimple::formMultipleElements protected function Special handling to create form elements for multiple values. Overrides WidgetBase::formMultipleElements
InlineEntityFormSimple::getBundle protected function Gets the bundle for the inline entity.
InlineEntityFormSimple::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 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.
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::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
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.
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::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
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::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::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState