ElasticaSearchHelperInterface

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Test Coverage

Coverage

0%

5 Methods

Rating	Name	Duplication	Size	Complexity
	augmentQuery()	0	1	?
	updateFilters()	0	1	?
	updateAggregation()	0	1	?
	getIndexFieldTitleMapping()	0	1	?
	getDefaultSort()	0	1	?

<?php

interface ElasticaSearchHelperInterface {
	/**
	 * Alter the query or add to it, perhaps for example adding aggregation
	 * @param  Elastic\Query &$query query object from Elastica
	 * @return [type]         [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

	 */
	public function augmentQuery(&$query);

	/**
	 * Update filters, perhaps remaps them, prior to performing a search.
	 * This allows for aggregation values to be updated prior to rendering.
	 * @param  array &$filters array of key/value pairs for query filtering
	 */
	public function updateFilters(&$filters);

	/**
	 * Manipulate the array of aggregations post search butprior to rendering
	 * them in a template.
	 * @param  [type] &$aggs [description]
	 * @return [type]        [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

	 */
	public function updateAggregation(&$aggs);


	/**
	 * Get a mapping from indexed field name to human readable title
	 * @return array array of index field name to human readable title
	 */
	public function getIndexFieldTitleMapping();


	/**
	 * In the event of using aggregates and no query provided, sort by this
	 * @return array Mapping of field name to sort order (asc,desc)
	 */
	public function getDefaultSort();
}