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	* @return BaseHighlightedField
13	* @see HighlightFieldGenerator::supportsRegexFields()
14	*/
15	public function newRegexField(
16	$name,
17	$target,
18	$pattern,
19	$caseInsensitive,
20	$priority = HighlightedField::COSTLY_EXPERT_SYNTAX_PRIORITY
21	): BaseHighlightedField;
22
23	/**
24	* @return bool true if regex fields are supported
25	*/
26	public function supportsRegexFields();
27
28	/**
29	* @param string $name
30	* @param string $target
31	* @param int $priority
32	* @return BaseHighlightedField
33	*/
34	public function newHighlightField(
35	$name,
36	$target,
37	$priority = HighlightedField::DEFAULT_TARGET_PRIORITY
38	): BaseHighlightedField;
39	}