You are here

Home » API reference » Commerce Checkout Order Fields 8 » OrderFields.php

class OrderFields in Commerce Checkout Order Fields 8

Exposes the "Checkout" form view mode during checkout.

Plugin annotation


@CommerceCheckoutPane(
  id = "order_fields",
  label = @Translation("Order fields"),
  deriver = "\Drupal\commerce_checkout_order_fields\Plugin\Derivative\OrderFieldsPaneDeriver"
)

Hierarchy

Expanded class hierarchy of OrderFields

File

src/Plugin/Commerce/CheckoutPane/OrderFields.php, line 18

Namespace

Drupal\commerce_checkout_order_fields\Plugin\Commerce\CheckoutPane
View source 
class OrderFields extends CheckoutPaneBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'wrapper_element' => 'container',
      'display_label' => $this->pluginDefinition['display_label'],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationSummary() {
    $summary[] = $this
      ->t('<p>Wrapper element: :type</p>', [
      ':type' => ucfirst($this->configuration['wrapper_element']),
    ]);
    $summary[] = $this
      ->t('<p>Display label: :label</p>', [
      ':label' => ucfirst($this->configuration['display_label']),
    ]);
    return implode('', $summary);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['wrapper_element'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Wrapper element'),
      '#options' => [
        'container' => $this
          ->t('Container'),
        'fieldset' => $this
          ->t('Fieldset'),
      ],
      '#required' => TRUE,
      '#default_value' => $this->configuration['wrapper_element'],
    ];
    $form['display_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Display label'),
      '#description' => $this
        ->t('This is the display used when the wrapper element is a fieldset'),
      '#default_value' => $this->configuration['display_label'],
      '#states' => [
        'visible' => [
          ':input[name="configuration[panes][' . $this
            ->getPluginId() . '][configuration][wrapper_element]"]' => [
            'value' => 'fieldset',
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    if (!$form_state
      ->getErrors()) {
      $values = $form_state
        ->getValue($form['#parents']);
      $this->configuration['wrapper_element'] = $values['wrapper_element'];
      $this->configuration['display_label'] = $values['display_label'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getWrapperElement() {
    return $this->configuration['wrapper_element'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayLabel() {
    return $this->configuration['display_label'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {
    $this
      ->getFormDisplay()
      ->buildForm($this->order, $pane_form, $form_state);
    return $pane_form;
  }

  /**
   * {@inheritdoc}
   */
  public function validatePaneForm(array &$pane_form, FormStateInterface $form_state, array &$complete_form) {
    $this
      ->getFormDisplay()
      ->extractFormValues($this->order, $pane_form, $form_state);
    $this
      ->getFormDisplay()
      ->validateFormValues($this->order, $pane_form, $form_state);
    parent::validatePaneForm($pane_form, $form_state, $complete_form);
  }

  /**
   * {@inheritdoc}
   */
  public function submitPaneForm(array &$pane_form, FormStateInterface $form_state, array &$complete_form) {
    $this
      ->getFormDisplay()
      ->extractFormValues($this->order, $pane_form, $form_state);
    parent::submitPaneForm($pane_form, $form_state, $complete_form);
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneSummary() {
    $build = [];

    // Get the form display to discover which fields should be rendered for the
    // summary. View them using the same display mode ID as the form display
    // mode. If it exists, then Drupal will use it. If not, the default display
    // mode will be used.
    $view_builder = $this->entityTypeManager
      ->getViewBuilder('commerce_order');
    $form_display = $this
      ->getFormDisplay();
    foreach (array_keys($form_display
      ->getComponents()) as $component_name) {
      if (!$this->order
        ->get($component_name)
        ->isEmpty()) {
        $build[$component_name] = $view_builder
          ->viewField($this->order
          ->get($component_name), $this
          ->getDerivativeId());
      }
    }
    return $build;
  }

  /**
   * Gets the form.
   *
   * @return \Drupal\Core\Entity\Display\EntityFormDisplayInterface
   *   The form display.
   */
  private function getFormDisplay() {
    $display = EntityFormDisplay::collectRenderDisplay($this->order, $this
      ->getDerivativeId());
    $display
      ->removeComponent('coupons');
    return $display;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CheckoutPaneBase::$checkoutFlow protected property The parent checkout flow.
CheckoutPaneBase::$entityTypeManager protected property The entity type manager.
CheckoutPaneBase::$order protected property The current order.
CheckoutPaneBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CheckoutPaneBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 7
CheckoutPaneBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPaneBase::getId public function Gets the pane ID. Overrides CheckoutPaneInterface::getId
CheckoutPaneBase::getLabel public function Gets the pane label. Overrides CheckoutPaneInterface::getLabel
CheckoutPaneBase::getStepId public function Gets the pane step ID. Overrides CheckoutPaneInterface::getStepId
CheckoutPaneBase::getWeight public function Gets the pane weight. Overrides CheckoutPaneInterface::getWeight
CheckoutPaneBase::isVisible public function Determines whether the pane is visible. Overrides CheckoutPaneInterface::isVisible 4
CheckoutPaneBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPaneBase::setOrder public function Sets the current order. Overrides CheckoutPaneInterface::setOrder
CheckoutPaneBase::setStepId public function Sets the pane step ID. Overrides CheckoutPaneInterface::setStepId
CheckoutPaneBase::setWeight public function Sets the pane weight. Overrides CheckoutPaneInterface::setWeight
CheckoutPaneBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::__construct public function Constructs a new CheckoutPaneBase object. Overrides PluginBase::__construct 6
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrderFields::buildConfigurationForm public function Form constructor. Overrides CheckoutPaneBase::buildConfigurationForm
OrderFields::buildConfigurationSummary public function Builds a summary of the pane configuration. Overrides CheckoutPaneBase::buildConfigurationSummary
OrderFields::buildPaneForm public function Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
OrderFields::buildPaneSummary public function Builds a summary of the pane values. Overrides CheckoutPaneBase::buildPaneSummary
OrderFields::defaultConfiguration public function Gets default configuration for this plugin. Overrides CheckoutPaneBase::defaultConfiguration
OrderFields::getDisplayLabel public function Gets the pane display label. Overrides CheckoutPaneBase::getDisplayLabel
OrderFields::getFormDisplay private function Gets the form.
OrderFields::getWrapperElement public function Gets the pane wrapper element. Overrides CheckoutPaneBase::getWrapperElement
OrderFields::submitConfigurationForm public function Form submission handler. Overrides CheckoutPaneBase::submitConfigurationForm
OrderFields::submitPaneForm public function Handles the submission of an pane form. Overrides CheckoutPaneBase::submitPaneForm
OrderFields::validatePaneForm public function Validates the pane form. Overrides CheckoutPaneBase::validatePaneForm
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.
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.