You are here

Home » API reference » Flexiform 8 » SubmitButtonLabel.php

class SubmitButtonLabel in Flexiform 8

FormEnhancer for altering the labels of submit buttons.

@FormEnhancer( id = "submit_button_label", label = @Translation("Button Labels"), );

Hierarchy

Expanded class hierarchy of SubmitButtonLabel

File

src/Plugin/FormEnhancer/SubmitButtonLabel.php, line 19

Namespace

Drupal\flexiform\Plugin\FormEnhancer
View source 
class SubmitButtonLabel extends ConfigurableFormEnhancerBase {
  use SubmitButtonFormEnhancerTrait;
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  protected $supportedEvents = [
    'process_form',
  ];

  /**
   * {@inheritdoc}
   */
  public function configurationForm(array $form, FormStateInterface $form_state) {
    foreach ($this
      ->locateSubmitButtons() as $path => $label) {
      $original_path = $path;
      $path = str_replace('][', '::', $path);
      $form['label'][$path] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('@label Button Text', [
          '@label' => $label,
        ]),
        '#description' => 'Array Parents: ' . $original_path,
        '#default_value' => !empty($this->configuration[$path]) ? $this->configuration[$path] : '',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function configurationFormSubmit(array $form, FormStateInterface $form_state) {
    $this->configuration = $form_state
      ->getValue($form['#parents']);
  }

  /**
   * Process Form Enhancer.
   */
  public function processForm($element, FormStateInterface $form_state, $form) {
    foreach (array_filter($this->configuration) as $key => $label) {
      $array_parents = explode('::', $key);
      $button = [];
      $button = NestedArray::getValue($element, $array_parents, $exists);
      if ($exists) {
        $button['#value'] = $label;
        NestedArray::setValue($element, $array_parents, $button);
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableFormEnhancerBase::applies public function Whether this enhancer applies to a particular event. Overrides FormEnhancerBase::applies 1
ConfigurableFormEnhancerBase::configurationFormValidate public function The configuration form validation callback. Overrides ConfigurableFormEnhancerInterface::configurationFormValidate
ConfigurableFormEnhancerBase::getConfiguration public function Get the configuration. Overrides ConfigurableFormEnhancerInterface::getConfiguration
ConfigurableFormEnhancerBase::setConfiguration public function Set the configuration for the enhancer. Overrides ConfigurableFormEnhancerInterface::setConfiguration
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
FormEnhancerBase::getFormDisplay protected function Get the form display.
FormEnhancerBase::setFormDisplay public function Set the form display object. Overrides FormEnhancerInterface::setFormDisplay
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
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.
SubmitButtonFormEnhancerTrait::$formDisplay protected property Form display.
SubmitButtonFormEnhancerTrait::locateSubmitButtons protected function Locate any submit buttons in the form.
SubmitButtonFormEnhancerTrait::locateSubmitButtonsR private function Locate the submit buttons recursively.
SubmitButtonLabel::$supportedEvents protected property An array of supported events. Overrides FormEnhancerBase::$supportedEvents
SubmitButtonLabel::configurationForm public function The configuration form. Overrides ConfigurableFormEnhancerInterface::configurationForm
SubmitButtonLabel::configurationFormSubmit public function The configuration form submit callback. Overrides ConfigurableFormEnhancerBase::configurationFormSubmit
SubmitButtonLabel::processForm public function Process Form Enhancer.