You are here

Home » API reference » Tamper 8 » CountryToCode.php

class CountryToCode in Tamper 8

Plugin implementation for converting country to ISO code.

Plugin annotation


@Tamper(
  id = "country_to_code",
  label = @Translation("Country to ISO code"),
  description = @Translation("Converts this field from a country name string to the two character ISO 3166-1 alpha-2 code."),
  category = "Text"
)

Hierarchy

Expanded class hierarchy of CountryToCode

1 file declares its use of CountryToCode
CountryToCodeTest.php in tests/src/Unit/Plugin/Tamper/CountryToCodeTest.php

File

src/Plugin/Tamper/CountryToCode.php, line 21

Namespace

Drupal\tamper\Plugin\Tamper
View source 
class CountryToCode extends TamperBase implements ContainerFactoryPluginInterface {

  /**
   * Holds the CountryManager object so we can grab the country list.
   *
   * @var \Drupal\Core\Locale\CountryManagerInterface
   */
  protected $countryManager;

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

    /**
     * Holds the list of countries in an array.
     * @static
     */
    static $countries = [];
    if (empty($countries)) {
      $countries = $this->countryManager
        ->getList();
      foreach ($countries as $country_code => $country_name) {
        $countries[$country_code] = mb_strtolower((string) $country_name);
      }
      $countries = array_flip($countries);
    }

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

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

  /**
   * {@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
      ->setCountryManager($container
      ->get('country_manager'));
    return $instance;
  }

  /**
   * Setter function for the CountryManagerInterface.
   *
   * @param object $country_manager
   *   The country manager used to grab country list.
   */
  public function setCountryManager($country_manager) {
    $this->countryManager = $country_manager;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CountryToCode::$countryManager protected property Holds the CountryManager object so we can grab the country list.
CountryToCode::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CountryToCode::setCountryManager public function Setter function for the CountryManagerInterface.
CountryToCode::tamper public function Tamper data. Overrides TamperInterface::tamper
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.
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