class CurrentTime in RNG - Events and Registrations 3.x

Same name and namespace in other branches

8.2 src/Plugin/Condition/CurrentTime.php \Drupal\rng\Plugin\Condition\CurrentTime
8 src/Plugin/Condition/CurrentTime.php \Drupal\rng\Plugin\Condition\CurrentTime

Evaluates if the current date is before or after the the configured date.

Plugin annotation


@Condition(
  id = "rng_current_time",
  label = @Translation("Current time")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Executable\ExecutablePluginBase implements CacheableDependencyInterface, ExecutableInterface, ContextAwarePluginInterface uses ContextAwarePluginTrait
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\rng\Plugin\Condition\CurrentTime

Expanded class hierarchy of CurrentTime

1 file declares its use of CurrentTime

MessageListForm.php in src/Form/MessageListForm.php

File

src/Plugin/Condition/CurrentTime.php, line 17

Namespace

Drupal\rng\Plugin\Condition

View source

class CurrentTime extends ConditionPluginBase {

  /**
   * {@inheritdoc}
   *
   * @return array
   *   - date: int: Unix timestamp of a date the rule can be triggered, as a
   *     minimum. This value is canonical, the rng_rule_schedule date is a
   *     mirror and is reflected when this condition is saved.
   *   - negate: boolean: If TRUE, this condition will evaluate if current time
   *     is after $date. If FALSE, before $date.
   */
  public function defaultConfiguration() {
    return [
      'date' => NULL,
      'enable' => FALSE,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    if (is_numeric($this->configuration['date'])) {
      $date = DrupalDateTime::createFromTimestamp($this
        ->getDate());
    }
    else {
      $date = new DrupalDateTime();
    }

    // Add administrative comment publishing options.
    $form['date'] = [
      '#type' => 'datetime',
      '#date_date_element' => 'date',
      '#title' => $this
        ->t('Date'),
      '#default_value' => $date,
      '#size' => 20,
      '#weight' => 50,
    ];
    $form['enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable this condition?'),
      '#default_value' => $this
        ->getConfiguration()['enable'],
    ];
    $form['negate'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Timing'),
      '#description' => $this
        ->t('Condition will be true if the time when evaluating this condition is before or after the date.'),
      '#options' => [
        0 => $this
          ->t('After this date'),
        1 => $this
          ->t('Before this date'),
      ],
      '#default_value' => (int) $this
        ->isNegated(),
      '#weight' => 100,
    ];
    return $form;
  }

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

    // Disable saving this plugin if it is not actively enabled.
    $enabled = $form_state
      ->getValue('enable');
    if (!$enabled) {
      return;
    }
    $this
      ->setConfig('enable', $enabled);
    $this
      ->setConfig('date', $form_state
      ->getValue('date')
      ->format('U'));
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    $t_args = [
      '@date' => DrupalDateTime::createFromTimestamp($this
        ->getDate()),
    ];
    if (!$this
      ->isNegated()) {
      return $this
        ->t('Current date is after @date', $t_args);
    }
    else {
      return $this
        ->t('Current date is before @date', $t_args);
    }
  }

  /**
   * Gets the date in configuration.
   */
  public function getDate() {
    return $this->configuration['date'];
  }

  /**
   * Formats the date for display.
   */
  public function getDateFormatted() {
    return is_numeric($this
      ->getDate()) ? DrupalDateTime::createFromTimestamp($this
      ->getDate()) : $this
      ->t('Not configured');
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $date = $this
      ->getDate();
    if ($date && is_numeric($date)) {
      if (!$this
        ->isNegated()) {
        return time() > $date;
      }
      else {
        return time() < $date;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionPluginBase::$executableManager	protected	property	The condition manager to proxy execute calls through.
ConditionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated	public	function	Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager	public	function	Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	5
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
ContextAwarePluginTrait::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts	public	function		9
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
ContextAwarePluginTrait::getContext	public	function
ContextAwarePluginTrait::getContextDefinition	public	function
ContextAwarePluginTrait::getContextDefinitions	public	function
ContextAwarePluginTrait::getContextMapping	public	function
ContextAwarePluginTrait::getContexts	public	function
ContextAwarePluginTrait::getContextValue	public	function
ContextAwarePluginTrait::getContextValues	public	function
ContextAwarePluginTrait::getPluginDefinition	abstract protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
CurrentTime::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm	1
CurrentTime::defaultConfiguration	public	function	Overrides ConditionPluginBase::defaultConfiguration	1
CurrentTime::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
CurrentTime::getDate	public	function	Gets the date in configuration.
CurrentTime::getDateFormatted	public	function	Formats the date for display.
CurrentTime::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm	1
CurrentTime::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary	1
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ExecutablePluginBase::getConfig	public	function	Gets all configuration values.
ExecutablePluginBase::getConfigDefinition	public	function	Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions	public	function	Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig	public	function	Sets the value of a particular configuration option.
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::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.	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

You are here

class CurrentTime in RNG - Events and Registrations 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation