abstract class SourcePluginBase

Default controller class for source plugins.

Hierarchy

Expanded class hierarchy of SourcePluginBase

Related topics

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
View source
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

Namesort descending Modifiers Type Description Overrides
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