class RequestTranslationLingotekAction in Lingotek Translation 4.0.x

Request Lingotek translation of a content entity for one language.

Plugin annotation

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

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableInterface, DependentPluginInterface, PluginFormInterface
        • class \Drupal\lingotek\Plugin\Action\LingotekContentEntityConfigurableActionBase implements ContainerFactoryPluginInterface
          • class \Drupal\lingotek\Plugin\Action\RequestTranslationLingotekAction

File

src/Plugin/Action/RequestTranslationLingotekAction.php, line 23

Namespace

Drupal\lingotek\Plugin\Action

class RequestTranslationLingotekAction 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 request @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 request @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'];
    $language = ConfigurableLanguage::load($langcode);
    if (!$lingotek_configuration
      ->isLanguageEnabled($language)) {
      $this
        ->messenger()
        ->addWarning(t('Cannot request language @language (%langcode). That language is not enabled for Lingotek translation.', [
        '@language' => $language
          ->getName(),
        '%langcode' => $langcode,
      ]));
      return FALSE;
    }
    try {
      $locale = $this->languageLocaleMapper
        ->getLocaleForLangcode($langcode);
      $result = $this->translationService
        ->addTarget($entity, $locale);
    } catch (LingotekPaymentRequiredException $exception) {
      $this
        ->messenger()
        ->addError(t('Community has been disabled. Please contact [e-mail] to re-enable your community.'));
    } catch (LingotekDocumentNotFoundException $exc) {
      $this
        ->messenger()
        ->addError(t('Document @entity_type %title was not found. Please upload again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
    } catch (LingotekDocumentArchivedException $exception) {
      $this
        ->messenger()
        ->addError(t('Document @entity_type %title has been archived. Uploading again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
      $plugin_manager = \Drupal::service('plugin.manager.action');
      $plugin_manager
        ->createInstance(str_replace('lingotek_request_translation_action', 'lingotek_upload_action', $this
        ->getPluginId()), $this->configuration)
        ->execute($entity);
    } catch (LingotekDocumentLockedException $exception) {
      $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) {
      $this
        ->messenger()
        ->addError(t('The request for @entity_type %title translation failed. Please try again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '@langcode' => $langcode,
        '%title' => $entity
          ->label(),
      ]));
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	3
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.
RequestTranslationLingotekAction::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
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.