You are here

class LingotekJobAssignToMultipleEntitiesForm in Lingotek Translation 3.2.x

Same name and namespace in other branches
  1. 8.2 src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  2. 4.0.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  3. 3.0.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  4. 3.1.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  5. 3.3.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  6. 3.4.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  7. 3.5.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  8. 3.6.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  9. 3.7.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm
  10. 3.8.x src/Form/LingotekJobAssignToMultipleEntitiesForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleEntitiesForm

Form for bulk assignation of Job ID to content entities.

@package Drupal\lingotek\Form

Hierarchy

Expanded class hierarchy of LingotekJobAssignToMultipleEntitiesForm

1 string reference to 'LingotekJobAssignToMultipleEntitiesForm'
lingotek.routing.yml in ./lingotek.routing.yml
lingotek.routing.yml

File

src/Form/LingotekJobAssignToMultipleEntitiesForm.php, line 24

Namespace

Drupal\lingotek\Form
View source
class LingotekJobAssignToMultipleEntitiesForm extends FormBase {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

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

  /**
   * The tempstore.
   *
   * @var \Drupal\Core\TempStore\SharedTempStore
   */
  protected $tempStore;

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The Lingotek content translation service.
   *
   * @var \Drupal\lingotek\LingotekContentTranslationServiceInterface
   */
  protected $translationService;

  /**
   * The selection, in the $entity_type_id => entity_id => langcodes format.
   *
   * @var array
   */
  protected $selection = [];

  /**
   * Constructs a new LingotekJobAssignToMultipleEntitiesForm object.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   * @param \Drupal\lingotek\LingotekContentTranslationServiceInterface $translation_service
   *   The Lingotek content translation service.
   */
  public function __construct(AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, PrivateTempStoreFactory $temp_store_factory, MessengerInterface $messenger, LingotekContentTranslationServiceInterface $translation_service) {
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
    $this->tempStore = $temp_store_factory
      ->get('lingotek_assign_job_entity_multiple_confirm');
    $this->messenger = $messenger;
    $this->translationService = $translation_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('entity_type.manager'), $container
      ->get('tempstore.private'), $container
      ->get('messenger'), $container
      ->get('lingotek.content_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'lingotek.assign_job_entity_multiple_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->selection = $this->tempStore
      ->get($this->currentUser
      ->id());
    if (empty($this->selection)) {
      $form_state
        ->setRedirectUrl(Url::fromUserInput('/' . $form_state
        ->getValue('destination')));
    }
    $entities = $this
      ->getSelectedEntities($this->selection);
    $items = array_map(function ($entity) {
      return $entity
        ->label();
    }, $entities);
    $form['job_id'] = [
      '#type' => 'lingotek_job_id',
      '#title' => $this
        ->t('Job ID'),
      '#description' => $this
        ->t('Assign a job id that you can filter on later on the TMS or in this page.'),
    ];
    $form['update_tms'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Notify the Lingotek TMS'),
      '#description' => $this
        ->t('Notify the Lingotek TMS (when applicable)'),
    ];
    $form['entities'] = [
      '#theme' => 'item_list',
      '#title' => $this
        ->t('Affected content'),
      '#items' => $items,
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Assign Job ID'),
      '#submit' => [
        '::submitForm',
      ],
      '#button_type' => 'primary',
    ];
    $form['actions']['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#submit' => [
        '::cancelForm',
      ],
      '#attributes' => [
        'class' => [
          'button',
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function cancelForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirectUrl(Url::fromUserInput('/' . $form_state
      ->getValue('destination')));

    // Clear selected data.
    $this->tempStore
      ->delete($this->currentUser
      ->id());
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $job_id = $form_state
      ->getValue('job_id');
    $updateTMS = $form_state
      ->getValue('update_tms');
    $entities = $this
      ->getSelectedEntities($this->selection);
    $errors = FALSE;
    foreach ($entities as $entity) {
      try {
        $this->translationService
          ->setJobId($entity, $job_id, $updateTMS);
      } catch (LingotekPaymentRequiredException $exception) {
        $errors = TRUE;
        $this
          ->messenger()
          ->addError(t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
      } catch (LingotekDocumentArchivedException $exception) {
        $errors = TRUE;
        $this
          ->messenger()
          ->addError(t('Document @entity_type %title has been archived. Please upload again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      } catch (LingotekDocumentLockedException $exception) {
        $errors = TRUE;
        $this
          ->messenger()
          ->addError(t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      } catch (LingotekApiException $exception) {
        $errors = TRUE;
        $this
          ->messenger()
          ->addError(t('The Job ID change submission for @entity_type %title failed. Please try again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      }
    }
    $form_state
      ->setRedirectUrl(Url::fromUserInput('/' . $form_state
      ->getValue('destination')));
    if (!$errors) {
      $this
        ->postStatusMessage();
    }
    else {
      $this->messenger
        ->addWarning($this
        ->t('Job ID for some content failed to sync to the TMS.'));
    }

    // Clear selected data.
    $this->tempStore
      ->delete($this->currentUser
      ->id());
  }

  /**
   * Post a status message when succeeded.
   */
  protected function postStatusMessage() {
    $this->messenger
      ->addStatus($this
      ->t('Job ID was assigned successfully.'));
  }

  /**
   * Gets an array as in $entity_type_id:$id => $entity from the selection.
   *
   * @param string[][] $selection
   *   The selection.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface[]
   *   The entities.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getSelectedEntities($selection) {
    $entities = [];
    foreach ($selection as $entity_type_id => $ids) {
      $list = $this->entityTypeManager
        ->getStorage($entity_type_id)
        ->loadMultiple(array_keys($ids));
      foreach ($list as $id => $entity) {
        $key = $entity_type_id . ':' . $id;
        $entities[$key] = $entity;
      }
    }
    return $entities;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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 72
LingotekJobAssignToMultipleEntitiesForm::$currentUser protected property The current user.
LingotekJobAssignToMultipleEntitiesForm::$entityTypeManager protected property The entity type manager.
LingotekJobAssignToMultipleEntitiesForm::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
LingotekJobAssignToMultipleEntitiesForm::$selection protected property The selection, in the $entity_type_id => entity_id => langcodes format.
LingotekJobAssignToMultipleEntitiesForm::$tempStore protected property The tempstore.
LingotekJobAssignToMultipleEntitiesForm::$translationService protected property The Lingotek content translation service.
LingotekJobAssignToMultipleEntitiesForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 1
LingotekJobAssignToMultipleEntitiesForm::cancelForm public function
LingotekJobAssignToMultipleEntitiesForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LingotekJobAssignToMultipleEntitiesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
LingotekJobAssignToMultipleEntitiesForm::getSelectedEntities protected function Gets an array as in $entity_type_id:$id => $entity from the selection.
LingotekJobAssignToMultipleEntitiesForm::postStatusMessage protected function Post a status message when succeeded. 1
LingotekJobAssignToMultipleEntitiesForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm 1
LingotekJobAssignToMultipleEntitiesForm::__construct public function Constructs a new LingotekJobAssignToMultipleEntitiesForm object.
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 public function Gets the messenger. 27
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. 4
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.