You are here

Home » API reference » Views Bulk Edit 8.2 » BulkEditForm.php

class BulkEditForm in Views Bulk Edit 8.2

Same name and namespace in other branches
  1. 8 src/Form/BulkEditForm.php \Drupal\views_bulk_edit\Form\BulkEditForm

The bulk edit form.

Hierarchy

Expanded class hierarchy of BulkEditForm

1 string reference to 'BulkEditForm'
views_bulk_edit.routing.yml in ./views_bulk_edit.routing.yml
views_bulk_edit.routing.yml

File

src/Form/BulkEditForm.php, line 20

Namespace

Drupal\views_bulk_edit\Form
View source 
class BulkEditForm extends ConfirmFormBase {
  use BulkEditFormTrait;

  /**
   * Private temp store factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStore;

  /**
   * Count of entities to modify.
   *
   * @var int
   */
  protected $count = 0;

  /**
   * The bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * BulkEditForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   Temp store service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundleInfo
   *   Bundle info object.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entityFieldManager
   *   The entity field manager service.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository, PrivateTempStoreFactory $temp_store_factory, TimeInterface $time, AccountInterface $currentUser, EntityTypeBundleInfoInterface $bundleInfo, EntityFieldManagerInterface $entityFieldManager) {
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
    $this->tempStore = $temp_store_factory
      ->get('entity_edit_multiple');
    $this->time = $time;
    $this->currentUser = $currentUser;
    $this->bundleInfo = $bundleInfo;
    $this->entityFieldManager = $entityFieldManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('entity.repository'), $container
      ->get('tempstore.private'), $container
      ->get('datetime.time'), $container
      ->get('current_user'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('entity_field.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $bundle_data = [];
    foreach ($this
      ->getBulkEditEntityData() as $entity_type_id => $bundle_entities) {
      $bundle_info = $this->bundleInfo
        ->getBundleInfo($entity_type_id);
      foreach ($bundle_entities as $bundle => $entities) {
        $this->count += count($entities);
        $bundle_data[$entity_type_id][$bundle] = $bundle_info[$bundle]['label'];
      }
    }
    $form = $this
      ->buildBundleForms($form, $form_state, $bundle_data);
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->submitConfigurationForm($form, $form_state);
    foreach ($this
      ->getBulkEditEntityData() as $entity_type_id => $bundle_entities) {
      foreach ($bundle_entities as $bundle => $entities) {
        $entities = $this->entityTypeManager
          ->getStorage($entity_type_id)
          ->loadMultiple(array_keys($entities));
        foreach ($entities as $entity) {
          $this
            ->execute($entity);
        }
      }
    }
    $this
      ->clearBulkEditEntityData();
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural($this->count, 'Are you sure you want to edit this entity?', 'Are you sure you want to edit these entities?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('<front>');
  }

  /**
   * Gets the saved entity data.
   *
   * @return array
   *   An array of saved entity data.
   */
  protected function getBulkEditEntityData() {
    return $this->tempStore
      ->get($this->currentUser
      ->id()) ?: [];
  }

  /**
   * Clear the saved entities once we've finished with them.
   */
  protected function clearBulkEditEntityData() {
    $this->tempStore
      ->delete($this->currentUser
      ->id());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BulkEditForm::$bundleInfo protected property The bundle info service.
BulkEditForm::$count protected property Count of entities to modify.
BulkEditForm::$tempStore protected property Private temp store factory.
BulkEditForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
BulkEditForm::clearBulkEditEntityData protected function Clear the saved entities once we've finished with them.
BulkEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
BulkEditForm::getBulkEditEntityData protected function Gets the saved entity data.
BulkEditForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
BulkEditForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BulkEditForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
BulkEditForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
BulkEditForm::__construct public function BulkEditForm constructor.
BulkEditFormTrait::$currentUser protected property The current user.
BulkEditFormTrait::$entityFieldManager protected property The entity field manager service.
BulkEditFormTrait::$entityRepository protected property The entity repository service.
BulkEditFormTrait::$entityTypeManager protected property The entity type manager.
BulkEditFormTrait::$time protected property The time service.
BulkEditFormTrait::buildBundleForms public function Builds the bundle forms.
BulkEditFormTrait::execute public function
BulkEditFormTrait::filterOnKey protected function Provides same functionality as ARRAY_FILTER_USE_KEY for PHP 5.5.
BulkEditFormTrait::findFormElement protected function Finds the deepest most form element and returns it.
BulkEditFormTrait::getBundleEntity protected function Returns the bundle entity of the entity, or NULL if there is none.
BulkEditFormTrait::getBundleForm protected function Gets the form for this entity display.
BulkEditFormTrait::getNewRevisionDefault protected function Should new revisions be created by default?
BulkEditFormTrait::getRevisionForm protected function Builds the revision form.
BulkEditFormTrait::getSelectorForm protected function Builds the selector form.
BulkEditFormTrait::submitConfigurationForm public function Save modified entity field values to action configuration.
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 20
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.