1	<?php
2
3	namespace CirrusSearch\Search\Fetch;
4
5	interface HighlightFieldGenerator {
6	/**
7	* @param string $name
8	* @param string $target
9	* @param string $pattern
10	* @param bool $caseInsensitive
11	* @param int $priority
12	* @param string $regexFlavor
13	* @return BaseHighlightedField
14	* @see HighlightFieldGenerator::supportsRegexFields()
15	*/
16	public function newRegexField(
17	$name,
18	$target,
19	$pattern,
20	$caseInsensitive,
21	$priority = HighlightedField::COSTLY_EXPERT_SYNTAX_PRIORITY,
22	$regexFlavor = 'lucene'
23	): BaseHighlightedField;
24
25	/**
26	* @return bool true if regex fields are supported
27	*/
28	public function supportsRegexFields();
29
30	/**
31	* @param string $name
32	* @param string $target
33	* @param int $priority
34	* @return BaseHighlightedField
35	*/
36	public function newHighlightField(
37	$name,
38	$target,
39	$priority = HighlightedField::DEFAULT_TARGET_PRIORITY
40	): BaseHighlightedField;
41	}