You are here

Home » API reference » Field Validation 8 » DateRangeFieldValidationRule.php

class DateRangeFieldValidationRule in Field Validation 8

DateRangeFieldValidationRule.

Plugin annotation


@FieldValidationRule(
  id = "date_range_field_validation_rule",
  label = @Translation("Date range"),
  description = @Translation("Validates user-entered text against a specified date range.")
)

Hierarchy

Expanded class hierarchy of DateRangeFieldValidationRule

File

src/Plugin/FieldValidationRule/DateRangeFieldValidationRule.php, line 18

Namespace

Drupal\field_validation\Plugin\FieldValidationRule
View source 
class DateRangeFieldValidationRule extends ConfigurableFieldValidationRuleBase {

  /**
   * {@inheritdoc}
   */
  public function addFieldValidationRule(FieldValidationRuleSetInterface $field_validation_rule_set) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'min' => NULL,
      'max' => NULL,
      'cycle' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['cycle'] = [
      '#title' => $this
        ->t('Cycle of date'),
      '#description' => $this
        ->t('Specify the cycle of date, support: global, year, month, week, day, hour, minute.'),
      '#type' => 'select',
      '#options' => [
        'global' => $this
          ->t('Global'),
        'year' => $this
          ->t('Year'),
        'month' => $this
          ->t('Month'),
        'week' => $this
          ->t('Week'),
        'day' => $this
          ->t('Day'),
        'hour' => $this
          ->t('Hour'),
        'minute' => $this
          ->t('Minute'),
      ],
      '#default_value' => $this->configuration['cycle'],
    ];
    $form['min'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum date'),
      '#description' => $this
        ->t('Optionally specify the minimum date.'),
      '#default_value' => $this->configuration['min'],
    ];
    $form['max'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum date'),
      '#description' => $this
        ->t('Optionally specify the maximum date.'),
      '#default_value' => $this->configuration['max'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['min'] = $form_state
      ->getValue('min');
    $this->configuration['max'] = $form_state
      ->getValue('max');
    $this->configuration['cycle'] = $form_state
      ->getValue('cycle');
  }
  public function validate($params) {
    $value = isset($params['value']) ? $params['value'] : '';
    $rule = isset($params['rule']) ? $params['rule'] : null;
    $context = isset($params['context']) ? $params['context'] : null;
    $settings = array();
    if (!empty($rule) && !empty($rule->configuration)) {
      $settings = $rule->configuration;
    }

    //$settings = $this->rule->settings;
    if ($value !== '' && !is_null($value)) {
      $flag = FALSE;

      //$settings =  $this->rule->settings;
      $cycle = isset($settings['cycle']) ? $settings['cycle'] : '';

      // support date, datetime
      if (!is_numeric($value)) {
        $value = strtotime($value);
      }
      $date_str = date("Y-m-d H:i:s", $value);
      if ($cycle == 'global') {
        if (!empty($settings['min'])) {

          //$settings['min'] = $settings['min'];
          $settings['min'] = strtotime($settings['min']);
          $settings['min'] = date("Y-m-d H:i:s", $settings['min']);
        }
        if (!empty($settings['max'])) {

          //$settings['max'] = strtr($settings['max'], $tokens);
          $settings['max'] = strtotime($settings['max']);
          $settings['max'] = date("Y-m-d H:i:s", $settings['max']);
          $str_place = 0;
        }
      }
      if ($cycle == 'year') {
        $str_place = 5;
        $date_str = substr($date_str, $str_place);
      }
      elseif ($cycle == 'month') {
        $str_place = 8;
        $date_str = substr($date_str, $str_place);
      }
      elseif ($cycle == 'week') {
        $str_place = 10;
        $week_day = date('w', strtotime($date_str));
        $date_str = substr($date_str, $str_place);
        $date_str = $week_day . $date_str;
      }
      elseif ($cycle == 'day') {
        $str_place = 11;
        $date_str = substr($date_str, $str_place);
      }
      elseif ($cycle == 'hour') {
        $str_place = 14;
        $date_str = substr($date_str, $str_place);
      }
      elseif ($cycle == 'minute') {
        $str_place = 17;
        $date_str = substr($date_str, $str_place);
      }
      if (!empty($settings['min']) && $date_str < substr($settings['min'], $str_place)) {
        $flag = TRUE;
      }
      if (!empty($settings['max']) && $date_str > substr($settings['max'], $str_place)) {
        $flag = TRUE;
      }
      if ($flag) {
        $context
          ->addViolation($rule
          ->getErrorMessage());
      }
    }

    //return true;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableFieldValidationRuleBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
DateRangeFieldValidationRule::addFieldValidationRule public function Applies a field_validation_rule to the field_validation_rule_set. Overrides FieldValidationRuleInterface::addFieldValidationRule
DateRangeFieldValidationRule::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
DateRangeFieldValidationRule::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldValidationRuleBase::defaultConfiguration
DateRangeFieldValidationRule::getSummary public function Returns a render array summarizing the configuration of the field_validation_rule. Overrides FieldValidationRuleBase::getSummary
DateRangeFieldValidationRule::submitConfigurationForm public function Form submission handler. Overrides ConfigurableFieldValidationRuleBase::submitConfigurationForm
DateRangeFieldValidationRule::validate public function Overrides FieldValidationRuleBase::validate
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
FieldValidationRuleBase::$column protected property The column of the FieldValidationRule.
FieldValidationRuleBase::$error_message protected property The error message of the FieldValidationRule.
FieldValidationRuleBase::$field_name protected property The field name of the FieldValidationRule.
FieldValidationRuleBase::$logger protected property A logger instance.
FieldValidationRuleBase::$title protected property The title of the FieldValidationRule.
FieldValidationRuleBase::$uuid protected property The FieldValidationRule ID.
FieldValidationRuleBase::$weight protected property The weight of the FieldValidationRule.
FieldValidationRuleBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FieldValidationRuleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldValidationRuleBase::getColumn public function Returns the column of the field_validation_rule. Overrides FieldValidationRuleInterface::getColumn
FieldValidationRuleBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldValidationRuleBase::getDerivativeExtension public function Returns the extension the derivative would have have after adding this field_validation_rule. Overrides FieldValidationRuleInterface::getDerivativeExtension
FieldValidationRuleBase::getErrorMessage public function Returns the error message of the field_validation_rule. Overrides FieldValidationRuleInterface::getErrorMessage
FieldValidationRuleBase::getFieldName public function Returns the field name of the field_validation_rule. Overrides FieldValidationRuleInterface::getFieldName
FieldValidationRuleBase::getTitle public function Returns the title of the field_validation_rule. Overrides FieldValidationRuleInterface::getTitle
FieldValidationRuleBase::getUuid public function Returns the unique ID representing the field_validation_rule. Overrides FieldValidationRuleInterface::getUuid
FieldValidationRuleBase::getWeight public function Returns the weight of the field_validation_rule. Overrides FieldValidationRuleInterface::getWeight
FieldValidationRuleBase::label public function Returns the field_validation_rule label. Overrides FieldValidationRuleInterface::label
FieldValidationRuleBase::setColumn public function Sets the column for this field_validation_rule. Overrides FieldValidationRuleInterface::setColumn
FieldValidationRuleBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldValidationRuleBase::setErrorMessage public function Sets the error message for this field_validation_rule. Overrides FieldValidationRuleInterface::setErrorMessage
FieldValidationRuleBase::setFieldName public function Sets the field name for this field_validation_rule. Overrides FieldValidationRuleInterface::setFieldName
FieldValidationRuleBase::setTitle public function Sets the title for this field_validation_rule. Overrides FieldValidationRuleInterface::setTitle
FieldValidationRuleBase::setWeight public function Sets the weight for this field_validation_rule. Overrides FieldValidationRuleInterface::setWeight
FieldValidationRuleBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.