class CancelTmgmtActionApproveForm in TMGMT Extension Suite 8

Provides a confirmation form for sending multiple content entities.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\tmgmt_extension_suit\Form\BaseTmgmtActionApproveForm
      • class \Drupal\tmgmt_extension_suit\Form\CancelTmgmtActionApproveForm

1 string reference to 'CancelTmgmtActionApproveForm'

tmgmt_extension_suit.routing.yml in ./tmgmt_extension_suit.routing.yml

tmgmt_extension_suit.routing.yml

File

src/Form/CancelTmgmtActionApproveForm.php, line 10

Namespace

Drupal\tmgmt_extension_suit\Form

class CancelTmgmtActionApproveForm extends BaseTmgmtActionApproveForm {

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

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Cancel Jobs');
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to cancel these jobs?');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('Canceling can take some time, do not close the browser');
  }

  /**
   * Processes the sending batch.
   *
   * @param array $data
   *   Keyed array of data to send.
   * @param array $context
   *   The batch context.
   */
  public static function processBatch($data, &$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,
      ]);
    }
    elseif (!$job
      ->abortTranslation()) {
      $context['results']['count']++;

      // This is the case when a translator does not support the abort
      // operation.
      // It would make more sense to not display the button for the action,
      // however we do not know if the translator is able to abort a job until
      // we trigger the action.
      foreach ($job
        ->getMessagesSince() as $message) {

        /** @var \Drupal\tmgmt\MessageInterface $message */
        if ($message
          ->getType() == 'debug') {
          continue;
        }
        if ($text = $message
          ->getMessage()) {

          // We want to persist also the type therefore we will set the
          // messages directly and not return them.
          drupal_set_message($text, $message
            ->getType());
        }
      }
    }
    else {
      $context['results']['errors'][] = new FormattableMarkup('Error aborting %name', [
        '%name' => $job
          ->label(),
      ]);
      return;
    }
    $context['message'] = new FormattableMarkup('Processed %name.', [
      '%name' => $job
        ->label(),
    ]);
  }

}

Members

Name	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::$submissionStorage	protected	property	The submission storage.
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
BaseTmgmtActionApproveForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
BaseTmgmtActionApproveForm::getEntities	protected	function
BaseTmgmtActionApproveForm::getTempStorageName	public	function
BaseTmgmtActionApproveForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BaseTmgmtActionApproveForm::__construct	public	function	Constructs a new UserMultipleCancelConfirm.
CancelTmgmtActionApproveForm::$tempStorageName	protected	property	Temp storage name we are saving entity_ids to. Overrides BaseTmgmtActionApproveForm::$tempStorageName
CancelTmgmtActionApproveForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides BaseTmgmtActionApproveForm::getConfirmText
CancelTmgmtActionApproveForm::getDescription	public	function	Returns additional text to display as a description. Overrides BaseTmgmtActionApproveForm::getDescription
CancelTmgmtActionApproveForm::getFormId	public	function	Returns a unique string identifying the form. Overrides BaseTmgmtActionApproveForm::getFormId
CancelTmgmtActionApproveForm::getQuestion	public	function	Returns the question to ask the user. Overrides BaseTmgmtActionApproveForm::getQuestion
CancelTmgmtActionApproveForm::processBatch	public static	function	Processes the sending batch. Overrides BaseTmgmtActionApproveForm::processBatch
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
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.