You are here

Home » API reference » Entity connect 8.2 » EntityconnectSubmit.php

class EntityconnectSubmit in Entity connect 8.2

Provides a custom form submit button for entityconnect.

Submit buttons are processed the same as regular buttons, except they trigger the form's submit handler.

Properties:

  • #submit: Specifies an alternate callback for form submission when the submit button is pressed. Use '::methodName' format or an array containing the object and method name (for example, [ $this, 'methodName'] ).
  • #value: The text to be shown on the button.
  • #key: 'all' | The delta of the item within a multi-item field.
  • #field: The field name.
  • #entity_type_target: The target entity type.
  • #acceptable_types: List of acceptable target bundles.
  • #add_child: Boolean - Whether or not an entity is being added.

Usage Example:

$form['actions']['submit'] = array(
  '#type' => 'entityconnect_submit,
  ',
);

Plugin annotation

@FormElement("entityconnect_submit");

Hierarchy

Expanded class hierarchy of EntityconnectSubmit

See also

\Drupal\Core\Render\Element\Submit

2 #type uses of EntityconnectSubmit
EntityconnectWidgetProcessor::attachAddButton in src/EntityconnectWidgetProcessor.php
Attach the Add button.
EntityconnectWidgetProcessor::attachEditButton in src/EntityconnectWidgetProcessor.php
Attach the edit button.

File

src/Element/EntityconnectSubmit.php, line 40

Namespace

Drupal\entityconnect\Element
View source 
class EntityconnectSubmit extends Submit {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#key' => '',
      '#field' => '',
      '#entity_type_target' => 'node',
      '#acceptable_types' => [],
      '#add_child' => FALSE,
      '#validate' => [
        [
          $class,
          'validateSubmit',
        ],
      ],
      '#submit' => [
        [
          $class,
          'addEditButtonSubmit',
        ],
      ],
      '#weight' => 1,
      '#limit_validation_errors' => [],
    ] + parent::getInfo();
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderButton($element) {
    $element = parent::preRenderButton($element);

    // Attach entityconnect assets.
    $element['#attached']['library'][] = 'entityconnect/entityconnect';

    // Support Clientside Validation.
    $element['#attributes']['class'][] = 'cancel';
    if (empty($element['#attributes']['title'])) {
      $element['#attributes']['title'] = $element['#add_child'] ? t('Add') : t('Edit');
    }
    return $element;
  }

  /**
   * Form #validate callback for the entityconnect_submit element.
   *
   * Used to bypass validation of the parent form.
   *
   * @param array $form
   *   The parent form element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current form state.
   */
  public static function validateSubmit(array $form, FormStateInterface $form_state) {

    // Ignore all validation.
    // @todo: Probably should validate the fields that were entered.
  }

  /**
   * Button #submit callback: Call when an entity is to be added or edited.
   *
   * We cache the current state and form
   * and redirect to the add or edit page with an append build_cached_id.
   *
   * @param array $form
   *   Buttons will be added to this form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public static function addEditButtonSubmit(array $form, FormStateInterface $form_state) {
    $cacheId = "entityconnect-" . $form['#build_id'];
    $triggeringElement = $form_state
      ->getTriggeringElement();
    $field = $triggeringElement['#field'];
    $key = $triggeringElement['#key'];
    $entityType = $triggeringElement['#entity_type_target'];
    $acceptableTypes = isset($triggeringElement['#acceptable_types']) ? $triggeringElement['#acceptable_types'] : NULL;

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    $source_entity = $form_state
      ->getFormObject()
      ->getEntity();
    $fieldInfo = FieldStorageConfig::loadByName($source_entity
      ->getEntityTypeId(), $field);

    // Get the list of all parents element for the clicked button.
    $parents = isset($triggeringElement['#parents']) ? $triggeringElement['#parents'] : NULL;
    $keyExists = NULL;

    // The button is nested at the same level as the reference field.
    // This gets the target_id wherever button is nested via parents.
    $fieldContainer = EntityconnectNestedArray::getValue($form_state
      ->getUserInput(), $parents, $keyExists);

    // Initialize target_id.
    $target_id = [];

    // Get the target id from the reference field container.
    if ($keyExists) {
      if (is_array($fieldContainer)) {
        foreach ($fieldContainer as $key1 => $value) {
          if (is_array($value)) {
            foreach ($value as $key2 => $value2) {
              if (!is_null($value2)) {
                $target_id[$key2] = $value2;
              }
            }
          }
          elseif (is_numeric($key1)) {
            $target_id[] = $value;
          }
          elseif ($key1 === 'target_id') {
            $target_id = $value;
            break;
          }
        }
      }
      else {
        $target_id = $fieldContainer;
      }
    }

    // Autocomplete tags style target.
    if (is_string($target_id) && !is_numeric($target_id)) {
      $target_id = explode(',', $target_id);
    }
    if (is_array($target_id)) {
      $target_id = array_filter($target_id);
      if (count($target_id) == 1) {
        $target_id = array_shift($target_id);
      }
    }

    // If no entity has been chosen to edit, redirect to the original node.
    if (!$triggeringElement['#add_child'] && (!$target_id || $target_id == '_none')) {
      \Drupal::messenger()
        ->addError(t('You must select at least one entity to update.'));
      $form_state
        ->setRedirectUrl(Url::fromRoute('<current>'));
      return;
    }

    // Setup the data of the current form for caching.
    $current_route = \Drupal::routeMatch();
    $data = [
      'form' => $form,
      'form_state' => $form_state,
      'dest_route_name' => $current_route
        ->getRouteName(),
      'dest_route_params' => $current_route
        ->getRawParameters()
        ->all(),
      'params' => \Drupal::request()->query
        ->all(),
      'field' => $field,
      'field_info' => $fieldInfo,
      'key' => $key,
      'add_child' => $triggeringElement['#add_child'],
      'target_id' => $target_id,
      'target_entity_type' => $entityType,
      'acceptable_types' => $acceptableTypes,
      'field_container' => $fieldContainer,
      'field_container_key_exists' => $keyExists,
    ];

    // Give other modules the chance to change it.
    \Drupal::moduleHandler()
      ->alter('entityconnect_add_edit_button_submit', $data);

    // Store the form data in the cache.
    $tempStore = \Drupal::getContainer()
      ->get('entityconnect.cache');
    $tempStore
      ->set($cacheId, $data);

    // Replace the destination with the add/edit form of the connecting entity.
    \Drupal::request()->query
      ->remove('destination');
    if ($data['add_child']) {
      $form_state
        ->setRedirect('entityconnect.add', [
        'cache_id' => $cacheId,
      ]);
    }
    else {
      if ($data['target_id']) {
        $form_state
          ->setRedirect('entityconnect.edit', [
          'cache_id' => $cacheId,
        ]);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Button::processButton public static function Processes a form button element.
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
EntityconnectSubmit::addEditButtonSubmit public static function Button #submit callback: Call when an entity is to be added or edited.
EntityconnectSubmit::getInfo public function Returns the element properties for this element. Overrides Submit::getInfo
EntityconnectSubmit::preRenderButton public static function Prepares a #type 'button' render element for input.html.twig. Overrides Button::preRenderButton
EntityconnectSubmit::validateSubmit public static function Form #validate callback for the entityconnect_submit element.
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.