You are here

class CancelTranslationLingotekAction in Lingotek Translation 3.4.x

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

Request Lingotek translation of a content entity for one language.

Plugin annotation


@Action(
  id = "entity:lingotek_cancel_translation_action",
  action_label = @Translation("Cancel @entity_label translation in Lingotek for @language"),
  category = "Lingotek",
  deriver = "Drupal\lingotek\Plugin\Action\Derivative\ContentEntityLingotekActionDeriver",
)

Hierarchy

Expanded class hierarchy of CancelTranslationLingotekAction

File

src/Plugin/Action/CancelTranslationLingotekAction.php, line 17

Namespace

Drupal\lingotek\Plugin\Action
View source
class CancelTranslationLingotekAction extends LingotekContentEntityConfigurableActionBase {

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $result = FALSE;
    $entityTypeBundleInfo = \Drupal::service('entity_type.bundle.info');
    $bundleInfos = $entityTypeBundleInfo
      ->getBundleInfo($entity
      ->getEntityTypeId());
    if (!$entity
      ->getEntityType()
      ->isTranslatable() || !$bundleInfos[$entity
      ->bundle()]['translatable']) {
      $this
        ->messenger()
        ->addWarning(t('Cannot cancel translation for @type %label. That @bundle_label is not enabled for translation.', [
        '@type' => $bundleInfos[$entity
          ->bundle()]['label'],
        '%label' => $entity
          ->label(),
        '@bundle_label' => $entity
          ->getEntityType()
          ->getBundleLabel(),
      ]));
      return FALSE;
    }

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_configuration */
    $lingotek_configuration = \Drupal::service('lingotek.configuration');
    if (!$lingotek_configuration
      ->isEnabled($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      $this
        ->messenger()
        ->addWarning(t('Cannot cancel translation for @type %label. That @bundle_label is not enabled for Lingotek translation.', [
        '@type' => $bundleInfos[$entity
          ->bundle()]['label'],
        '%label' => $entity
          ->label(),
        '@bundle_label' => $entity
          ->getEntityType()
          ->getBundleLabel(),
      ]));
      return FALSE;
    }
    $configuration = $this
      ->getConfiguration();
    $langcode = $configuration['language'];
    try {
      $locale = $this->languageLocaleMapper
        ->getLocaleForLangcode($langcode);
      $result = $this->translationService
        ->cancelDocumentTarget($entity, $locale);
    } catch (LingotekApiException $exception) {
      $this
        ->messenger()
        ->addError(t('The cancellation of @entity_type %title translation to @language failed. Please try again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
        '@language' => $langcode,
      ]));
    }
    return $result;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
CancelTranslationLingotekAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConfigurableActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
ConfigurableActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LingotekContentEntityConfigurableActionBase::$entityTypeManager protected property The entity type manager.
LingotekContentEntityConfigurableActionBase::$languageLocaleMapper protected property The language-locale mapper.
LingotekContentEntityConfigurableActionBase::$translationService protected property The Lingotek content translation service.
LingotekContentEntityConfigurableActionBase::access public function Checks object access. Overrides ActionInterface::access
LingotekContentEntityConfigurableActionBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
LingotekContentEntityConfigurableActionBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LingotekContentEntityConfigurableActionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
LingotekContentEntityConfigurableActionBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
LingotekContentEntityConfigurableActionBase::__construct public function Constructs a new UploadToLingotekAction action. Overrides ConfigurableActionBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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.