class LingotekDisassociateAllConfirmForm in Lingotek Translation 3.4.x

Show a warning before disassociate all content.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\lingotek\Form\LingotekDisassociateAllConfirmForm

1 string reference to 'LingotekDisassociateAllConfirmForm'

lingotek.routing.yml in ./lingotek.routing.yml

lingotek.routing.yml

File

src/Form/LingotekDisassociateAllConfirmForm.php, line 19

Namespace

Drupal\lingotek\Form

class LingotekDisassociateAllConfirmForm extends ConfirmFormBase {

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

  /**
   * The Lingotek configuration translation service.
   *
   * @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface
   */
  protected $configTranslationService;

  /**
   * Constructs a new LingotekDisassociateAllConfirmForm object.
   *
   * @param \Drupal\lingotek\LingotekContentTranslationServiceInterface $content_translation_service
   *   The Lingotek content translation service.
   * @param \Drupal\lingotek\LingotekConfigTranslationServiceInterface $config_translation_service
   *   The Lingotek config translation service.
   */
  public function __construct(LingotekContentTranslationServiceInterface $content_translation_service, LingotekConfigTranslationServiceInterface $config_translation_service) {
    $this->contentTranslationService = $content_translation_service;
    $this->configTranslationService = $config_translation_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('lingotek.content_translation'), $container
      ->get('lingotek.config_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'lingotek_disassociate_all_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormName() {
    return 'lingotek_disassociate_all_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to disassociate everything from Lingotek?');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $string = '<p>' . $this
      ->t("This is useful for switching between different environments. It will disassociate the content from TMS content so your next changes won't alter what is getting worked on from the TMS.") . '</p>';
    $string .= '<p>' . $this
      ->t("This option should only be used if you still want the translations to be completed (and eventually billed for) in Lingotek's TMS.") . '</p>';
    $string .= '<p>' . $this
      ->t("Check if you may want to use the Cancel option instead.") . '</p>';
    $string .= '<p>' . parent::getDescription() . '</p>';
    return $string;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->disassociateAllTranslations();
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

  /**
   * Disassociate all content and config translations.
   */
  public function disassociateAllTranslations() {
    $error = FALSE;
    $error &= $this
      ->disassociateAllContentTranslations();
    $error &= $this
      ->disassociateAllConfigTranslations();
    if ($error) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Some translations may have been disassociated, but some failed.'));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('All translations have been disassociated.'));
    }
  }

  /**
   * Disassociate all config translations.
   */
  protected function disassociateAllConfigTranslations() {
    $error = FALSE;

    /** @var \Drupal\lingotek\Entity\LingotekConfigMetadata[] $all_config_metadata */
    $all_config_metadata = LingotekConfigMetadata::loadMultiple();
    foreach ($all_config_metadata as $config_metadata) {
      try {
        $mapper = $config_metadata
          ->getConfigMapper();
        if ($mapper instanceof ConfigEntityMapper) {
          $entity = $mapper
            ->getEntity();
          $this->configTranslationService
            ->deleteMetadata($entity);
        }
        else {
          $this->configTranslationService
            ->deleteConfigMetadata($mapper
            ->getPluginId());
        }
      } catch (LingotekApiException $exception) {
        $error = TRUE;
        if ($mapper instanceof ConfigEntityMapper) {
          $this
            ->messenger()
            ->addError(t('The deletion of %title failed. Please try again.', [
            '%title' => $mapper
              ->getEntity()
              ->label(),
          ]));
        }
        else {
          $this
            ->messenger()
            ->addError(t('The deletion of %title failed. Please try again.', [
            '%title' => $mapper
              ->getPluginId(),
          ]));
        }
      }
    }
    return $error;
  }

  /**
   * Disassociate all content translations.
   */
  protected function disassociateAllContentTranslations() {
    $error = FALSE;

    /** @var \Drupal\lingotek\Entity\LingotekContentMetadata[] $all_content_metadata */
    $all_content_metadata = LingotekContentMetadata::loadMultiple();
    foreach ($all_content_metadata as $content_metadata) {
      try {
        $content_metadata
          ->delete();
      } catch (LingotekApiException $exception) {
        $error = TRUE;
        $this
          ->messenger()
          ->addError(t('The disassociation of @entity_type %title failed. Please try again.', [
          '@entity_type' => $content_metadata
            ->getContentEntityTypeId(),
          '%title' => $content_metadata
            ->id(),
        ]));
      }
    }
    if ($error) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Some translations may have been disassociated, but some failed.'));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this
        ->t('All translations have been disassociated.'));
    }
    return $error;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	25
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	2
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
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
LingotekDisassociateAllConfirmForm::$configTranslationService	protected	property	The Lingotek configuration translation service.
LingotekDisassociateAllConfirmForm::$contentTranslationService	protected	property	The Lingotek content translation service.
LingotekDisassociateAllConfirmForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
LingotekDisassociateAllConfirmForm::disassociateAllConfigTranslations	protected	function	Disassociate all config translations.
LingotekDisassociateAllConfirmForm::disassociateAllContentTranslations	protected	function	Disassociate all content translations.
LingotekDisassociateAllConfirmForm::disassociateAllTranslations	public	function	Disassociate all content and config translations.
LingotekDisassociateAllConfirmForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
LingotekDisassociateAllConfirmForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
LingotekDisassociateAllConfirmForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
LingotekDisassociateAllConfirmForm::getFormID	public	function
LingotekDisassociateAllConfirmForm::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormBase::getFormName
LingotekDisassociateAllConfirmForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
LingotekDisassociateAllConfirmForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
LingotekDisassociateAllConfirmForm::__construct	public	function	Constructs a new LingotekDisassociateAllConfirmForm 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	protected	property	The messenger.	27
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.