You are here

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

class RequestTranslationTmgmtActionApproveForm in TMGMT Extension Suite 8.3

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

Provides a confirmation form for sending multiple content entities.

Hierarchy

Expanded class hierarchy of RequestTranslationTmgmtActionApproveForm

1 string reference to 'RequestTranslationTmgmtActionApproveForm'
tmgmt_extension_suit.routing.yml in ./tmgmt_extension_suit.routing.yml
tmgmt_extension_suit.routing.yml

File

src/Form/RequestTranslationTmgmtActionApproveForm.php, line 20

Namespace

Drupal\tmgmt_extension_suit\Form
View source 
class RequestTranslationTmgmtActionApproveForm extends BaseTmgmtActionApproveForm {

  /**
   * Job checkout manager.
   *
   * @var \Drupal\tmgmt\JobCheckoutManager
   */
  protected $checkoutManager;

  /**
   * Job queue.
   *
   * @var \Drupal\tmgmt\JobQueue
   */
  protected $jobQueue;

  /**
   * Constructs a new UserMultipleCancelConfirm.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The temp store 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.
   * @param \Drupal\tmgmt\JobCheckoutManager $checkout_manager
   *   Job checkout manager.
   * @param \Drupal\tmgmt\JobQueue $job_queue
   *   Job queue.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, QueueInterface $queue, ImmutableConfig $config, JobCheckoutManager $checkout_manager, JobQueue $job_queue) {
    parent::__construct($temp_store_factory, $entity_type_manager, $language_manager, $queue, $config);
    $this->checkoutManager = $checkout_manager;
    $this->jobQueue = $job_queue;
  }

  /**
   * {@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'), $container
      ->get('tmgmt.job_checkout_manager'), $container
      ->get('tmgmt.queue'));
  }

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

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

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

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

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

  /**
   * Form submit.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Retrieve selected jobs.
    $jobs = $this
      ->getEntities($this->entityIds);

    // Mark jobs as unprocessed for further processing.
    foreach ($jobs as $job) {

      // Requesting translation is possible only for unprocessed jobs.
      // See JobCheckoutManager::checkoutMultiple() method.
      $job
        ->setState(Job::STATE_UNPROCESSED);
      foreach ($job
        ->getItems() as $item) {

        // Reset statistics for the job item in order to have "count_pending"
        // value not equal to "0". See Job::requestTranslation() and
        // Job::getItems() methods.
        $item
          ->setState(JobItem::STATE_ACTIVE);
        $item
          ->resetData();
        $item
          ->recalculateStatistics();
        $item
          ->save();
      }
    }

    // Launch TMGMT's checkout process.
    $this->checkoutManager
      ->checkoutAndRedirect($form_state, $jobs);
    $this->jobQueue
      ->setDestination('/admin/tmgmt/jobs');
  }

  /**
   * {@inheritdoc}
   */
  public static function processBatch(array $data, array &$context) {
  }

}

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::$tempStoreFactory protected property The temp store factory.
BaseTmgmtActionApproveForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
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.
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.
RequestTranslationTmgmtActionApproveForm::$checkoutManager protected property Job checkout manager.
RequestTranslationTmgmtActionApproveForm::$jobQueue protected property Job queue.
RequestTranslationTmgmtActionApproveForm::$tempStorageName protected property Temp storage name we are saving entity_ids to. Overrides BaseTmgmtActionApproveForm::$tempStorageName
RequestTranslationTmgmtActionApproveForm::create public static function Instantiates a new instance of this class. Overrides BaseTmgmtActionApproveForm::create
RequestTranslationTmgmtActionApproveForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
RequestTranslationTmgmtActionApproveForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
RequestTranslationTmgmtActionApproveForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RequestTranslationTmgmtActionApproveForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
RequestTranslationTmgmtActionApproveForm::processBatch public static function Processes the sending batch. Overrides BaseTmgmtActionApproveForm::processBatch
RequestTranslationTmgmtActionApproveForm::submitForm public function Form submit. Overrides BaseTmgmtActionApproveForm::submitForm
RequestTranslationTmgmtActionApproveForm::__construct public function Constructs a new UserMultipleCancelConfirm. Overrides BaseTmgmtActionApproveForm::__construct
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.