class SubmitButtonRedirect in Flexiform 8

FormEnhancer for altering the redirects of submit buttons.

@FormEnhancer( id = "submit_button_redirect", label = @Translation("Button Redirects"), );

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\flexiform\FormEnhancer\FormEnhancerBase implements FormEnhancerInterface
    class \Drupal\flexiform\FormEnhancer\ConfigurableFormEnhancerBase implements ConfigurableFormEnhancerInterface
    class \Drupal\flexiform\Plugin\FormEnhancer\SubmitButtonRedirect implements ContainerFactoryPluginInterface uses StringTranslationTrait, SubmitButtonFormEnhancerTrait

Expanded class hierarchy of SubmitButtonRedirect

File

src/Plugin/FormEnhancer/SubmitButtonRedirect.php, line 23

Namespace

Drupal\flexiform\Plugin\FormEnhancer

View source

class SubmitButtonRedirect extends ConfigurableFormEnhancerBase implements ContainerFactoryPluginInterface {
  use SubmitButtonFormEnhancerTrait;
  use StringTranslationTrait;

  /**
   * Token Service.
   *
   * @var \Drupal\flexiform\Utility\Token
   */
  protected $token;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('flexiform.token'));
  }

  /**
   * Construct a new SubmitButtonRedirect object.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Token $token) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->token = $token;
  }

  /**
   * {@inheritdoc}
   */
  public function configurationForm(array $form, FormStateInterface $form_state) {
    foreach ($this
      ->locateSubmitButtons() as $path => $label) {
      $original_path = $path;
      $path = str_replace('][', '::', $path);
      $form['redirect'][$path] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('@label Button Redirect Path', [
          '@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 => $redirect) {
      $array_parents = explode('::', $key);
      $button = NestedArray::getValue($element, $array_parents, $exists);
      if ($exists) {
        if (empty($button['#submit'])) {
          $button['#submit'] = !empty($form['#submit']) ? $form['#submit'] : [];
        }
        $button['#submit'][] = [
          $this,
          'formSubmitRedirect',
        ];
        $button['#submit_redirect'] = $redirect;
        NestedArray::setValue($element, $array_parents, $button);
      }
    }
    return $element;
  }

  /**
   * Redirection submit handler.
   */
  public function formSubmitRedirect($form, FormStateInterface $form_state) {
    $element = $form_state
      ->getTriggeringElement();
    $token_data = $token_options = [];
    $token_info = $this->token
      ->getInfo();
    foreach ($this->formDisplay
      ->getFormEntityManager()
      ->getFormEntities() as $namespace => $form_entity) {
      $entity = $form_entity
        ->getFormEntityContext()
        ->getContextValue();
      if ($namespace == '') {
        $namespace = 'base_entity';
      }
      $token_type = $entity
        ->getEntityType()
        ->get('token_type') ?: (!empty($token_info['types'][$entity
        ->getEntityTypeId()]) ? $entity
        ->getEntityTypeId() : FALSE);
      if ($token_type) {
        $token_data[$namespace] = $form_entity
          ->getFormEntityContext()
          ->getContextValue();
        $token_options['alias'][$namespace] = $token_type;
      }
    }
    if (!empty($element['#submit_redirect'])) {

      // @todo: Support tokens.
      // @todo: Support all the different schemes.
      $path = $element['#submit_redirect'];
      if (!in_array($path[0], [
        '/',
        '?',
        '#',
      ])) {
        $path = '/' . $path;
      }
      $path = $this->token
        ->replace($path, $token_data, $token_options);
      $form_state
        ->setRedirectUrl(Url::fromUserInput($path));
    }
  }

}

Members

Name	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.
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.
SubmitButtonRedirect::$supportedEvents	protected	property	An array of supported events. Overrides FormEnhancerBase::$supportedEvents
SubmitButtonRedirect::$token	protected	property	Token Service.
SubmitButtonRedirect::configurationForm	public	function	The configuration form. Overrides ConfigurableFormEnhancerInterface::configurationForm
SubmitButtonRedirect::configurationFormSubmit	public	function	The configuration form submit callback. Overrides ConfigurableFormEnhancerBase::configurationFormSubmit
SubmitButtonRedirect::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SubmitButtonRedirect::formSubmitRedirect	public	function	Redirection submit handler.
SubmitButtonRedirect::processForm	public	function	Process Form Enhancer.
SubmitButtonRedirect::__construct	public	function	Construct a new SubmitButtonRedirect object. Overrides PluginBase::__construct

You are here

class SubmitButtonRedirect in Flexiform 8

Hierarchy

File

Namespace

Members

API Navigation