class ConvertCase in Tamper 8

Plugin implementation for converting case.

Plugin annotation

@Tamper(
  id = "convert_case",
  label = @Translation("Convert case"),
  description = @Translation("Convert case."),
  category = "Text"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\tamper\TamperBase implements TamperInterface
      • class \Drupal\tamper\Plugin\Tamper\ConvertCase

1 file declares its use of ConvertCase

ConvertCaseTest.php in tests/src/Unit/Plugin/Tamper/ConvertCaseTest.php

File

src/Plugin/Tamper/ConvertCase.php, line 20

Namespace

Drupal\tamper\Plugin\Tamper

class ConvertCase extends TamperBase {
  const SETTING_OPERATION = 'operation';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_OPERATION] = 'ucfirst';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_OPERATION] = [
      '#type' => 'select',
      '#title' => $this
        ->t('How to convert case'),
      '#options' => $this
        ->getOptions(),
      '#default_value' => $this
        ->getSetting(self::SETTING_OPERATION),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this
      ->setConfiguration([
      self::SETTING_OPERATION => $form_state
        ->getValue(self::SETTING_OPERATION),
    ]);
  }

  /**
   * Get the case conversion options.
   *
   * @return array
   *   List of options, keyed by method on Drupal's unicode class.
   */
  protected function getOptions() {
    return [
      'strtoupper' => $this
        ->t('Convert to uppercase'),
      'strtolower' => $this
        ->t('Convert to lowercase'),
      'ucfirst' => $this
        ->t('Capitalize the first character'),
      'lcfirst' => $this
        ->t('Convert the first character to lowercase'),
      'ucwords' => $this
        ->t('Capitalize the first character of each word'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    if (!is_string($data)) {
      throw new TamperException('Input should be a string.');
    }
    $operation = $this
      ->getSetting(self::SETTING_OPERATION);
    switch ($operation) {
      case 'strtoupper':
        return mb_strtoupper($data);
      case 'strtolower':
        return mb_strtolower($data);
      default:
        if (!is_callable([
          '\\Drupal\\Component\\Utility\\Unicode',
          $operation,
        ])) {
          throw new TamperException('Invalid operation ' . $operation);
        }
        return call_user_func([
          '\\Drupal\\Component\\Utility\\Unicode',
          $operation,
        ], $data);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConvertCase::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
ConvertCase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
ConvertCase::getOptions	protected	function	Get the case conversion options.
ConvertCase::SETTING_OPERATION		constant
ConvertCase::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
ConvertCase::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::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::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	3
TamperBase::__construct	public	function	Constructs a TamperBase object. Overrides PluginBase::__construct	1