solrsearch: Solr_Base_Query.php annotate

author	Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de>
date	Mon, 08 Jun 2015 10:21:54 +0200
parents
children

rev	line source
0 a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	1 <?php
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	2 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	3 * This class allows you to make operations on a query that will be sent to
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	4 * Apache Solr. methods such as adding and removing sorts, remove and replace
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	5 * parameters, adding and removing filters, getters and setters for various
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	6 * parameters and more
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	7 * @file
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	8 * Class that defines the base query for the Apache Solr Drupal module.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	9 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	10
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	11 class SolrFilterSubQuery {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	12
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	13 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	14 * Static shared by all instances, used to increment ID numbers.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	15 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	16 protected static $idCount = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	17
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	18 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	19 * Each query/subquery will have a unique ID.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	20 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	21 public $id;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	22 public $operator;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	23
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	24 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	25 * A keyed array where the key is a position integer and the value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	26 * is an array with #name and #value properties. Each value is a
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	27 * used for filter queries, e.g. array('#name' => 'is_uid', '#value' => 0)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	28 * for anonymous content.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	29 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	30 protected $fields = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	31
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	32 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	33 * An array of subqueries.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	34 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	35 protected $subqueries = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	36
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	37 function __construct($operator = 'OR') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	38 $this->operator = $operator;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	39 $this->id = ++SolrFilterSubQuery::$idCount;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	40 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	41
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	42 function __clone() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	43 $this->id = ++SolrFilterSubQuery::$idCount;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	44 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	45
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	46 public function getFilters($name = NULL) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	47 if (empty($name)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	48 return $this->fields;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	49 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	50 reset($this->fields);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	51 $matches = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	52 foreach ($this->fields as $filter) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	53 if ($filter['#name'] == $name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	54 $matches[] = $filter;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	55 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	56 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	57 return $matches;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	58 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	59
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	60 public function hasFilter($name, $value, $exclude = FALSE) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	61 foreach ($this->fields as $pos => $values) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	62 if ($values['#name'] == $name && $values['#value'] == $value && $values['#exclude'] == $exclude) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	63 return TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	64 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	65 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	66 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	67 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	68
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	69 public function addFilter($name, $value, $exclude = FALSE, $local = '') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	70 // @todo - escape the value if it has spaces in it and is not a range query or parenthesized.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	71 $filter = array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	72 '#exclude' => (bool) $exclude,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	73 '#name' => trim($name),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	74 '#value' => trim($value),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	75 '#local' => trim($local),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	76 );
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	77 $this->fields[] = $filter;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	78 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	79 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	80
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	81 public function removeFilter($name, $value = NULL, $exclude = FALSE) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	82 // Remove from the public list of filters.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	83 $this->unsetFilter($this->fields, $name, $value, $exclude);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	84 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	85 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	86
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	87 protected function unsetFilter(&$fields, $name, $value, $exclude) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	88 if (!isset($value)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	89 foreach ($fields as $pos => $values) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	90 if ($values['#name'] == $name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	91 unset($fields[$pos]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	92 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	93 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	94 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	95 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	96 foreach ($fields as $pos => $values) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	97 if ($values['#name'] == $name && $values['#value'] == $value && $values['#exclude'] == $exclude) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	98 unset($fields[$pos]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	99 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	100 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	101 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	102 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	103
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	104 public function getFilterSubQueries() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	105 return $this->subqueries;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	106 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	107
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	108 public function addFilterSubQuery(SolrFilterSubQuery $query) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	109 $this->subqueries[$query->id] = $query;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	110 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	111 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	112
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	113 public function removeFilterSubQuery(SolrFilterSubQuery $query) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	114 unset($this->subqueries[$query->id]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	115 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	116 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	117
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	118 public function removeFilterSubQueries() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	119 $this->subqueries = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	120 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	121 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	122
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	123 public function makeFilterQuery(array $filter) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	124 $prefix = empty($filter['#exclude']) ? '' : '-';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	125 if ($filter['#local']) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	126 $prefix = '{!' . $filter['#local'] . '}' . $prefix;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	127 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	128 // If the field value contains a colon or a space, wrap it in double quotes,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	129 // unless it is a range query or is already wrapped in double quotes or
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	130 // parentheses.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	131 if (preg_match('/[ :]/', $filter['#value']) && !preg_match('/^[\[\{]\S+ TO \S+[\]\}]$/', $filter['#value']) && !preg_match('/^["\(].*["\)]$/', $filter['#value'])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	132 $filter['#value'] = '"' . $filter['#value'] . '"';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	133 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	134 return $prefix . $filter['#name'] . ':' . $filter['#value'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	135 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	136
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	137 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	138 * Make sure our query matches the pattern name:value or name:"value"
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	139 * Make sure that if we are ranges we use name:[ AND ]
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	140 * allowed inputs :
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	141 * a. bundle:article
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	142 * b. date:[1970-12-31T23:59:59Z TO NOW]
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	143 * Split the text in 4 different parts
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	144 * 1. name, eg.: bundle or date
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	145 * 2. The first opening bracket (or nothing), eg.: [
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	146 * 3. The value of the field, eg. article or 1970-12-31T23:59:59Z TO NOW
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	147 * 4. The last closing bracket, eg.: ]
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	148 * @param string $filter
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	149 * The filter to validate
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	150 * @return boolean
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	151 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	152 public static function validFilterValue($filter) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	153 $opening = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	154 $closing = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	155 $name = NULL;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	156 $value = NULL;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	157
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	158 if (preg_match('/(?P<name>[^:]+):(?P<value>.+)?$/', $filter, $matches)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	159 foreach ($matches as $match_id => $match) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	160 switch($match_id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	161 case 'name' :
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	162 $name = $match;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	163 break;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	164 case 'value' :
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	165 $value = $match;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	166 break;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	167 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	168 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	169
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	170 // For the name we allow any character that fits between the A-Z0-9 range and
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	171 // any alternative for this in other languages. No special characters allowed
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	172 if (!preg_match('/^[a-zA-Z0-9_\x7f-\xff]+$/', $name)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	173 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	174 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	175
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	176 // For the value we allow anything that is UTF8
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	177 if (!drupal_validate_utf8($value)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	178 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	179 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	180
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	181 // Check our bracket count. If it does not match it is also not valid
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	182 $valid_brackets = TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	183 $brackets['opening']['{'] = substr_count($value, '{');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	184 $brackets['closing']['}'] = substr_count($value, '}');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	185 $valid_brackets = ($brackets['opening']['{'] != $brackets['closing']['}']) ? FALSE : TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	186 $brackets['opening']['['] = substr_count($value, '[');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	187 $brackets['closing'][']'] = substr_count($value, ']');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	188 $valid_brackets = ($brackets['opening']['['] != $brackets['closing'][']']) ? FALSE : TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	189 $brackets['opening']['('] = substr_count($value, '(');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	190 $brackets['closing'][')'] = substr_count($value, ')');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	191 $valid_brackets = ($brackets['opening']['('] != $brackets['closing'][')']) ? FALSE : TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	192 if (!$valid_brackets) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	193 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	194 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	195
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	196 // Check the date field inputs
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	197 if (preg_match('/\[(.+) TO (.+)\]$/', $value, $datefields)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	198 // Only Allow a value in the form of
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	199 // http://lucene.apache.org/solr/api/org/apache/solr/schema/DateField.html
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	200 // http://lucene.apache.org/solr/api/org/apache/solr/util/DateMathParser.html
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	201 // http://wiki.apache.org/solr/SolrQuerySyntax
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	202 // 1976-03-06T23:59:59.999Z (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	203 // * (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	204 // 1995-12-31T23:59:59.999Z (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	205 // 2007-03-06T00:00:00Z (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	206 // NOW-1YEAR/DAY (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	207 // NOW/DAY+1DAY (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	208 // 1976-03-06T23:59:59.999Z (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	209 // 1976-03-06T23:59:59.999Z+1YEAR (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	210 // 1976-03-06T23:59:59.999Z/YEAR (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	211 // 1976-03-06T23:59:59.999Z (valid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	212 // 1976-03-06T23::59::59.999Z (invalid)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	213 if (!empty($datefields[1]) && !empty($datefields[2])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	214 // Do not check to full value, only the splitted ones
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	215 unset($datefields[0]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	216 // Check if both matches are valid datefields
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	217 foreach ($datefields as $datefield) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	218 if (!preg_match('/(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:[\d\.]{2,6}Z(\S))\|(^([A-Z\]+)(\A-Z0-9\+\-\/)*)/', $datefield, $datefield_match)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	219 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	220 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	221 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	222 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	223 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	224 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	225 return TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	226 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	227
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	228 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	229 * Builds a set of filter queries from $this->fields and all subqueries.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	230 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	231 * Returns an array of strings that can be combined into
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	232 * a URL query parameter or passed to Solr as fq paramters.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	233 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	234 protected function rebuildFq() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	235 $fq = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	236 foreach ($this->fields as $pos => $field) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	237 $fq[] = $this->makeFilterQuery($field);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	238 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	239 foreach ($this->subqueries as $subquery) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	240 $subfq = $subquery->rebuildFq();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	241 if ($subfq) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	242 $operator = $subquery->operator;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	243 $fq[] = "(" . implode(" $operator ", $subfq) . ")";
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	244 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	245 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	246 return $fq;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	247 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	248
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	249 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	250
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	251 class SolrBaseQuery extends SolrFilterSubQuery implements DrupalSolrQueryInterface {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	252
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	253 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	254 * The parameters that get sent to Solr.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	255 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	256 protected $params = array('start' => 0, 'rows' => 10, 'fq' => array());
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	257
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	258 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	259 * The search base path.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	260 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	261 protected $base_path;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	262 protected $field_map = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	263
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	264 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	265 * DrupalApacheSolrService object
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	266 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	267 protected $solr;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	268 // The array keys must always be real Solr index fields.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	269 protected $available_sorts;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	270
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	271 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	272 * The query name is used to construct a searcher string. Mostly the
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	273 * environment id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	274 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	275 protected $name;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	276 protected $context = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	277 // Makes sure we always have a valid sort.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	278 protected $solrsort = array('#name' => 'score', '#direction' => 'desc');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	279 // A flag to allow the search to be aborted.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	280 public $abort_search = FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	281
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	282 // A flag to check if need to retrieve another page of the result set
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	283 public $page = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	284
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	285 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	286 * @param $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	287 * The search name, used for finding the correct blocks and other config.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	288 * Typically "apachesolr".
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	289 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	290 * @param $solr
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	291 * An instantiated DrupalApacheSolrService Object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	292 * Can be instantiated from apachesolr_get_solr().
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	293 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	294 * @param $params
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	295 * Array of params to initialize the object (typically 'q' and 'fq').
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	296 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	297 * @param $sortstring
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	298 * Visible string telling solr how to sort - added to GET query params.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	299 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	300 * @param $base_path
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	301 * The search base path (without the keywords) for this query, without trailing slash.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	302 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	303 function __construct($name, $solr, array $params = array(), $sortstring = '', $base_path = '', $context = array()) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	304 parent::__construct();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	305 $this->name = $name;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	306 $this->solr = $solr;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	307 $this->addContext((array) $context);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	308 $this->addParams((array) $params);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	309 $this->available_sorts = $this->defaultSorts();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	310 $this->sortstring = trim($sortstring);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	311 $this->parseSortString();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	312 $this->base_path = $base_path;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	313 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	314
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	315 protected function defaultSorts() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	316 return array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	317 'score' => array('title' => t('Relevancy'), 'default' => 'desc'),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	318 'title' => array('title' => t('Title'), 'default' => 'asc'),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	319 'author_s' => array('title' => t('Author'), 'default' => 'asc'),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	320 'date' => array('title' => t('Date'), 'default' => 'desc'),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	321 );
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	322 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	323
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	324 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	325 * Get query name.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	326 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	327 public function getName() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	328 return $this->name;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	329 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	330
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	331 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	332 * Get query searcher name (for facetapi, views, pages, etc).
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	333 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	334 public function getSearcher() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	335 return $this->name . '@' . $this->solr->getId();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	336 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	337
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	338 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	339 * Get context values.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	340 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	341 public function getContext() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	342 return $this->context;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	343 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	344
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	345 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	346 * Set context value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	347 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	348 public function addContext(array $context) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	349 foreach ($context as $k => $v) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	350 $this->context[$k] = $v;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	351 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	352 // The env_id must match that of the actual $solr object
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	353 $this->context['env_id'] = $this->solr->getId();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	354 return $this->context;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	355 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	356
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	357 protected $single_value_params = array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	358 'q' => TRUE, // http://wiki.apache.org/solr/SearchHandler#q
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	359 'q.op' => TRUE, // http://wiki.apache.org/solr/SearchHandler#q.op
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	360 'q.alt' => TRUE, // http://wiki.apache.org/solr/SearchHandler#q
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	361 'df' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	362 'qt' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	363 'defType' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	364 'timeAllowed' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	365 'omitHeader' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	366 'debugQuery' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	367 'start' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	368 'rows' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	369 'stats' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	370 'facet' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	371 'facet.prefix' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	372 'facet.limit' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	373 'facet.offset' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	374 'facet.mincount' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	375 'facet.missing' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	376 'facet.method' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	377 'facet.enum.cache.minDf' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	378 'facet.date.start' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	379 'facet.date.end' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	380 'facet.date.gap' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	381 'facet.date.hardend' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	382 'facet.date.other' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	383 'facet.date.include' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	384 'hl' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	385 'hl.snippets' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	386 'hl.fragsize' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	387 'hl.mergeContiguous' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	388 'hl.requireFieldMatch' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	389 'hl.maxAnalyzedChars' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	390 'hl.alternateField' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	391 'hl.maxAlternateFieldLength' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	392 'hl.formatter' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	393 'hl.simple.pre/hl.simple.post' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	394 'hl.fragmenter' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	395 'hl.fragListBuilder' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	396 'hl.fragmentsBuilder' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	397 'hl.useFastVectorHighlighter' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	398 'hl.usePhraseHighlighter' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	399 'hl.highlightMultiTerm' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	400 'hl.regex.slop' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	401 'hl.regex.pattern' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	402 'hl.regex.maxAnalyzedChars' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	403 'spellcheck' => TRUE,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	404 );
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	405
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	406 public function getParam($name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	407 if ($name == 'fq') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	408 return $this->rebuildFq();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	409 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	410 $empty = isset($this->single_value_params[$name]) ? NULL : array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	411 return isset($this->params[$name]) ? $this->params[$name] : $empty;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	412 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	413
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	414 public function getParams() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	415 $params = $this->params;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	416 $params['fq'] = $this->rebuildFq();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	417 return $params;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	418 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	419
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	420 public function getSolrParams() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	421 $params = $this->getParams();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	422 // For certain fields Solr prefers a comma separated list.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	423 foreach (array('fl', 'hl.fl', 'sort', 'mlt.fl') as $name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	424 if (isset($params[$name])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	425 $params[$name] = implode(',', $params[$name]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	426 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	427 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	428 return $params;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	429 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	430
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	431 protected function addFq($string, $index = NULL) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	432 $string = trim($string);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	433 $local = '';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	434 $exclude = FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	435 $name = NULL;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	436 $value = NULL;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	437
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	438 // Check if we are dealing with an exclude
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	439 if (preg_match('/^-(.*)/', $string, $matches)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	440 $exclude = TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	441 $string = $matches[1];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	442 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	443
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	444 // If {!something} is found as first character then this is a local value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	445 if (preg_match('/\{!([^}]+)\}(.*)/', $string, $matches)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	446 $local = $matches[1];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	447 $string = $matches[2];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	448 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	449
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	450 // Anything that has a name and value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	451 // check if we have a : in the string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	452 if (strstr($string, ':')) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	453 list($name, $value) = explode(":", $string, 2);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	454 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	455 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	456 $value = $string;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	457 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	458 $this->addFilter($name, $value, $exclude, $local);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	459 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	460 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	461
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	462 public function addParam($name, $value) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	463 if (isset($this->single_value_params[$name])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	464 if (is_array($value)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	465 $value = end($value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	466 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	467 $this->params[$name] = $this->normalizeParamValue($value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	468 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	469 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	470 // We never actually populate $this->params['fq']. Instead
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	471 // we manage everything via the filter methods.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	472 if ($name == 'fq') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	473 if (is_array($value)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	474 array_walk_recursive($value, array($this, 'addFq'));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	475 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	476 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	477 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	478 return $this->addFq($value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	479 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	480 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	481
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	482 if (!isset($this->params[$name])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	483 $this->params[$name] = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	484 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	485
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	486 if (!is_array($value)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	487 // Convert to array for array_map.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	488 $param_values = array($value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	489 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	490 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	491 // Convert to a numerically keyed array.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	492 $param_values = array_values($value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	493 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	494 $this->params[$name] = array_merge($this->params[$name], array_map(array($this, 'normalizeParamValue'), $param_values));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	495
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	496 return $this;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	497 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	498
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	499 protected function normalizeParamValue($value) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	500 // Convert boolean to string.

0

a2b4f67e73dc initial