You are here

Home » API reference » TMGMT Extension Suite 8.3 » BaseTmgmtActionApproveForm.php

abstract class BaseTmgmtActionApproveForm in TMGMT Extension Suite 8.3

Same name and namespace in other branches
  1. 8 src/Form/BaseTmgmtActionApproveForm.php \Drupal\tmgmt_extension_suit\Form\BaseTmgmtActionApproveForm
  2. 8.2 src/Form/BaseTmgmtActionApproveForm.php \Drupal\tmgmt_extension_suit\Form\BaseTmgmtActionApproveForm

Provides a confirmation form for sending multiple content entities.

Hierarchy

Expanded class hierarchy of BaseTmgmtActionApproveForm

File

src/Form/BaseTmgmtActionApproveForm.php, line 19

Namespace

Drupal\tmgmt_extension_suit\Form
View source 
abstract class BaseTmgmtActionApproveForm extends ConfirmFormBase {

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

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The upload queue.
   *
   * @var \Drupal\Core\Queue\QueueInterface
   */
  protected $queue;

  /**
   * The array of entities to send.
   *
   * @var string[]
   */
  protected $entityIds = [];

  /**
   * Temp storage name we are saving entity_ids to.
   *
   * @var string
   */
  protected $tempStorageName = 'tmgmt_extension_suit_tmgmt_job_operations_download';

  /**
   * Constructs a new UserMultipleCancelConfirm.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   Temp storage factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   Language manager service.
   * @param \Drupal\Core\Queue\QueueInterface $queue
   *   The upload queue.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   Immutable config instance that contains settings.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, QueueInterface $queue, ImmutableConfig $config) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->entityTypeManager = $entity_type_manager;
    $this->languageManager = $language_manager;
    $this->queue = $queue;
    $this->config = $config;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'), $container
      ->get('entity_type.manager'), $container
      ->get('language_manager'), $container
      ->get('queue')
      ->get('tmgmt_extension_suit_upload'), $container
      ->get('config.factory')
      ->get('tmgmt_extension_suit.settings'));
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('system.admin_content');
  }

  /**
   * Returns storage name.
   *
   * @return string
   *   Storage name.
   */
  public function getTempStorageName() {
    return $this->tempStorageName;
  }

  /**
   * Returns saved entities.
   *
   * @param array $entity_ids
   *   Entity ids.
   *
   * @return array|\Drupal\Core\Entity\EntityInterface[]
   *   Returns array of loaded entities.
   */
  protected function getEntities(array $entity_ids) {
    $entities = [];
    $number_of_entity_types = count(array_unique(array_values($entity_ids)));
    if ($number_of_entity_types == 1) {
      $entity_type = array_values($entity_ids)[0];
      $ids = array_keys($entity_ids);
      $entities = $this->entityTypeManager
        ->getStorage($entity_type)
        ->loadMultiple($ids);
    }
    else {
      foreach ($entity_ids as $id => $ent_type) {
        $entities[] = $this->entityTypeManager
          ->getStorage($ent_type)
          ->load($id);
      }
    }
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $temp_storage_name = $this
      ->getTempStorageName();

    // Retrieve the content to be sent from the temp store.
    $this->entityIds = $this->tempStoreFactory
      ->get($temp_storage_name)
      ->get($this
      ->currentUser()
      ->id());
    if (!$this->entityIds) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }
    $entities = $this
      ->getEntities($this->entityIds);
    $items = [];
    foreach ($entities as $entity) {
      $items[$entity
        ->id()] = $entity
        ->label();
    }
    $form['items'] = [
      '#theme' => 'item_list',
      '#title' => $this
        ->t('Entities to process'),
      '#items' => $items,
    ];
    return ConfirmFormBase::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $current_user_id = $this
      ->currentUser()
      ->id();
    $temp_storage_name = $this
      ->getTempStorageName();

    // Clear out the accounts from the temp store.
    $this->tempStoreFactory
      ->get($temp_storage_name)
      ->delete($current_user_id);
    if (!$form_state
      ->getValue('confirm')) {
      return;
    }

    // @TODO: change this when we add the support for queues.
    $is_batch = TRUE;
    $operations = [];
    foreach ($this->entityIds as $id => $entity_type) {

      // Make sure all submissions exists.
      $item_data = [
        'entity_type' => $entity_type,
        'entity_id' => $id,
      ];
      if ($is_batch) {
        $operations[] = [
          [
            get_class($this),
            'processBatch',
          ],
          [
            $item_data,
          ],
        ];
      }
      else {
        $this->queue
          ->createItem($item_data);
      }
    }
    if ($is_batch && $operations) {
      $batch = [
        'title' => $this
          ->getConfirmText(),
        'operations' => $operations,
        'finished' => [
          get_class($this),
          'finishBatch',
        ],
      ];
      batch_set($batch);
    }
    else {
      $form_state
        ->setRedirect('system.admin_content');
    }
  }

  /**
   * Processes the sending batch.
   *
   * @param array $data
   *   Keyed array of data to send.
   * @param array $context
   *   The batch context.
   *
   * @return \Drupal\tmgmt\JobInterface|mixed
   *   Returns TMGMT job on success and FALSE otherwise.
   */
  public static function processBatch(array $data, array &$context) {
    if (!isset($context['results']['errors'])) {
      $context['results']['errors'] = [];
      $context['results']['count'] = 0;
    }
    $entity_type_id = $data['entity_type'];
    $entity_id = $data['entity_id'];
    $job = \Drupal::entityTypeManager()
      ->getStorage($entity_type_id)
      ->loadMultiple([
      $entity_id,
    ]);
    $job = reset($job);
    if (!$job) {
      $context['results']['errors'][] = t('Entity @entity_type:@entity_id not found', [
        '@entity_type' => $entity_type_id,
        '@entity_id' => $entity_id,
      ]);
    }
    return $job;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BaseTmgmtActionApproveForm::$entityIds protected property The array of entities to send.
BaseTmgmtActionApproveForm::$entityTypeManager protected property The entity type manager.
BaseTmgmtActionApproveForm::$languageManager protected property The language manager.
BaseTmgmtActionApproveForm::$queue protected property The upload queue.
BaseTmgmtActionApproveForm::$tempStorageName protected property Temp storage name we are saving entity_ids to. 4
BaseTmgmtActionApproveForm::$tempStoreFactory protected property The temp store factory.
BaseTmgmtActionApproveForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
BaseTmgmtActionApproveForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
BaseTmgmtActionApproveForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
BaseTmgmtActionApproveForm::getEntities protected function Returns saved entities.
BaseTmgmtActionApproveForm::getTempStorageName public function Returns storage name.
BaseTmgmtActionApproveForm::processBatch public static function Processes the sending batch. 5
BaseTmgmtActionApproveForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm 1
BaseTmgmtActionApproveForm::__construct public function Constructs a new UserMultipleCancelConfirm. 1
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
ConfirmFormInterface::getQuestion public function Returns the question to ask the user. 33
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
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.