You are here

Home » API reference » Auto Block Scheduler 8 » AutoBlockScheduler.php

class AutoBlockScheduler in Auto Block Scheduler 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Condition/AutoBlockScheduler.php \Drupal\auto_block_scheduler\Plugin\Condition\AutoBlockScheduler

Provides a 'AutoBlockScheduler ' condition.

Plugin annotation


@Condition(
  id = "auto_block_scheduler",
  label = @Translation("Auto Block Scheduler")
)

Hierarchy

Expanded class hierarchy of AutoBlockScheduler

File

src/Plugin/Condition/AutoBlockScheduler.php, line 21
Contains \Drupal\block_scheduler\Plugin\Condition\Expiry.

Namespace

Drupal\auto_block_scheduler\Plugin\Condition
View source 
class AutoBlockScheduler extends ConditionPluginBase {

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return t('Auto Block Scheduler');
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $default_start = !empty($this->configuration['published_on']) ? DrupalDateTime::createFromTimestamp($this->configuration['published_on']) : '';
    $default_end = !empty($this->configuration['unpublished_on']) ? DrupalDateTime::createFromTimestamp($this->configuration['unpublished_on']) : '';
    $form['published_on'] = [
      '#type' => 'datetime',
      '#title' => t('Published Date'),
      '#default_value' => $default_start,
      '#description' => $this
        ->t('If you select no Published Date, the condition will evaluate to TRUE for all requests.'),
      '#attached' => [
        'library' => [
          'auto_block_scheduler/drupal.auto_block_scheduler',
        ],
      ],
    ];
    $form['unpublished_on'] = [
      '#type' => 'datetime',
      '#title' => t('Unpublished Date'),
      '#default_value' => $default_end,
      '#description' => $this
        ->t('If you select no Unpublished Date, the condition will evaluate to TRUE for all requests.'),
    ];
    $form['#attached']['library'][] = 'auto_block_scheduler/drupal.auto_block_scheduler';
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    if (is_object($form_state
      ->getValue('published_on'))) {
      $this->configuration['published_on'] = $form_state
        ->getValue('published_on')
        ->getTimestamp();
    }
    else {
      $this->configuration['published_on'] = '';
    }
    if (is_object($form_state
      ->getValue('unpublished_on'))) {
      $this->configuration['unpublished_on'] = $form_state
        ->getValue('unpublished_on')
        ->getTimestamp();
    }
    else {
      $this->configuration['unpublished_on'] = '';
    }
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $status = TRUE;
    if (empty($this->configuration['published_on']) && empty($this->configuration['unpublished_on']) && !$this
      ->isNegated()) {
      return TRUE;
    }
    if (!empty($this->configuration['published_on'])) {
      $status = $status && time() >= $this->configuration['published_on'];
    }
    if (!empty($this->configuration['unpublished_on'])) {
      $status = $status && time() <= $this->configuration['unpublished_on'];
    }
    return $status;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'published_on' => '',
      'unpublished_on' => '',
    ] + parent::defaultConfiguration();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutoBlockScheduler::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
AutoBlockScheduler::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
AutoBlockScheduler::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
AutoBlockScheduler::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
AutoBlockScheduler::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
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 Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct 4
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.
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.
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