solrsearch: plugins/facetapi/adapter.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 * @file
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	5 * Classes used by the Facet API module.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	6 */
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 * Facet API adapter for the Apache Solr Search Integration module.
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 solrsearchFacetapiAdapter extends FacetapiAdapter {
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 * Returns the path to the admin settings for a given realm.
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 * @param string $realm_name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	17 * The name of the realm.
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 * @return string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	20 * The path to the admin settings.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	21 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	22 public function getPath($realm_name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	23 $path = 'admin/config/search/solrsearch/settings';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	24 // $adapter will be an instance of class FacetapiAdapter
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	25 if ($adapter = menu_get_object('facetapi_adapter', 4)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	26 // Get the environment ID from the machine name of the searcher.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	27 $env_id = ltrim(strstr($adapter->getSearcher(), '@'), '@');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	28 $path .= '/' . $env_id . '/facets';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	29 // Add the realm name to the path if it is not the first one in the list.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	30 if (key(facetapi_get_realm_info()) != $realm_name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	31 $path .= '/' . $realm_name;
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 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	34 return $path;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	35 }
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	38 * Allows the backend to initialize its query object before adding the facet
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	39 * filters.
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 * @param mixed $query
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	42 * The backend's native object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	43 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	44 function initActiveFilters($query) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	45 $enabled_facets = facetapi_get_enabled_facets($this->info['name']);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	46 if ($enabled_facets) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	47 $query->addParam('facet', 'true');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	48 $query->addParam('facet.sort', 'count');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	49 $query->addParam('facet.mincount', '1');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	50 }
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
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 * Returns a boolean flagging whether $this->_searcher executed a search.
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 public function searchExecuted() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	57 // Initial check - has ANY solr query run in our environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	58 $env_id = $this->info['instance'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	59 $this_has_searched = solrsearch_has_searched($env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	60 // Secondary check - do we have results for this searcher?
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	61 $this_has_searched = $this_has_searched && solrsearch_static_response_cache($this->getSearcher());
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	62 return $this_has_searched;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	63 }
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 * Suppress output of the realm
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 * @param string $realm_name
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	69 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	70 * @return bool $flag
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	71 * Returns if it was suppressed or not
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	72 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	73 public function suppressOutput($realm_name) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	74 $flag = FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	75 //dpm("suppressoutput");
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	76 if ($realm_name == 'block') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	77 //dpm($this->info);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	78 $env_id = $this->info['instance'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	79 $flag = solrsearch_suppress_blocks($env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	80 //dpm($env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	81 //dpm($flag);
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 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	84 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	85 return $flag \|\| !$this->searchExecuted(); }
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	88 * Returns the search keys.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	89 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	90 * @return string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	91 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	92 public function getSearchKeys() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	93 if (NULL === $this->keys) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	94 $env_id = $this->info['instance'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	95 if ($query = solrsearch_current_query($env_id)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	96 return $query->getParam('q');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	97 }
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 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	100 return $this->keys;
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 return FALSE;
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
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	105 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	106 * Returns the search path.
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 string
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	109 * A string containing the search path.
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 * @todo D8 should provide an API function for this.
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 getSearchPath() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	114 $env_id = $this->info['instance'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	115 $query = solrsearch_current_query($env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	116 if (!$query \|\| (NULL === $this->searchPath && NULL === $query->getPath())) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	117 if ($path = module_invoke($this->info['module'] . '_search', 'search_info')) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	118 $this->searchPath = 'search/' . $path['path'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	119 if (!isset($_GET['keys']) && ($keys = $this->getSearchKeys())) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	120 $this->searchPath .= '/' . $keys;
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 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	124 if (!$query \|\| NULL === $query->getPath()) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	125 return $this->searchPath;
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 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	128 return $query->getPath();
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
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 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	134 * Returns the number of total results found for the current search.
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 * @return bool\|int
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	137 * Number of results or false if no search response was found
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	138 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	139 public function getResultCount() {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	140 $response = solrsearch_static_response_cache($this->getSearcher());
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	141 if ($response) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	142 return $response->response->numFound;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	143 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	144 return FALSE;
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
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 * Allows for backend specific overrides to the settings form.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	149 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	150 * @param array $form
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	151 * @param array $form_state
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	152 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	153 public function settingsForm(&$form, &$form_state) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	154 $form['#validate'][] = 'solrsearch_facet_form_validate';
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
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 * Allows the backend to add facet queries to its native query object.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	160 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	161 * This method is called by the implementing module to initialize the facet
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	162 * display process. The following actions are taken:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	163 * - FacetapiAdapter::initActiveFilters() hook is invoked.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	164 * - Dependency plugins are instantiated and executed.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	165 * - Query type plugins are executed.
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 * @param mixed $query
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	168 * The backend's native query object.
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 * @todo Should this method be deprecated in favor of one name init()? This
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	171 * might make the code more readable in implementing modules.
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 * @see FacetapiAdapter::initActiveFilters()
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 function addActiveFilters($query) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	176 module_load_include('inc', 'solrsearch', 'facetapi.callbacks');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	177 facetapi_add_active_searcher($this->info['name']);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	178
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	179 // Invoke initActiveFilters hook.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	180 $this->initActiveFilters($query);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	181
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 foreach ($this->getEnabledFacets() as $facet) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	184
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	185 $settings = $this->getFacet($facet)->getSettings();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	186
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	187 // Instantiate and execute dependency plugins.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	188 $display = TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	189 foreach ($facet['dependency plugins'] as $id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	190 $class = ctools_plugin_load_class('facetapi', 'dependencies', $id, 'handler');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	191 $plugin = new $class($id, $this, $facet, $settings, $this->activeItems['facet']);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	192 if (NULL !== ($return = $plugin->execute())) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	193 $display = $return;
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
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	197 // Store whether this facet passed its dependencies.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	198 $this->dependenciesPassed[$facet['name']] = $display;
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 // Execute query type plugin if dependencies were met, otherwise remove
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	201 // the facet's active items so they don't display in the current search
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	202 // block or appear as active in the breadcrumb trail.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	203 if ($display && $this->queryTypes[$facet['name']]) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	204 $this->queryTypes[$facet['name']]->execute($query);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	205 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	206 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	207 foreach ($this->activeItems['facet'][$facet['name']] as $item) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	208 $this->urlProcessor->removeParam($item['pos']);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	209 $filter = $item['field alias'] . ':' . $item['value'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	210 unset($this->activeItems['filter'][$filter]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	211 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	212 $this->activeItems['facet'][$facet['name']] = array();
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 }
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 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	217 }

0

a2b4f67e73dc initial