class UploadTmgmtActionApproveForm 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\UploadTmgmtActionApproveForm

Expanded class hierarchy of UploadTmgmtActionApproveForm

1 string reference to 'UploadTmgmtActionApproveForm'

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

File

src/Form/UploadTmgmtActionApproveForm.php, line 11

Namespace

Drupal\tmgmt_extension_suit\Form

View source

class UploadTmgmtActionApproveForm extends BaseTmgmtActionApproveForm {

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

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

  /**
   * 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 ($translator = $job
      ->getTranslator()) {
      $translator_plugin = $job
        ->getTranslatorPlugin();
      if ($translator_plugin instanceof ExtendedTranslatorPluginInterface) {
        \Drupal::getContainer()
          ->get('logger.channel.tmgmt_extension_suit')
          ->info(t('File upload triggered (view action). Job id: @job_id, file name: @name.', [
          '@name' => $translator_plugin
            ->getFileName($job),
          '@job_id' => $job
            ->id(),
        ]));
      }
      $translator
        ->getPlugin()
        ->requestTranslation($job);
      $context['results']['count']++;
      $context['message'] = new FormattableMarkup('Processed %name.', [
        '%name' => $job
          ->label(),
      ]);
    }
    else {
      $context['message'] = new FormattableMarkup('Skipped %name.', [
        '%name' => $entity_type_id,
      ]);
    }
  }

}

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

You are here

class UploadTmgmtActionApproveForm in TMGMT Extension Suite 8

Hierarchy

File

Namespace

Members

API Navigation