123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352 |
- <?php
- /**
- * @file
- * Date query type plugin for the Search API adapter.
- */
- /**
- * Plugin for "date" query types.
- */
- class SearchApiFacetapiDate extends SearchApiFacetapiTerm implements FacetapiQueryTypeInterface {
- /**
- * Loads the include file containing the date API functions.
- */
- public function __construct(FacetapiAdapter $adapter, array $facet) {
- module_load_include('date.inc', 'facetapi');
- parent::__construct($adapter, $facet);
- }
- /**
- * Returns the query type associated with the plugin.
- *
- * @return string
- * The query type.
- */
- static public function getType() {
- return 'date';
- }
- /**
- * Adds the filter to the query object.
- *
- * @param $query
- * An object containing the query in the backend's native API.
- */
- public function execute($query) {
- // Return terms for this facet.
- $this->adapter->addFacet($this->facet, $query);
- $settings = $this->adapter->getFacet($this->facet)->getSettings()->settings;
- // First check if the facet is enabled for this search.
- $default_true = isset($settings['default_true']) ? $settings['default_true'] : TRUE;
- $facet_search_ids = isset($settings['facet_search_ids']) ? $settings['facet_search_ids'] : array();
- if ($default_true != empty($facet_search_ids[$query->getOption('search id')])) {
- // Facet is not enabled for this search ID.
- return;
- }
- // Change limit to "unlimited" (-1).
- $options = &$query->getOptions();
- if (!empty($options['search_api_facets'][$this->facet['name']])) {
- $options['search_api_facets'][$this->facet['name']]['limit'] = -1;
- }
- if ($active = $this->adapter->getActiveItems($this->facet)) {
- $item = end($active);
- $field = $this->facet['field'];
- $filter = $this->createRangeFilter($item['value']);
- if ($filter) {
- $this->addFacetFilter($query, $field, $filter);
- }
- }
- }
- /**
- * Rewrites the handler-specific date range syntax to the normal facet syntax.
- *
- * @param string $value
- * The user-facing facet value.
- *
- * @return string|null
- * A facet to add as a filter, in the format used internally in this module.
- * Or NULL if the raw facet in $value is not valid.
- */
- protected function createRangeFilter($value) {
- // Ignore any filters passed directly from the server (range or missing).
- if (!$value || $value == '!' || (!ctype_digit($value[0]) && preg_match('/^[\[(][^ ]+ TO [^ ]+[\])]$/', $value))) {
- return $value ? $value : NULL;
- }
- // Parse into date parts.
- $parts = $this->parseRangeFilter($value);
- // Return NULL if the date parts are invalid or none were found.
- if (empty($parts)) {
- return NULL;
- }
- $date = new DateTime();
- switch (count($parts)) {
- case 1:
- $date->setDate($parts[0], 1, 1);
- $date->setTime(0, 0, 0);
- $lower = $date->format('U');
- $date->setDate($parts[0] + 1, 1, 1);
- $date->setTime(0, 0, -1);
- $upper = $date->format('U');
- break;
- case 2:
- // Luckily, $month = 13 is treated as January of next year. (The same
- // goes for all other parameters.) We use the inverse trick for the
- // seconds of the upper bound, since that's inclusive and we want to
- // stop at a second before the next segment starts.
- $date->setDate($parts[0], $parts[1], 1);
- $date->setTime(0, 0, 0);
- $lower = $date->format('U');
- $date->setDate($parts[0], $parts[1] + 1, 1);
- $date->setTime(0, 0, -1);
- $upper = $date->format('U');
- break;
- case 3:
- $date->setDate($parts[0], $parts[1], $parts[2]);
- $date->setTime(0, 0, 0);
- $lower = $date->format('U');
- $date->setDate($parts[0], $parts[1], $parts[2] + 1);
- $date->setTime(0, 0, -1);
- $upper = $date->format('U');
- break;
- case 4:
- $date->setDate($parts[0], $parts[1], $parts[2]);
- $date->setTime($parts[3], 0, 0);
- $lower = $date->format('U');
- $date->setTime($parts[3] + 1, 0, -1);
- $upper = $date->format('U');
- break;
- case 5:
- $date->setDate($parts[0], $parts[1], $parts[2]);
- $date->setTime($parts[3], $parts[4], 0);
- $lower = $date->format('U');
- $date->setTime($parts[3], $parts[4] + 1, -1);
- $upper = $date->format('U');
- break;
- case 6:
- $date->setDate($parts[0], $parts[1], $parts[2]);
- $date->setTime($parts[3], $parts[4], $parts[5]);
- return $date->format('U');
- default:
- return $value;
- }
- return "[$lower TO $upper]";
- }
- /**
- * Parses the date range filter value into parts.
- *
- * @param string $value
- * The user-facing facet value.
- *
- * @return int[]|null
- * An array of date parts, or NULL if an invalid value was provided.
- */
- protected static function parseRangeFilter($value) {
- $parts = explode('-', $value);
- foreach ($parts as $i => $part) {
- // Invalidate if part is not an integer.
- if ($part === '' || !is_numeric($part) || intval($part) != $part) {
- return NULL;
- }
- $parts[$i] = (int) $part;
- // Depending on the position, negative numbers or 0 are invalid.
- switch ($i) {
- case 0:
- // Years can contain anything – negative values are unlikely, but
- // technically possible.
- break;
- case 1:
- case 2:
- // Days and months have to be positive.
- if ($part <= 0) {
- return NULL;
- }
- break;
- default:
- // All others can be 0, but not negative.
- if ($part < 0) {
- return NULL;
- }
- }
- }
- return $parts;
- }
- /**
- * Replacement callback for replacing ISO dates with timestamps.
- *
- * Not used anymore, but kept for backwards compatibility with potential
- * subclasses.
- */
- public function replaceDateString($matches) {
- return strtotime($matches[0]);
- }
- /**
- * Initializes the facet's build array.
- *
- * @return array
- * The initialized render array.
- */
- public function build() {
- $facet = $this->adapter->getFacet($this->facet);
- $search_ids = drupal_static('search_api_facetapi_active_facets', array());
- $facet_key = $facet['name'] . '@' . $this->adapter->getSearcher();
- if (empty($search_ids[$facet_key]) || !search_api_current_search($search_ids[$facet_key])) {
- return array();
- }
- $search_id = $search_ids[$facet_key];
- $build = array();
- $search = search_api_current_search($search_id);
- $results = $search[1];
- // Gets total number of documents matched in search.
- $total = $results['result count'];
- // Executes query, iterates over results.
- if (isset($results['search_api_facets']) && isset($results['search_api_facets'][$this->facet['name']])) {
- $values = $results['search_api_facets'][$this->facet['name']];
- foreach ($values as $value) {
- if ($value['count']) {
- $filter = $value['filter'];
- // We only process single values further. The "missing" filter and
- // range filters will be passed on unchanged.
- if ($filter == '!') {
- $build[$filter]['#count'] = $value['count'];
- }
- elseif ($filter[0] == '"') {
- $filter = substr($value['filter'], 1, -1);
- if ($filter) {
- $raw_values[$filter] = $value['count'];
- }
- }
- else {
- $build[$filter]['#count'] = $value['count'];
- }
- }
- }
- }
- $settings = $facet->getSettings()->settings;
- // Get the finest level of detail we're allowed to drill down to.
- $max_granularity = FACETAPI_DATE_MINUTE;
- if (isset($settings['date_granularity'])) {
- $max_granularity = $settings['date_granularity'];
- }
- // Get the coarsest level of detail we're allowed to start at.
- $min_granularity = FACETAPI_DATE_YEAR;
- if (isset($settings['date_granularity_min'])) {
- $min_granularity = $settings['date_granularity_min'];
- }
- // Gets active facets, starts building hierarchy.
- $parent = $granularity = NULL;
- $active_items = $this->adapter->getActiveItems($this->facet);
- foreach ($active_items as $value => $item) {
- // If the item is active, the count is the result set count.
- $build[$value] = array('#count' => $total);
- // Gets next "gap" increment. Ignore any filters passed directly from the
- // server (range or missing). We always create filters starting with a
- // year.
- $value = "$value";
- if (!$value || !ctype_digit($value[0])) {
- continue;
- }
- $granularity = search_api_facetapi_date_get_granularity($value);
- if (!$granularity) {
- continue;
- }
- $granularity = facetapi_get_next_date_gap($granularity, $max_granularity);
- // If there is a previous item, there is a parent, uses a reference so the
- // arrays are populated when they are updated.
- if (NULL !== $parent) {
- $build[$parent]['#item_children'][$value] = &$build[$value];
- $build[$value]['#item_parents'][$parent] = $parent;
- }
- // Stores the last value iterated over.
- $parent = $value;
- }
- if (empty($raw_values)) {
- return $build;
- }
- ksort($raw_values);
- // Mind the gap! Calculates gap from min and max timestamps.
- $timestamps = array_keys($raw_values);
- if (NULL === $parent) {
- if (count($raw_values) > 1) {
- $granularity = facetapi_get_timestamp_gap(min($timestamps), max($timestamps), $max_granularity);
- // Array of numbers used to determine whether the next gap is smaller than
- // the minimum gap allowed in the drilldown.
- $gap_numbers = array(
- FACETAPI_DATE_YEAR => 6,
- FACETAPI_DATE_MONTH => 5,
- FACETAPI_DATE_DAY => 4,
- FACETAPI_DATE_HOUR => 3,
- FACETAPI_DATE_MINUTE => 2,
- FACETAPI_DATE_SECOND => 1,
- );
- // Gets gap numbers for both the gap, minimum and maximum gap, checks if
- // the gap is within the limit set by the $granularity parameters.
- if ($gap_numbers[$granularity] < $gap_numbers[$max_granularity]) {
- $granularity = $max_granularity;
- }
- if ($gap_numbers[$granularity] > $gap_numbers[$min_granularity]) {
- $granularity = $min_granularity;
- }
- }
- else {
- $granularity = $max_granularity;
- }
- }
- // Groups dates by the range they belong to, builds the $build array with
- // the facet counts and formatted range values.
- $format = search_api_facetapi_date_get_granularity_format($granularity);
- foreach ($raw_values as $value => $count) {
- $new_value = date($format, $value);
- if (!isset($build[$new_value])) {
- $build[$new_value] = array('#count' => $count);
- }
- // Active items already have their value set because it's the current
- // result count.
- elseif (!isset($active_items[$new_value])) {
- $build[$new_value]['#count'] += $count;
- }
- // Adds parent information if not already set.
- if (NULL !== $parent && $parent != $new_value) {
- $build[$parent]['#item_children'][$new_value] = &$build[$new_value];
- $build[$new_value]['#item_parents'][$parent] = $parent;
- }
- }
- return $build;
- }
- }
|