class RuleScheduler in RNG - Events and Registrations 8

Same name and namespace in other branches

8.2 src/Plugin/Condition/RuleScheduler.php \Drupal\rng\Plugin\Condition\RuleScheduler
3.x src/Plugin/Condition/RuleScheduler.php \Drupal\rng\Plugin\Condition\RuleScheduler

Schedules rule execution based on the configured date.

Plugin annotation


@Condition(
  id = "rng_rule_scheduler",
  label = @Translation("Rule scheduler")
)

Hierarchy

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

Expanded class hierarchy of RuleScheduler

File

src/Plugin/Condition/RuleScheduler.php, line 22

Namespace

Drupal\rng\Plugin\Condition

View source

class RuleScheduler extends CurrentTime implements ContainerFactoryPluginInterface {
  protected $schedulerStorage;

  /**
   * Constructs a RegistrantBasicEmail object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->schedulerStorage = $entity_manager
      ->getStorage('rng_rule_scheduler');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity.manager'));
  }

  /**
   * {@inheritdoc}
   *
   * @return array
   *   - rng_rule_component: integer: Associated rule component ID.
   *   - rng_rule_scheduler: integer: ID of a rng_rule_schedule entity.
   *     If the ID is of a non-existent rng_rule_schedule entity, assume the
   *     rule has been executed successfully.
   *     The parent date configuration value is mirrored to the
   *     rng_rule_schedule entity when this form is saved.
   *   - negate: has no effect.
   */
  public function defaultConfiguration() {
    return [
      'rng_rule_component' => NULL,
      'rng_rule_scheduler' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * Get rule_component entity ID.
   */
  public function getRuleComponentId() {
    if (isset($this->configuration['rng_rule_component'])) {
      return $this->configuration['rng_rule_component'];
    }
    return NULL;
  }

  /**
   * Gets the rule scheduler entity.
   *
   * @return \Drupal\rng\RuleScheduleInterface
   */
  public function getRuleScheduler() {
    if (isset($this->configuration['rng_rule_scheduler'])) {
      return RuleSchedule::load($this->configuration['rng_rule_scheduler']);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['date']['#description'] = t('Rule will trigger once on this date.');
    $rule_scheduler = $this
      ->getRuleScheduler();
    if ($rule_scheduler) {
      if ($rule_scheduler
        ->getInQueue()) {
        drupal_set_message($this
          ->t('This message is queued for execution.'));
        $form['date']['#disabled'] = TRUE;
      }
    }
    unset($form['negate']);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['negate'] = FALSE;
    $this
      ->updateRuleSchedulerEntity();
  }

  /**
   * Create, update, or delete the associated rule scheduler entity.
   *
   * Depending on if it needs to exist.
   */
  public function updateRuleSchedulerEntity() {
    $rule_scheduler = $this
      ->getRuleScheduler();
    $rule_component_id = $this
      ->getRuleComponentId();
    $rule_component = $rule_component_id ? RuleComponent::load($rule_component_id) : NULL;
    $rule = $rule_component ? $rule_component
      ->getRule() : NULL;
    $rule_active = $rule instanceof RuleInterface ? $rule
      ->isActive() : FALSE;
    if ($rule_active) {
      if (!$rule_scheduler) {

        // Create the scheduler entity if it doesn't exist.
        $rule_scheduler = RuleSchedule::create([
          'component' => $this
            ->getRuleComponentId(),
        ]);
        $rule_scheduler
          ->save();
        $this->configuration['rng_rule_scheduler'] = $rule_scheduler
          ->id();
      }

      // Mirror the date into the scheduler.
      if ($rule_scheduler) {
        $rule_scheduler
          ->setDate($this->configuration['date']);
        $rule_scheduler
          ->save();
      }
    }
    else {

      // Delete the rule scheduler if it is not in the queue already.
      if ($rule_scheduler && !$rule_scheduler
        ->getInQueue()) {
        $rule_scheduler
          ->delete();
      }
    }
  }

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

}

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
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.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
CurrentTime::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
CurrentTime::getDate		function	Gets the date in configuration.
CurrentTime::getDateFormatted		function	Formats the date for display.
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
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.
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.
RuleScheduler::$schedulerStorage	protected	property
RuleScheduler::buildConfigurationForm	public	function	Form constructor. Overrides CurrentTime::buildConfigurationForm
RuleScheduler::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RuleScheduler::defaultConfiguration	public	function	Overrides CurrentTime::defaultConfiguration
RuleScheduler::getRuleComponentId	public	function	Get rule_component entity ID.
RuleScheduler::getRuleScheduler	public	function	Gets the rule scheduler entity.
RuleScheduler::submitConfigurationForm	public	function	Form submission handler. Overrides CurrentTime::submitConfigurationForm
RuleScheduler::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides CurrentTime::summary
RuleScheduler::updateRuleSchedulerEntity	public	function	Create, update, or delete the associated rule scheduler entity.
RuleScheduler::__construct	public	function	Constructs a RegistrantBasicEmail object. Overrides ConditionPluginBase::__construct
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
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class RuleScheduler in RNG - Events and Registrations 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation