class TestInterpreter in Recurring Dates Field 3.0.x

Provides an interpreter for testing.

Plugin annotation

@DateRecurInterpreter(
 id = "test_interpreter",
 label = @Translation("Testing interpreter"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\date_recur\Plugin\DateRecurInterpreterPluginBase implements DateRecurInterpreterPluginInterface uses PluginWithFormsTrait
      • class \Drupal\date_recur_interpreter_test\Plugin\DateRecurInterpreter\TestInterpreter implements PluginFormInterface

File

tests/modules/date_recur_interpreter_test/src/Plugin/DateRecurInterpreter/TestInterpreter.php, line 19

Namespace

Drupal\date_recur_interpreter_test\Plugin\DateRecurInterpreter

class TestInterpreter extends DateRecurInterpreterPluginBase implements PluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [
      'show_foo' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function interpret(array $rules, string $language, ?\DateTimeZone $timeZone = NULL) : string {
    $pluginConfig = $this
      ->getConfiguration();
    if ($pluginConfig['show_foo']) {
      return 'foo';
    }
    else {
      return 'bar';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['show_foo'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show the foo'),
      '#default_value' => $this->configuration['show_foo'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['show_foo'] = $form_state
      ->getValue('show_foo');
  }

  /**
   * {@inheritdoc}
   */
  public function supportedLanguages() : array {
    return [
      'es',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateRecurInterpreterPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
DateRecurInterpreterPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
DateRecurInterpreterPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	98
PluginWithFormsTrait::getFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TestInterpreter::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
TestInterpreter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides DateRecurInterpreterPluginBase::defaultConfiguration
TestInterpreter::interpret	public	function	Interpret a set of rules in a language. Overrides DateRecurInterpreterPluginInterface::interpret
TestInterpreter::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
TestInterpreter::supportedLanguages	public	function	The languages supported by this plugin. Overrides DateRecurInterpreterPluginInterface::supportedLanguages
TestInterpreter::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm