Current File : /home/jvzmxxx/wiki/extensions/Wikibase/repo/includes/Search/Elastic/Fields/SearchIndexField.php

<?php

namespace Wikibase\Repo\Search\Elastic\Fields;

use Wikibase\DataModel\Entity\EntityDocument;

/**
 * Each field is intended to be used by CirrusSearch as an
 * additional property of a page.
 *
 * The data returned by the field must match the field
 * type defined in the mapping. (e.g. nested must be array,
 * integer field must get an int, etc)
 *
 * @since 0.5
 *
 * @license GPL-2.0+
 * @author Katie Filbert < aude.wiki@gmail.com >
 */
interface SearchIndexField {

	/**
	 * @return array The field mapping defines attributes of the field,
	 *               such as the field type (e.g. "string", "long", "nested")
	 *               and other attributes like "not_analyzed".
	 *
	 *               For detailed documentation about mapping of fields, see:
	 *               https://www.elastic.co/guide/en/elasticsearch/guide/current/mapping-intro.html
	 */
	public function getMapping();

	/**
	 * @param EntityDocument $entity
	 *
	 * @return mixed Get the value of the field to be indexed when a page/document
	 *               is indexed. This might be an array with nested data, if the field
	 *               is defined with nested type or an int or string for simple field types.
	 */
	public function getFieldData( EntityDocument $entity );

}