abstract class SourcePluginBase in Translation Management Tool 8

Default controller class for source plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\tmgmt\SourcePluginBase implements SourcePluginInterface

Related topics

Translation source

A source plugin represents translatable elements on a site.

4 files declare their use of SourcePluginBase

ConfigSource.php in sources/tmgmt_config/src/Plugin/tmgmt/Source/ConfigSource.php

ContentEntitySource.php in sources/content/src/Plugin/tmgmt/Source/ContentEntitySource.php

LocaleSource.php in sources/locale/src/Plugin/tmgmt/Source/LocaleSource.php

TestSource.php in tmgmt_test/src/Plugin/tmgmt/Source/TestSource.php

File

src/SourcePluginBase.php, line 12

Namespace

Drupal\tmgmt

abstract class SourcePluginBase extends PluginBase implements SourcePluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getLabel(JobItemInterface $job_item) {
    return t('@plugin item unavailable (@item)', array(
      '@plugin' => $this->pluginDefinition['label'],
      '@item' => $job_item
        ->getItemType() . ':' . $job_item
        ->getItemId(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function getUrl(JobItemInterface $job_item) {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getItemTypes() {
    return isset($this->pluginDefinition['item types']) ? $this->pluginDefinition['item types'] : array();
  }

  /**
   * {@inheritdoc}
   */
  public function getItemTypeLabel($type) {
    $types = $this
      ->getItemTypes();
    if (isset($types[$type])) {
      return $types[$type];
    }
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getType(JobItemInterface $job_item) {
    return ucfirst($job_item
      ->getItemType());
  }

  /**
   * {@inheritdoc}
   */
  public function getExistingLangCodes(JobItemInterface $job_item) {
    return [
      $this
        ->getSourceLangCode($job_item),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
SourcePluginBase::getExistingLangCodes	public	function	Gets existing translation language codes of the job item source. Overrides SourcePluginInterface::getExistingLangCodes	4
SourcePluginBase::getItemTypeLabel	public	function	Returns the label of a source item type. Overrides SourcePluginInterface::getItemTypeLabel	2
SourcePluginBase::getItemTypes	public	function	Returns an array of translatable source item types. Overrides SourcePluginInterface::getItemTypes	3
SourcePluginBase::getLabel	public	function	Return a title for this job item. Overrides SourcePluginInterface::getLabel	4
SourcePluginBase::getType	public	function	Returns the type of a job item. Overrides SourcePluginInterface::getType	3
SourcePluginBase::getUrl	public	function	Returns the Uri for this job item. Overrides SourcePluginInterface::getUrl	3
SourcePluginInterface::getData	public	function	Returns an array with the data structured for translation.	4
SourcePluginInterface::getSourceLangCode	public	function	Gets language code of the job item source.	4
SourcePluginInterface::saveTranslation	public	function	Saves a translation.	4
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.