You are here

Home » API reference » Search API 8 » SearchApiDate.php

class SearchApiDate in Search API 8

Same name in this branch
  1. 8 src/Plugin/views/filter/SearchApiDate.php \Drupal\search_api\Plugin\views\filter\SearchApiDate
  2. 8 src/Plugin/views/argument/SearchApiDate.php \Drupal\search_api\Plugin\views\argument\SearchApiDate
  3. 8 src/Plugin/views/field/SearchApiDate.php \Drupal\search_api\Plugin\views\field\SearchApiDate

Defines a contextual filter for conditions on date fields.

Plugin annotation

@ViewsArgument("search_api_date");

Hierarchy

Expanded class hierarchy of SearchApiDate

File

src/Plugin/views/argument/SearchApiDate.php, line 16

Namespace

Drupal\search_api\Plugin\views\argument
View source 
class SearchApiDate extends SearchApiStandard {

  /**
   * The date formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface|null
   */
  protected $dateFormatter;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $plugin */
    $plugin = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $plugin
      ->setDateFormatter($container
      ->get('date.formatter'));
    return $plugin;
  }

  /**
   * Retrieves the date formatter.
   *
   * @return \Drupal\Core\Datetime\DateFormatterInterface
   *   The date formatter.
   */
  public function getDateFormatter() {
    return $this->dateFormatter ?: \Drupal::service('date.formatter');
  }

  /**
   * Sets the date formatter.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The new date formatter.
   *
   * @return $this
   */
  public function setDateFormatter(DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function query($group_by = FALSE) {
    $this
      ->fillValue();
    if ($this->value === FALSE) {
      $this
        ->abort();
      return;
    }
    $outer_conjunction = strtoupper($this->operator);
    if (empty($this->options['not'])) {
      $condition_operator = '=';
      $inner_conjunction = 'OR';
    }
    else {
      $condition_operator = '<>';
      $inner_conjunction = 'AND';
    }
    if (!empty($this->value)) {
      $outer_conditions = $this->query
        ->createConditionGroup($outer_conjunction);

      // @todo Refactor to use only a single nested filter, and only if
      //   necessary. $value_conditions will currently only ever contain a
      //   single child – a condition or a nested filter with two conditions.
      foreach ($this->value as $value) {
        $value_conditions = $this->query
          ->createConditionGroup($inner_conjunction);
        $values = explode(';', $value);
        $values = array_map([
          $this,
          'getTimestamp',
        ], $values);
        if (in_array(FALSE, $values, TRUE)) {
          $this
            ->abort();
          return;
        }
        $is_range = count($values) > 1;
        $inner_conditions = $is_range ? $this->query
          ->createConditionGroup('AND') : $value_conditions;
        $range_op = empty($this->options['not']) ? '>=' : '<';
        $inner_conditions
          ->addCondition($this->realField, $values[0], $is_range ? $range_op : $condition_operator);
        if ($is_range) {
          $range_op = empty($this->options['not']) ? '<=' : '>';
          $inner_conditions
            ->addCondition($this->realField, $values[1], $range_op);
          $value_conditions
            ->addConditionGroup($inner_conditions);
        }
        $outer_conditions
          ->addConditionGroup($value_conditions);
      }
      $this->query
        ->addConditionGroup($outer_conditions);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function title() {
    if (!empty($this->argument)) {
      $this
        ->fillValue();
      $dates = [];
      foreach ($this->value as $date) {
        $date_parts = explode(';', $date);
        $ts = $this
          ->getTimestamp($date_parts[0]);
        $date_string = $this
          ->getDateFormatter()
          ->format($ts, 'short');
        if (count($date_parts) > 1) {
          $ts = $this
            ->getTimestamp($date_parts[1]);
          $date_string .= ' – ' . $this
            ->getDateFormatter()
            ->format($ts, 'short');
        }
        if ($date_string) {
          $dates[] = $date_string;
        }
      }
      return $dates ? implode(', ', $dates) : $this->argument;
    }
    return $this->argument;
  }

  /**
   * Converts a value to a timestamp, if it isn't one already.
   *
   * @param string|int $value
   *   The value to convert. Either a timestamp, or a date/time string as
   *   recognized by strtotime().
   *
   * @return int|false
   *   The parsed timestamp, or FALSE if an illegal string was passed.
   */
  protected function getTimestamp($value) {
    if (is_numeric($value)) {
      return (int) $value;
    }
    return strtotime($value);
  }

  /**
   * {@inheritdoc}
   */
  protected function unpackArgumentValue($force_int = FALSE) {

    // Set up the defaults.
    if (!isset($this->value)) {
      $this->value = [];
    }
    if (!isset($this->operator)) {
      $this->operator = 'or';
    }
    if (empty($this->argument)) {
      return;
    }
    if (preg_match('/^([-\\d;:\\s]+\\+)*[-\\d;:\\s]+$/', $this->argument)) {

      // The '+' character in a query string may be parsed as ' '.
      $this->value = explode('+', $this->argument);
    }
    elseif (preg_match('/^([-\\d;:\\s]+,)*[-\\d;:\\s]+$/', $this->argument)) {
      $this->operator = 'and';
      $this->value = explode(',', $this->argument);
    }

    // Keep an "error" value if invalid strings were given.
    if (!empty($this->argument) && (empty($this->value) || !is_array($this->value))) {
      $this->value = FALSE;
    }
  }

  /**
   * Aborts the associated query due to an illegal argument.
   *
   * @see \Drupal\search_api\Plugin\views\query\SearchApiQuery::abort()
   */
  protected function abort() {
    $variables['@field'] = $this->definition['group'] . ': ' . $this->definition['title'];
    $this->query
      ->abort(new FormattableMarkup('Illegal argument passed to @field contextual filter.', $variables));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentPluginBase::$argument public property
ArgumentPluginBase::$name_field public property The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed.
ArgumentPluginBase::$name_table public property The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator public property
ArgumentPluginBase::$value public property 1
ArgumentPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides HandlerBase::calculateDependencies
ArgumentPluginBase::decodeValidatorId public static function Revert sanitized validator options.
ArgumentPluginBase::defaultAccessDenied public function Default action: access denied.
ArgumentPluginBase::defaultAction public function Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::defaultArgumentForm public function Provide a form for selecting the default argument when the default action is set to provide default argument. 1
ArgumentPluginBase::defaultDefault protected function This just returns true. The view argument builder will know where to find the argument from.
ArgumentPluginBase::defaultEmpty public function Default action: empty
ArgumentPluginBase::defaultIgnore public function Default action: ignore.
ArgumentPluginBase::defaultNotFound protected function Default action: not found.
ArgumentPluginBase::defaultSummary protected function Default action: summary.
ArgumentPluginBase::defaultSummaryForm public function Provide a form for selecting further summary options when the default action is set to display one.
ArgumentPluginBase::encodeValidatorId public static function Sanitize validator options including derivatives with : for js.
ArgumentPluginBase::exceptionTitle public function
ArgumentPluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ArgumentPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ArgumentPluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ArgumentPluginBase::getContextDefinition public function Returns a context definition for this argument. 2
ArgumentPluginBase::getDefaultArgument public function Get a default argument, if available. 1
ArgumentPluginBase::getPlugin public function Get the display or row plugin, if it exists.
ArgumentPluginBase::getSortName public function Return a description of how the argument would normally be sorted. 5
ArgumentPluginBase::getTitle public function Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
ArgumentPluginBase::getTokenHelp protected function Provide token help information for the argument.
ArgumentPluginBase::getValue public function Get the value of this argument.
ArgumentPluginBase::hasDefaultArgument public function Determine if the argument is set to provide a default argument.
ArgumentPluginBase::init public function Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides HandlerBase::init 5
ArgumentPluginBase::isException public function
ArgumentPluginBase::needsStylePlugin public function Determine if the argument needs a style plugin.
ArgumentPluginBase::preRenderMoveArgumentOptions public static function Moves argument options into their place.
ArgumentPluginBase::processContainerRadios public static function Custom form radios process function.
ArgumentPluginBase::processSummaryArguments public function Process the summary arguments for display.
ArgumentPluginBase::setArgument public function Set the input for this argument
ArgumentPluginBase::summaryArgument public function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl(). 4
ArgumentPluginBase::summaryBasics public function Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery()
ArgumentPluginBase::summaryName public function Provides the name to use for the summary. By default this is just the name field. 8
ArgumentPluginBase::summaryNameField protected function Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
ArgumentPluginBase::summaryQuery protected function Build the info for the summary query. 3
ArgumentPluginBase::summarySort public function Sorts the summary based upon the user's selection. The base variant of this is usually adequate.
ArgumentPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
ArgumentPluginBase::validateArgument public function Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail public function How to act if validation fails.
ArgumentPluginBase::validateMenuArgument public function Called by the menu system to validate an argument.
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
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler protected property The module handler. 3
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 4
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::adminSummary public function Provide text for the administrative summary. Overrides ViewsHandlerInterface::adminSummary 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate 2
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 44
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
SearchApiDate::$dateFormatter protected property The date formatter.
SearchApiDate::abort protected function Aborts the associated query due to an illegal argument.
SearchApiDate::create public static function Creates an instance of the plugin. Overrides PluginBase::create
SearchApiDate::getDateFormatter public function Retrieves the date formatter.
SearchApiDate::getTimestamp protected function Converts a value to a timestamp, if it isn't one already.
SearchApiDate::query public function Set up the query for this argument. Overrides SearchApiStandard::query
SearchApiDate::setDateFormatter public function Sets the date formatter.
SearchApiDate::title public function Get the title this argument will assign the view, given the argument. Overrides ArgumentPluginBase::title
SearchApiDate::unpackArgumentValue protected function Splits an argument into value and operator properties on this instance. Overrides ArgumentPluginBase::unpackArgumentValue
SearchApiStandard::$operator public property The operator to use for multiple arguments.
SearchApiStandard::$query public property The Views query object used by this contextual filter. Overrides HandlerBase::$query 4
SearchApiStandard::buildOptionsForm public function Build the options form. Overrides ArgumentPluginBase::buildOptionsForm 2
SearchApiStandard::defaultActions public function Provide a list of default behaviors for this argument if the argument is not present. Overrides ArgumentPluginBase::defaultActions
SearchApiStandard::defineOptions public function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides ArgumentPluginBase::defineOptions 2
SearchApiStandard::fillValue protected function Fills $this->value and $this->operator with data from the argument.
SearchApiStandard::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides ArgumentPluginBase::submitOptionsForm
SearchApiStandard::validateOptionsForm public function Validate the options form. Overrides ArgumentPluginBase::validateOptionsForm
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.