You are here

Home » API reference » Custom Language field 8 » LanguageToCode.php

class LanguageToCode in Custom Language field 8

Plugin implementation for converting language name to language code.

Plugin annotation


@Tamper(
  id = "languagefield_language_to_code",
  label = @Translation("Language name to language code"),
  description = @Translation("Converts this field from a language name string to the language code."),
  category = "Text"
)

Hierarchy

Expanded class hierarchy of LanguageToCode

File

src/Plugin/Tamper/LanguageToCode.php, line 23

Namespace

Drupal\languagefield\Plugin\Tamper
View source 
class LanguageToCode extends TamperBase implements ContainerFactoryPluginInterface {

  /**
   * Holds the LanguageManager object so we can grab the language list.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = new static($configuration, $plugin_id, $plugin_definition, $configuration['source_definition']);
    $instance
      ->setLanguageManager($container
      ->get('language_manager'));
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    if (!is_string($data)) {
      throw new TamperException('Input should be a string.');
    }

    /**
     * Holds the list of languages in an array.
     * @static
     */
    static $languages = [];
    if (empty($languages)) {
      $languages = $this->languageManager
        ->getStandardLanguageList() + CustomLanguageManager::getCustomLanguageList();
      foreach ($languages as $language_code => $language_name) {
        $languages[$language_code] = mb_strtolower((string) $language_name[0]);
      }
      $languages = array_flip($languages);
    }

    // If it's already a valid language code, leave it alone.
    if (in_array($data, $languages)) {
      return $data;
    }

    // Trim whitespace, set to lowercase.
    $language = mb_strtolower(trim($data));
    if (isset($languages[$language])) {
      return $languages[$language];
    }
    else {
      throw new TamperException('Could not find language name ' . $language . ' in list of languages.');
    }
  }

  /**
   * Setter function for the LanguageManagerInterface.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager used to grab language list.
   */
  public function setLanguageManager(LanguageManagerInterface $language_manager) {
    $this->languageManager = $language_manager;
  }

}

Members

Namesort descending 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
LanguageToCode::$languageManager protected property Holds the LanguageManager object so we can grab the language list.
LanguageToCode::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageToCode::setLanguageManager public function Setter function for the LanguageManagerInterface.
LanguageToCode::tamper public function Tamper data. Overrides TamperInterface::tamper
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.
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.
TamperBase::$sourceDefinition protected property The source definition.
TamperBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 23
TamperBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 23
TamperBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TamperBase::getSetting public function Get a particular configuration value. Overrides TamperInterface::getSetting
TamperBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides TamperInterface::multiple 5
TamperBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TamperBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 22
TamperBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 3
TamperBase::__construct public function Constructs a TamperBase object. Overrides PluginBase::__construct 1