You are here

Home » API reference » Translation Management Tool 8 » TranslatorInterface.php

interface TranslatorInterface in Translation Management Tool 8

Interface for the tmgmt_translator entity.

Hierarchy

Expanded class hierarchy of TranslatorInterface

All classes that implement TranslatorInterface

Related topics

Translators
A translator plugin integrates a translation service.
4 files declare their use of TranslatorInterface
FileTranslator.php in translators/tmgmt_file/src/Plugin/tmgmt/Translator/FileTranslator.php
LocalTranslator.php in translators/tmgmt_local/src/Plugin/tmgmt/Translator/LocalTranslator.php
TestTranslator.php in tmgmt_test/src/Plugin/tmgmt/Translator/TestTranslator.php
Translator.php in src/Entity/Translator.php

File

src/TranslatorInterface.php, line 12

Namespace

Drupal\tmgmt
View source 
interface TranslatorInterface extends ConfigEntityInterface {

  /**
   * Returns the array of settings.
   *
   * See the documentation of the translator plugin for supported or
   * required settings.
   *
   * @return array
   *   The array of settings.
   */
  public function getSettings();

  /**
   * Sets the array of settings.
   *
   * @param array $settings
   *   The array of settings.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setSettings(array $settings);

  /**
   * Retrieves a setting value from the translator settings.
   *
   * Pulls the default values (if defined) from the plugin controller.
   *
   * @param string|array $name
   *   The name of the setting, an array with multiple keys for nested settings.
   *
   * @return string
   *   The setting value or $default if the setting value is not set. Returns
   *   NULL if the setting does not exist at all.
   */
  public function getSetting($name);

  /**
   * Sets a definition setting.
   *
   * @param string|array $setting_name
   *   The definition setting to set.
   * @param mixed $value
   *   The value to set.
   *
   * @return static
   *   The object itself for chaining.
   */
  public function setSetting($setting_name, $value);

  /**
   * Checks if it can skip the reviewing process and automatically accepts all translations.
   *
   * @return bool
   *   TRUE if it can skip the reviewing process, FALSE otherwise.
   */
  public function isAutoAccept();

  /**
   * Sets whether to skip the reviewing process and automatically accept all translations.
   *
   * @param bool
   *   The value to set.
   *
   * @return $this
   */
  public function setAutoAccept($value);

  /**
   * Returns the translator plugin ID.
   *
   * @return string
   *   The translator plugin ID used by this translator.
   */
  public function getPluginId();

  /**
   * Returns the translator plugin ID.
   *
   * @return string
   *   The translator plugin ID used by this translator.
   */
  public function getDescription();

  /**
   * Sets the plugin ID.
   *
   * @param string $plugin_id
   *   The plugin ID.
   */
  public function setPluginID($plugin_id);

  /**
   * Returns the translator plugin of this translator.
   *
   * @return \Drupal\tmgmt\TranslatorPluginInterface
   *   Returns the TranslatorPluginInterface.
   */
  public function getPlugin();

  /**
   * Checks if the translator plugin of this translator exists.
   *
   * @return bool
   *   Returns TRUE if it exists, FALSE otherwise.
   */
  public function hasPlugin();

  /**
   * Returns the supported target languages for this translator.
   *
   * @param string $source_language
   *   The local source language.
   *
   * @return array
   *   An array of supported target languages in ISO format.
   */
  public function getSupportedTargetLanguages($source_language);

  /**
   * Gets the supported language pairs for this translator.
   *
   * @return array
   *   List of language pairs where a pair is an associative array of
   *   source_language and target_language.
   *   Example:
   *   array(
   *     array('source_language' => 'en-US', 'target_language' => 'de-DE'),
   *     array('source_language' => 'en-US', 'target_language' => 'de-CH'),
   *   )
   */
  public function getSupportedLanguagePairs();

  /**
   * Gets all supported languages of the translator plugin.
   *
   * @return array
   *   An array of language codes which are provided by the translator plugin
   *   (remote language codes).
   */
  public function getSupportedRemoteLanguages();

  /**
   * Clears the language cache for this translator.
   */
  public function clearLanguageCache();

  /**
   * Check whether this translator can handle a particular translation job.
   *
   * @param \Drupal\tmgmt\JobInterface Job
   *   The Job entity that should be translated.
   *
   * @return \Drupal\tmgmt\Translator\TranslatableResult
   *   TRUE if the job can be processed and translated, FALSE otherwise.
   */
  public function checkTranslatable(JobInterface $job);

  /**
   * Checks whether a translator is available.
   *
   * @return \Drupal\tmgmt\Translator\AvailableResult
   *   TRUE if the translator plugin is available, FALSE otherwise.
   */
  public function checkAvailable();

  /**
   * Returns if the plugin has any settings for this job.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   *   The Job entity that should be translated.
   */
  public function hasCheckoutSettings(JobInterface $job);

  /**
   * Gets existing remote languages mappings.
   *
   * This method is responsible to provide all local to remote language pairs.
   *
   * @return array
   *   An array of local => remote language codes
   *
   * @ingroup tmgmt_remote_languages_mapping
   */
  public function getRemoteLanguagesMappings();

  /**
   * Maps remote languages to local languages.
   *
   * Returns a list of local languages that can be mapped to any of the
   * remote languages.
   *
   * @param string[] $remote_languages
   *   Remote language codes.
   *
   * @return string[]
   *   Local language codes.
   *
   * @ingroup tmgmt_remote_languages_mapping
   */
  public function mapToLocalLanguages(array $remote_languages);

  /**
   * Maps local language to remote language.
   *
   * @param string $language
   *   Local language code.
   *
   * @return string
   *   Remote language code.
   *
   * @ingroup tmgmt_remote_languages_mapping
   */
  public function mapToRemoteLanguage($language);

  /**
   * Determines if this translator supports remote language mappings.
   *
   * @return bool
   *   In case translator does not explicitly state that it does not provide the
   *   mapping feature it will return TRUE.
   */
  public function providesRemoteLanguageMappings();

  /**
   * Determines if job settings of the translator will be handled by its plugin.
   *
   * @return bool
   *   If job settings are to be handled by the plugin.
   */
  public function hasCustomSettingsHandling();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5
TranslatorInterface::checkAvailable public function Checks whether a translator is available. 1
TranslatorInterface::checkTranslatable public function Check whether this translator can handle a particular translation job. 1
TranslatorInterface::clearLanguageCache public function Clears the language cache for this translator. 1
TranslatorInterface::getDescription public function Returns the translator plugin ID. 1
TranslatorInterface::getPlugin public function Returns the translator plugin of this translator. 1
TranslatorInterface::getPluginId public function Returns the translator plugin ID. 1
TranslatorInterface::getRemoteLanguagesMappings public function Gets existing remote languages mappings. 1
TranslatorInterface::getSetting public function Retrieves a setting value from the translator settings. 1
TranslatorInterface::getSettings public function Returns the array of settings. 1
TranslatorInterface::getSupportedLanguagePairs public function Gets the supported language pairs for this translator. 1
TranslatorInterface::getSupportedRemoteLanguages public function Gets all supported languages of the translator plugin. 1
TranslatorInterface::getSupportedTargetLanguages public function Returns the supported target languages for this translator. 1
TranslatorInterface::hasCheckoutSettings public function Returns if the plugin has any settings for this job. 1
TranslatorInterface::hasCustomSettingsHandling public function Determines if job settings of the translator will be handled by its plugin. 1
TranslatorInterface::hasPlugin public function Checks if the translator plugin of this translator exists. 1
TranslatorInterface::isAutoAccept public function Checks if it can skip the reviewing process and automatically accepts all translations. 1
TranslatorInterface::mapToLocalLanguages public function Maps remote languages to local languages. 1
TranslatorInterface::mapToRemoteLanguage public function Maps local language to remote language. 1
TranslatorInterface::providesRemoteLanguageMappings public function Determines if this translator supports remote language mappings. 1
TranslatorInterface::setAutoAccept public function Sets whether to skip the reviewing process and automatically accept all translations. 1
TranslatorInterface::setPluginID public function Sets the plugin ID. 1
TranslatorInterface::setSetting public function Sets a definition setting. 1
TranslatorInterface::setSettings public function Sets the array of settings. 1