/**
*
* @see FacetInterface::getFacet
*/
public function getFacet($fieldName, \Elastica\Filter\AbstractFilter $mainFilter)
{
$rawFieldName = $this->getRawFieldName($fieldName);
$mainFilter = $this->prepareMainFilter($mainFilter, $rawFieldName);
$facet = new \Elastica\Facet\Terms($fieldName);
$facet->setField($rawFieldName);
$facet->setSize($this->options['size']);
$facet->setFilter($mainFilter);
return $facet;
}
/**
* To respect the design, 3 searches will be executed:
* 1st: retrieves the main facet (Text / Media / Portfolio / Users / Group) and the count for each of them
* 2nd: - retrieves the results of the first non empty facet term for display in the tab
* - retrieves the secondary facet to enable / disable the filter items
* 3nd: - retrieves the results with all filters applied
* @param unknown $query_string
* @param unknown $limit
* @param unknown $offset
* @param unknown $options
* @param unknown $mainfacetterm
* @param unknown $USER
* @return multitype:number boolean unknown Ambigous <boolean, NULL> Ambigous <boolean, unknown> multitype:multitype:string number Ambigous <string, unknown> |multitype:multitype:
*/
public static function search($query_string, $limit, $offset, $options, $mainfacetterm, $USER)
{
$result = array('count' => 0, 'limit' => $limit, 'offset' => $offset, 'data' => false, 'selected' => isset($mainfacetterm) && strlen($mainfacetterm) > 0 ? $mainfacetterm : false, 'totalresults' => 0, 'facets' => array(array('term' => "Text", 'count' => 0, 'display' => "Text"), array('term' => "Media", 'count' => 0, 'display' => "Media"), array('term' => "Portfolio", 'count' => 0, 'display' => "Portfolio"), array('term' => "User", 'count' => 0, 'display' => "Users"), array('term' => "Group", 'count' => 0, 'display' => "Group")), 'content-filter' => array(array('term' => "all", 'count' => 0, 'display' => "All"), array('term' => "Audio", 'count' => 0, 'display' => "Audio"), array('term' => "Comment", 'count' => 0, 'display' => "Comment"), array('term' => "Document", 'count' => 0, 'display' => "Document"), array('term' => "Folder", 'count' => 0, 'display' => "Folder"), array('term' => "Forum", 'count' => 0, 'display' => "Forum"), array('term' => "Forumpost", 'count' => 0, 'display' => "Forum post"), array('term' => "Image", 'count' => 0, 'display' => "Image"), array('term' => "Journal", 'count' => 0, 'display' => "Journal"), array('term' => "Journalentry", 'count' => 0, 'display' => "Journal entry"), array('term' => "Note", 'count' => 0, 'display' => "Note"), array('term' => "Plan", 'count' => 0, 'display' => "Plan"), array('term' => "Profile", 'count' => 0, 'display' => "Profile"), array('term' => "Resume", 'count' => 0, 'display' => "Résumé"), array('term' => "Video", 'count' => 0, 'display' => "Video"), array('term' => "Wallpost", 'count' => 0, 'display' => "Wall post"), array('term' => "Collection", 'count' => 0, 'display' => "Collection"), array('term' => "Page", 'count' => 0, 'display' => "Page")), 'content-filter-selected' => isset($options['secfacetterm']) && strlen($options['secfacetterm']) > 0 ? $options['secfacetterm'] : 'all', 'owner-filter' => array(array('term' => "all", 'count' => 0, 'display' => "All"), array('term' => "me", 'count' => 0, 'display' => "Me"), array('term' => "others", 'count' => 0, 'display' => "Others")), 'owner-filter-selected' => isset($options['owner']) && strlen($options['owner']) > 0 ? $options['owner'] : 'all', 'tagsonly' => isset($options['tagsonly']) && $options['tagsonly'] == true ? true : Null, 'sort' => isset($options['sort']) && strlen($options['sort']) > 0 ? $options['sort'] : 'score', 'license' => isset($options['license']) && strlen($options['license']) > 0 ? $options['license'] : 'all');
if (strlen($query_string) <= 0) {
return $result;
}
// 1- Get main facet
// ------------------------------------------------------------------------------------------
$records = array();
$elasticaClient = PluginSearchElasticsearch::make_client();
$elasticaIndex = $elasticaClient->getIndex(get_config_plugin('search', 'elasticsearch', 'indexname'));
$elasticaQueryString = new \Elastica\Query\QueryString();
$elasticaAnalyzer = get_config_plugin('search', 'elasticsearch', 'analyzer');
$elasticaQueryString->setAnalyzer($elasticaAnalyzer);
$elasticaQueryString->setDefaultOperator('AND');
$elasticaQueryString->setQuery($query_string);
// if tags only => set fields to tags
if ($result['tagsonly'] === true) {
$elasticaQueryString->setFields(array('tags'));
}
// Create the $elasticaQuery object
$elasticaQuery = new \Elastica\Query();
$elasticaQuery->setFrom($offset);
$elasticaQuery->setLimit($limit);
$elasticaQuery->setQuery($elasticaQueryString);
$elasticaFilterAnd = new \Elastica\Filter\BoolAnd();
// Apply ACL filters
$elasticaFilterACL = new ElasticsearchFilterAcl($USER);
$elasticaFilterAnd->addFilter($elasticaFilterACL);
$elasticaQuery->setFilter($elasticaFilterAnd);
// Define a new facet: mainFacetTerm - WARNING: don't forget to apply the same filter to the facet
$elasticaFacet = new \Elastica\Facet\Terms('mainFacetTerm');
$elasticaFacet->setField('mainfacetterm');
$elasticaFacet->setOrder('count');
$elasticaFacet->setFilter($elasticaFilterAnd);
$elasticaQuery->addFacet($elasticaFacet);
$elasticaResultSet = $elasticaIndex->search($elasticaQuery);
$result['totalresults'] = $elasticaResultSet->getTotalHits();
$elasticaFacets = $elasticaResultSet->getFacets();
$facets = self::process_facets($elasticaFacets['mainFacetTerm']['terms']);
if (count($facets) == 0) {
return $result;
}
array_walk($result['facets'], 'self::process_tabs', $facets);
if ($result['selected'] === false || $facets[$result['selected']] == 0) {
$result['selected'] = self::get_selected_facet($result['facets']);
}
// 2- Retrieve results of selected facet
// ------------------------------------------------------------------------------------------
$elasticaFilterType = new \Elastica\Filter\Term(array('mainfacetterm' => $result['selected']));
$elasticaFilterAnd->addFilter($elasticaFilterType);
$elasticaQuery->setFilter($elasticaFilterAnd);
// Define a new facet: secFacetTerm - WARNING: don't forget to apply the same filter to the facet
$elasticaFacet = new \Elastica\Facet\Terms('secFacetTerm');
$elasticaFacet->setField('secfacetterm');
$elasticaFacet->setOrder('count');
$elasticaFacet->setFilter($elasticaFilterAnd);
$elasticaQuery->addFacet($elasticaFacet);
// Sorting
// Sorting is defined on a per field level, so we must make sure the field exists in the mapping
$sort = explode('_', $result['sort']);
if ($sort[0] == 'score') {
$sort[0] = '_score';
}
// set the second column to sort by the score (to break any 'ties').
$elasticaQuery->setSort(array(array($sort[0] => array('order' => isset($sort[1]) ? $sort[1] : 'desc')), array('_score' => array('order' => 'desc'))));
$elasticaResultSet = $elasticaIndex->search($elasticaQuery);
$result['count'] = $elasticaResultSet->getTotalHits();
$elasticaFacets = $elasticaResultSet->getFacets();
$facets = $elasticaFacets['secFacetTerm']['terms'];
$facets = self::process_facets($elasticaFacets['secFacetTerm']['terms']);
array_walk($result['content-filter'], 'self::process_tabs', $facets);
// set the count of "all" to the total hits
$result['content-filter'][0]['count'] = $result['count'];
// 3- Apply filters and retrieve final results
// ------------------------------------------------------------------------------------------
// Apply Content filter if different from "all"
if ($result['content-filter-selected'] != 'all') {
$elasticaFilterContent = new \Elastica\Filter\Term(array('secfacetterm' => $result['content-filter-selected']));
$elasticaFilterAnd->addFilter($elasticaFilterContent);
}
// Apply Owner filter if different from "all"
if ($result['owner-filter-selected'] != 'all') {
$uid = $USER->get('id');
$elasticaFilterOwner = new \Elastica\Filter\Term(array('owner' => $uid));
if ($result['owner-filter-selected'] == 'others') {
$elasticaFilterOwner = new \Elastica\Filter\BoolNot($elasticaFilterOwner);
}
$elasticaFilterAnd->addFilter($elasticaFilterOwner);
}
// Apply license filter if different from "all"
if ($result['license'] != 'all') {
$elasticaFilterLicense = new \Elastica\Filter\Term(array('license' => $result['license']));
$elasticaFilterAnd->addFilter($elasticaFilterLicense);
}
$elasticaQuery->setFilter($elasticaFilterAnd);
$elasticaResultSet = $elasticaIndex->search($elasticaQuery);
$elasticaResults = $elasticaResultSet->getResults();
$result['count'] = $elasticaResultSet->getTotalHits();
foreach ($elasticaResults as $elasticaResult) {
$tmp = array();
$tmp['type'] = $elasticaResult->getType();
$ES_class = 'ElasticsearchType_' . $tmp['type'];
$tmp = $tmp + $elasticaResult->getData();
// Get all the data from the DB table
$dbrec = $ES_class::getRecordDataById($tmp['type'], $tmp['id']);
if ($dbrec) {
$tmp['db'] = $dbrec;
$tmp['db']->deleted = false;
} else {
// If the record has been deleted, so just pass the cached data
// from the search result. Let the template decide how to handle
// it.
$tmp['db'] = (object) $tmp;
$tmp['db']->deleted = true;
}
$records[] = $tmp;
}
$result['data'] = $records;
return $result;
}
/**
*
* Add facets on elastic query object
* @param \Elastica\Query $query
* @param array $options
* @param \Elastica\Filter\AbstractFilter $mainFilter
*/
protected function addFacets(\Elastica\Query $query, $options = array(), \Elastica\Filter\AbstractFilter $mainFilter = null)
{
// module facet (note: would be less confusing to give another name instead of _type)
if (!empty($options['apply_module_facet'])) {
$typeFacet = new \Elastica\Facet\Terms('_type');
$typeFacet->setField('_type');
// need to add filter for facet too
if (isset($mainFilter)) {
$typeFacet->setFilter($mainFilter);
}
$query->addFacet($typeFacet);
}
// handle secondary facets
$this->facetHandler->addFacets($query, $options, $mainFilter);
}
