solrsearch: solrsearch.interface.inc 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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	4 * The interface for all 'query' objects.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	5 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	6 interface DrupalSolrQueryInterface {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	7
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	8 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	9 * Get query name.
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 function getName();
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 * Get query searcher name (for facetapi, views, pages, etc).
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 function getSearcher();
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 * Get context values.
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 function getContext();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	22
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 * Set context value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	25 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	26 function addContext(array $context);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	27
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	28 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	29 * Returns all filters matching $name, if set; otherwise, returns all filters.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	30 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	31 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	32 * The facet field name to match. If NULL, all filters will be returned.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	33 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	34 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	35 * All matching filters.
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 getFilters($name = NULL);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	38
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	39 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	40 * Tests whether a filter is already present in the query.
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 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	43 * The facet field name to check.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	44 * @param string $value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	45 * The facet value to check.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	46 * @param boolean $exclude
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	47 * Optional, defaults to FALSE, must match the filter.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	48 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	49 * @return boolean
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	50 * TRUE or FALSE.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	51 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	52 function hasFilter($name, $value, $exclude = FALSE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	53
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	54 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	55 * Adds a filter to the query.
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 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	58 * The facet field name.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	59 * @param string $value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	60 * The facet field value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	61 * @param boolean $exclude
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	62 * Set to TRUE to filter out documents matching $value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	63 * @param string $local
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	64 * Solr LocalParams.
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 DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	67 * The called object.
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 function addFilter($name, $value, $exclude = FALSE, $local = '');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	70
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	71 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	72 * Removes a filter from the query.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	73 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	74 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	75 * The name of the facet field to remove.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	76 * @param string $value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	77 * The value of the facet field to remove. If NULL, all filters matching
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	78 * $name are removed.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	79 * @param boolean $exclude
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	80 * If $value is not NULL, only filters matching both $value and $exclude are
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	81 * removed. Ignored if $value is NULL.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	82 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	83 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	84 * The called object.
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 function removeFilter($name, $value = NULL, $exclude = FALSE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	87
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	88 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	89 * Returns all subqueries to the query.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	90 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	91 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	92 * All subqueries to the query.
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 function getFilterSubQueries();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	95
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	96 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	97 * Adds a subquery to the query.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	98 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	99 * @param SolrFilterSubQuery $query
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	100 * The query to add to the orginal query - may have keywords or filters.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	101 * @param string $fq_operator
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	102 * The operator to use within the filter part of the subquery
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	103 * @param string $q_operator
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	104 * The operator to use in joining the subquery to the main keywords. Note:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	105 * this is unlikely to work with the Dismax handler when the main query is
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	106 * only keywords.
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 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	109 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	110 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	111 function addFilterSubQuery(SolrFilterSubQuery $query);
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	114 * Removes a specific subquery.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	115 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	116 * @param DrupalSolrQueryInterface $query
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	117 * The query to remove.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	118 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	119 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	120 * The called object.
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 function removeFilterSubQuery(SolrFilterSubQuery $query);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	123
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	124 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	125 * Removes all subqueries.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	126 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	127 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	128 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	129 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	130 function removeFilterSubQueries();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	131
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	132 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	133 * Transforms a single filter in a form suitable for use in a Solr query.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	134 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	135 * @param array $filter
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	136 * A filter as an array with the keys '#name', for the facet field name,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	137 * '#value', for the facet field value, '#local', for Solr LocalParams, and
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	138 '#exclude' set to TRUE if it is an exclusion filter.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	139 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	140 * @return string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	141 * A Solr fq parameter value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	142 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	143 function makeFilterQuery(array $filter);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	144
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	145 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	146 * Gets the value of a parameter.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	147 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	148 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	149 * The parameter name.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	150 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	151 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	152 * The value of the parameter.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	153 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	154 function getParam($name);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	155
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	156 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	157 * Gets all parameters in normalized form.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	158 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	159 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	160 * All parameters as key-value pairs.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	161 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	162 function getParams();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	163
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	164 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	165 * Gets parameters in a form suitable for use in a Solr query.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	166 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	167 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	168 * All parameters as key-value pairs, where values have been transformed
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	169 * into Solr parameter values.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	170 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	171 function getSolrParams();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	172
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	173 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	174 * Adds a param to be sent when running the Solr search.
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 * If the param is single-valued, this will replace rather than add the value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	177 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	178 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	179 * A Solr param name, e.g. 'q' or 'fl'.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	180 * @param $value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	181 * A Solr param value: an array of values, or a string for a single value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	182 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	183 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	184 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	185 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	186 function addParam($name, $value);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	187
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	188 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	189 * Adds multiple params to be sent when running the Solr search.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	190 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	191 * If the param is single-valued, this will replace rather than add the value.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	192 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	193 * @param $params
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	194 * An array where the keys are param names, and the values may be strings or
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	195 * arrays of strings.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	196 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	197 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	198 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	199 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	200 function addParams(array $params);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	201
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	202 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	203 * Removes all values for one Solr param.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	204 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	205 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	206 * A Solr param name, e.g. 'q' or 'fl'.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	207 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	208 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	209 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	210 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	211 function removeParam($name);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	212
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	213 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	214 * Replaces a param to be sent when running the Solr search.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	215 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	216 * Basically a shortcut for removeParam() plus addParam().
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	217 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	218 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	219 * A Solr param name, e.g. 'q' or 'fl'.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	220 * @param $value
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	221 * A Solr param value: an array of values, or a string for a single value.
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 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	224 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	225 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	226 function replaceParam($name, $value);
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 * Handles aliases for field to make nicer URLs.
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 * @param $field_map
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	232 * An array keyed with real Solr index field names with the alias as value.
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 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	235 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	236 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	237 function addFieldAliases($field_map);
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 function getFieldAliases();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	240
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	241 function clearFieldAliases();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	242
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	243 function getAvailableSorts();
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 * Adds an available sort.
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 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	249 * The name of the field in the Solr index to sort on.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	250 * @param array $sort
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	251 * An array with the keys 'title', for the human name of the sort, and
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	252 * 'default', for the default sort direction ('asc' or 'desc').
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 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	255 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	256 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	257 function setAvailableSort($name, $sort);
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	260 * Removes an available sort.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	261 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	262 * @param string $name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	263 * The name of the field in the Solr index to sort on.
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 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	266 * The called object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	267 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	268 function removeAvailableSort($name);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	269
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 * Gets the current sort.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	272 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	273 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	274 * The current sort as an array with the keys '#name', for the name of
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	275 * the field, and '#direction', for the sort direction ('asc' or 'desc').
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	276 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	277 function getSolrsort();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	278
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	279 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	280 * Sets the sort.
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 * @param string $field
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	283 * The name of the field in the Solr index to sort on.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	284 * @param string $direction
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	285 * 'asc' or 'desc'
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	286 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	287 * @return DrupalSolrQueryInterface
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	288 * The called object.
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 function setSolrsort($name, $direction);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	291
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	292 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	293 * Returns an array representing the URL query string for the current sort.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	294 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	295 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	296 * The URL query string for the current sort.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	297 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	298 function getSolrsortUrlQuery();
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	301 * Returns the search path (including the search keywords).
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 * @param string $new_keywords
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	304 * Optional. When set, this string overrides the query's current keywords.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	305 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	306 * @return string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	307 * The search path.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	308 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	309 function getPath($new_keywords = NULL);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	310
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	311 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	312 * Sends the search request to Solr, unless $query->abort_search is TRUE.
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 * @param string $keys
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	315 * The search keys.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	316 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	317 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	318 * A stdClass response object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	319 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	320 function search($keys = NULL);
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 * Calls a method, without arguments, on the Solr object with which the query
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	324 * object was initialized.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	325 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	326 * @param string $method
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	327 * The method to call on the Solr object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	328 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	329 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	330 * Any method return.
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 function solr($method);
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
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	335 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	336 * The interface for all 'Service' objects.
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 interface DrupalApacheSolrServiceInterface {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	339 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	340 * Call the /admin/ping servlet, to test the connection to the server.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	341 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	342 * @param $timeout
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	343 * maximum time to wait for ping in seconds, -1 for unlimited (default 2).
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	344 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	345 * (float) seconds taken to ping the server, FALSE if timeout occurs.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	346 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	347 function ping($timeout = 2);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	348
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	349 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	350 * Get information about the Solr Core.
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 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	353 * (string) system info encoded in json
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	354 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	355 function getSystemInfo();
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	358 * Get just the field meta-data about the index.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	359 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	360 function getFields($num_terms = 0);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	361
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	362 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	363 * Get meta-data about the index.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	364 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	365 function getLuke($num_terms = 0);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	366
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	367 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	368 * Get information about the Solr Core.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	369 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	370 * Returns a Simple XMl document
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	371 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	372 function getStats();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	373
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	374 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	375 * Get summary information about the Solr Core.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	376 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	377 function getStatsSummary();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	378
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	379 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	380 * Clear cached Solr data.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	381 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	382 function clearCache();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	383
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	384 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	385 * Constructor
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	386 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	387 * @param $url
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	388 * The URL to the Solr server, possibly including a core name. E.g. http://localhost:8983/solr/
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	389 * or https://search.example.com/solr/core99/
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	390 * @param $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	391 * The machine name of a corresponding saved configuration used for loading
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	392 * data like which facets are enabled.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	393 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	394 function __construct($url, $env_id = NULL);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	395
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	396 function getId();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	397
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	398 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	399 * Make a request to a servlet (a path) that's not a standard path.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	400 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	401 * @param string $servlet
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	402 * A path to be added to the base Solr path. e.g. 'extract/tika'
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	403 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	404 * @param array $params
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	405 * Any request parameters when constructing the URL.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	406 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	407 * @param array $options
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	408 * @see drupal_http_request() $options.
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 * @return
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	411 * response object
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 * @thows Exception
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	414 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	415 function makeServletRequest($servlet, $params = array(), $options = array());
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	416
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	417 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	418 * Get the Solr url
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 * @return string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	421 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	422 function getUrl();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	423
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	424 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	425 * Set the Solr url.
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 * @param $url
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	428 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	429 * @return $this
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 function setUrl($url);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	432
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	433 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	434 * Raw update Method. Takes a raw post body and sends it to the update service. Post body
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	435 * should be a complete and well formed xml document.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	436 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	437 * @param string $rawPost
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	438 * @param float $timeout Maximum expected duration (in seconds)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	439 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	440 * @return response object
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	441 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	442 * @throws Exception If an error occurs during the service call
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 function update($rawPost, $timeout = FALSE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	445
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	446 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	447 * Add an array of Solr Documents to the index all at once
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 * @param array $documents Should be an array of ApacheSolrDocument instances
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	450 * @param boolean $allowDups
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	451 * @param boolean $overwritePending
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	452 * @param boolean $overwriteCommitted
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	453 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	454 * @return response objecte
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	455 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	456 * @throws Exception If an error occurs during the service call
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 function addDocuments($documents, $overwrite = NULL, $commitWithin = NULL);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	459
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 * Send a commit command. Will be synchronous unless both wait parameters are set to false.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	462 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	463 * @param boolean $optimize Defaults to true
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	464 * @param boolean $waitFlush Defaults to true
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	465 * @param boolean $waitSearcher Defaults to true
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	466 * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	467 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	468 * @return response object
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 * @throws Exception If an error occurs during the service call
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	471 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	472 function commit($optimize = TRUE, $waitFlush = TRUE, $waitSearcher = TRUE, $timeout = 3600);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	473
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	474 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	475 * Create a delete document based on document ID
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 * @param string $id Expected to be utf-8 encoded
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	478 * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)
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 * @return response object
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 * @throws Exception If an error occurs during the service call
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	483 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	484 function deleteById($id, $timeout = 3600);
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	487 * Create and post a delete document based on multiple document IDs.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	488 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	489 * @param array $ids Expected to be utf-8 encoded strings
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	490 * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	491 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	492 * @return response object
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 * @throws Exception If an error occurs during the service call
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 function deleteByMultipleIds($ids, $timeout = 3600);
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 * Create a delete document based on a query and submit it
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	500 *

0

a2b4f67e73dc initial