class TranslatorManager

A plugin manager for translator plugins.

Hierarchy

  • class \Drupal\tmgmt\TranslatorManager extends \Drupal\Core\Plugin\DefaultPluginManager

Expanded class hierarchy of TranslatorManager

3 files declare their use of TranslatorManager
1 string reference to 'TranslatorManager'

File

src/TranslatorManager.php, line 12

Namespace

Drupal\tmgmt
View source
class TranslatorManager extends DefaultPluginManager {

  /**
   * Array of instantiated translator UI instances.
   *
   * @var array
   */
  protected $ui = array();

  /**
   * Constructs a ConditionManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/tmgmt/Translator', $namespaces, $module_handler, 'Drupal\\tmgmt\\TranslatorPluginInterface', 'Drupal\\tmgmt\\Annotation\\TranslatorPlugin');
    $this
      ->alterInfo('tmgmt_translator_info');
    $this
      ->setCacheBackend($cache_backend, 'tmgmt_translator');
  }

  /**
   * Returns a translator plugin UI instance.
   *
   * @param string $plugin
   *   Name of the translator plugin.
   *
   * @return \Drupal\tmgmt\TranslatorPluginUiInterface
   *   Instance a translator plugin UI instance.
   */
  public function createUIInstance($plugin) {
    if (!isset($this->ui[$plugin])) {
      $definition = $this
        ->getDefinition($plugin);
      $class = $definition['ui'];
      $this->ui[$plugin] = new $class(array(), $plugin, $definition);
    }
    return $this->ui[$plugin];
  }

  /**
   * Returns the translator plugin labels.
   *
   * @return array
   *   Array of plugin labels, keyed by the plugin id.
   */
  public function getLabels() {
    $list = array();
    foreach ($this
      ->getDefinitions() as $plugin => $definition) {
      $list[$plugin] = $definition['label'];
    }
    return $list;
  }

  /**
   * Returns TRUE if at least one translator plugin supports files.
   *
   * @return bool
   *   True if files may be sent to a translator.
   */
  public function supportsFiles() : bool {
    foreach ($this
      ->getDefinitions() as $plugin => $definition) {
      if (!empty($definition['files'])) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
TranslatorManager::$ui protected property Array of instantiated translator UI instances.
TranslatorManager::createUIInstance public function Returns a translator plugin UI instance.
TranslatorManager::getLabels public function Returns the translator plugin labels.
TranslatorManager::supportsFiles public function Returns TRUE if at least one translator plugin supports files.
TranslatorManager::__construct public function Constructs a ConditionManager object.