class ViewsBulkOperationsController in Views Bulk Operations (VBO) 8.2

Defines VBO controller class.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\views_bulk_operations\Controller\ViewsBulkOperationsController implements ContainerInjectionInterface uses ViewsBulkOperationsFormTrait

File

src/Controller/ViewsBulkOperationsController.php, line 19

Namespace

Drupal\views_bulk_operations\Controller

class ViewsBulkOperationsController extends ControllerBase implements ContainerInjectionInterface {
  use ViewsBulkOperationsFormTrait;

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

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

  /**
   * Constructs a new controller object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $tempStoreFactory
   *   Private temporary storage factory.
   * @param \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface $actionProcessor
   *   Views Bulk Operations action processor.
   */
  public function __construct(PrivateTempStoreFactory $tempStoreFactory, ViewsBulkOperationsActionProcessorInterface $actionProcessor) {
    $this->tempStoreFactory = $tempStoreFactory;
    $this->actionProcessor = $actionProcessor;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'), $container
      ->get('views_bulk_operations.processor'));
  }

  /**
   * The actual page callback.
   *
   * @param string $view_id
   *   The current view ID.
   * @param string $display_id
   *   The display ID of the current view.
   */
  public function execute($view_id, $display_id) {
    $view_data = $this
      ->getTempstoreData($view_id, $display_id);
    if (empty($view_data)) {
      throw new NotFoundHttpException();
    }
    $this
      ->deleteTempstoreData();
    $this->actionProcessor
      ->executeProcessing($view_data);
    if ($view_data['batch']) {
      return batch_process($view_data['redirect_url']);
    }
    else {
      return new RedirectResponse($view_data['redirect_url']
        ->setAbsolute()
        ->toString());
    }
  }

  /**
   * AJAX callback to update selection (multipage).
   *
   * @param string $view_id
   *   The current view ID.
   * @param string $display_id
   *   The display ID of the current view.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function updateSelection($view_id, $display_id, Request $request) {
    $view_data = $this
      ->getTempstoreData($view_id, $display_id);
    if (empty($view_data)) {
      throw new NotFoundHttpException();
    }
    $list = $request->request
      ->get('list');
    $op = $request->request
      ->get('op', 'add');
    $change = 0;
    if ($op === 'add') {
      foreach ($list as $bulkFormKey => $label) {
        if (!isset($view_data['list'][$bulkFormKey])) {
          $view_data['list'][$bulkFormKey] = $this
            ->getListItem($bulkFormKey, $label);
          $change++;
        }
      }
    }
    elseif ($op === 'remove') {
      foreach ($list as $bulkFormKey => $label) {
        if (isset($view_data['list'][$bulkFormKey])) {
          unset($view_data['list'][$bulkFormKey]);
          $change--;
        }
      }
    }
    $this
      ->setTempstoreData($view_data);
    $response = new AjaxResponse();
    $response
      ->setData([
      'change' => $change,
    ]);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
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.
ViewsBulkOperationsController::$actionProcessor	protected	property	Views Bulk Operations action processor.
ViewsBulkOperationsController::$tempStoreFactory	protected	property	User private temporary storage factory.
ViewsBulkOperationsController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ViewsBulkOperationsController::execute	public	function	The actual page callback.
ViewsBulkOperationsController::updateSelection	public	function	AJAX callback to update selection (multipage).
ViewsBulkOperationsController::__construct	public	function	Constructs a new controller object.
ViewsBulkOperationsFormTrait::$tempStoreName	protected	property	The tempstore name.
ViewsBulkOperationsFormTrait::$viewTempstore	protected	property	The tempstore object associated with the current view.
ViewsBulkOperationsFormTrait::addCancelButton	protected	function	Add a cancel button into a VBO form.
ViewsBulkOperationsFormTrait::calculateEntityBulkFormKey	public static	function	Calculates the bulk form key for an entity.
ViewsBulkOperationsFormTrait::cancelForm	public	function	Submit callback to cancel an action and return to the view.
ViewsBulkOperationsFormTrait::deleteTempstoreData	protected	function	Deletes the current view user tempstore data.
ViewsBulkOperationsFormTrait::getFormData	protected	function	Helper function to prepare data needed for proper form display.
ViewsBulkOperationsFormTrait::getListItem	protected	function	Get an entity list item from a bulk form key and label.
ViewsBulkOperationsFormTrait::getTempstore	protected	function	Initialize the current view tempstore object.
ViewsBulkOperationsFormTrait::getTempstoreData	protected	function	Gets the current view user tempstore data.
ViewsBulkOperationsFormTrait::setTempstoreData	protected	function	Sets the current view user tempstore data.