class ConfigureAction in Views Bulk Operations (VBO) 8

Action configuration form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\views_bulk_operations\Form\ConfigureAction uses ViewsBulkOperationsFormTrait

1 string reference to 'ConfigureAction'

views_bulk_operations.routing.yml in ./views_bulk_operations.routing.yml

views_bulk_operations.routing.yml

File

src/Form/ConfigureAction.php, line 15

Namespace

Drupal\views_bulk_operations\Form

class ConfigureAction extends FormBase {
  use ViewsBulkOperationsFormTrait;

  /**
   * User private temporary storage factory.
   *
   * @var \Drupal\user\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * Views Bulk Operations action manager.
   *
   * @var \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionManager
   */
  protected $actionManager;

  /**
   * Views Bulk Operations action processor.
   *
   * @var \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface
   */
  protected $actionProcessor;

  /**
   * Constructor.
   *
   * @param \Drupal\user\PrivateTempStoreFactory $tempStoreFactory
   *   User private temporary storage factory.
   * @param \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionManager $actionManager
   *   Extended action manager object.
   * @param \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface $actionProcessor
   *   Views Bulk Operations action processor.
   */
  public function __construct(PrivateTempStoreFactory $tempStoreFactory, ViewsBulkOperationsActionManager $actionManager, ViewsBulkOperationsActionProcessorInterface $actionProcessor) {
    $this->tempStoreFactory = $tempStoreFactory;
    $this->actionManager = $actionManager;
    $this->actionProcessor = $actionProcessor;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('user.private_tempstore'), $container
      ->get('plugin.manager.views_bulk_operations_action'), $container
      ->get('views_bulk_operations.processor'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'views_bulk_operations_configure_action';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $view_id = NULL, $display_id = NULL) {
    $form_data = $this
      ->getFormData($view_id, $display_id);

    // TODO: display an error msg, redirect back.
    if (!isset($form_data['action_id'])) {
      return;
    }
    $form['#title'] = $this
      ->t('Configure "%action" action applied to the selection', [
      '%action' => $form_data['action_label'],
    ]);
    $selection = [];
    if (!empty($form_data['entity_labels'])) {
      $form['list'] = [
        '#theme' => 'item_list',
        '#items' => $form_data['entity_labels'],
      ];
    }
    else {
      $form['list'] = [
        '#type' => 'item',
        '#markup' => $this
          ->t('All view results'),
      ];
    }
    $form['list']['#title'] = $this
      ->t('Selected @count entities:', [
      '@count' => $form_data['selected_count'],
    ]);

    // :D Make sure the submit button is at the bottom of the form
    // and is editale from the action buildConfigurationForm method.
    $form['actions']['#weight'] = 666;
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Apply'),
      '#submit' => [
        [
          $this,
          'submitForm',
        ],
      ],
    ];
    $action = $this->actionManager
      ->createInstance($form_data['action_id']);
    if (method_exists($action, 'setContext')) {
      $action
        ->setContext($form_data);
    }
    $form = $action
      ->buildConfigurationForm($form, $form_state);
    $storage = $form_state
      ->getStorage();
    $storage['views_bulk_operations'] = $form_data;
    $form_state
      ->setStorage($storage);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $storage = $form_state
      ->getStorage();
    $form_data = $storage['views_bulk_operations'];
    $action = $this->actionManager
      ->createInstance($form_data['action_id']);
    if (method_exists($action, 'validateConfigurationForm')) {
      $action
        ->validateConfigurationForm($form, $form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $storage = $form_state
      ->getStorage();
    $form_data = $storage['views_bulk_operations'];
    $action = $this->actionManager
      ->createInstance($form_data['action_id']);
    if (method_exists($action, 'submitConfigurationForm')) {
      $action
        ->submitConfigurationForm($form, $form_state);
      $form_data['configuration'] = $action
        ->getConfiguration();
    }
    else {
      $form_state
        ->cleanValues();
      $form_data['configuration'] = $form_state
        ->getValues();
    }
    $definition = $this->actionManager
      ->getDefinition($form_data['action_id']);
    if (!empty($definition['confirm_form_route_name'])) {

      // Update tempStore data.
      $this->tempStoreFactory
        ->get($form_data['tempstore_name'])
        ->set($this
        ->currentUser()
        ->id(), $form_data);

      // Go to the confirm route.
      $form_state
        ->setRedirect($definition['confirm_form_route_name'], [
        'view_id' => $form_data['view_id'],
        'display_id' => $form_data['display_id'],
      ]);
    }
    else {
      $this->tempStoreFactory
        ->get($form_data['tempstore_name'])
        ->delete($this
        ->currentUser()
        ->id());
      $this->actionProcessor
        ->executeProcessing($form_data);
      $form_state
        ->setRedirectUrl($form_data['redirect_url']);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigureAction::$actionManager	protected	property	Views Bulk Operations action manager.
ConfigureAction::$actionProcessor	protected	property	Views Bulk Operations action processor.
ConfigureAction::$tempStoreFactory	protected	property	User private temporary storage factory.
ConfigureAction::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ConfigureAction::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ConfigureAction::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigureAction::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ConfigureAction::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ConfigureAction::__construct	public	function	Constructor.
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
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.
ViewsBulkOperationsFormTrait::getFormData	protected	function	Helper function to prepare data needed for proper form display.