1 | <?php |
||
10 | abstract class FacetHandler implements Handler |
||
11 | { |
||
12 | /** |
||
13 | * @var Closure |
||
14 | */ |
||
15 | private $legacyKernel; |
||
16 | |||
17 | /** |
||
18 | * @param Closure $legacyKernel |
||
19 | */ |
||
20 | public function setLegacyKernel(Closure $legacyKernel) |
||
24 | |||
25 | /** |
||
26 | * Check if this facet handler accepts to handle the given facet builder. |
||
27 | * |
||
28 | * @param FacetBuilder $facetBuilder |
||
29 | * |
||
30 | * @return bool |
||
31 | */ |
||
32 | abstract public function accept(FacetBuilder $facetBuilder); |
||
33 | |||
34 | /** |
||
35 | * Map facet builder value to a proper SOLR representation. |
||
36 | * |
||
37 | * @param FacetBuilder $facetBuilder |
||
38 | * |
||
39 | * @return array |
||
40 | */ |
||
41 | abstract public function handle(FacetBuilder $facetBuilder); |
||
42 | |||
43 | /** |
||
44 | * Create new facet value based on eZFind facet results. |
||
45 | * |
||
46 | * @param FacetBuilder $facetBuilder |
||
47 | * @param array $fields |
||
48 | * @param array $queries |
||
49 | * @param array $dates |
||
50 | * @param array $ranges |
||
51 | * |
||
52 | * @return Facet |
||
53 | */ |
||
54 | abstract public function createFacetResult(FacetBuilder $facetBuilder, $fields = [], $queries = [], $dates = [], $ranges = []); |
||
55 | |||
56 | /** |
||
57 | * Get eZ Legacy kernel. |
||
58 | * |
||
59 | * @return ezpKernel |
||
60 | */ |
||
61 | protected function getLegacyKernel() |
||
66 | |||
67 | /** |
||
68 | * Build base facet based on FacetBuilder parent class. |
||
69 | * |
||
70 | * @param FacetBuilder $facetBuilder |
||
71 | * |
||
72 | * @return array |
||
73 | */ |
||
74 | protected function buildFacet(FacetBuilder $facetBuilder) |
||
84 | |||
85 | /** |
||
86 | * Get SOLR field name based on a name which may either be a |
||
87 | * meta-data name, or an eZ Publish content class attribute, specified by |
||
88 | * <class identifier>/<attribute identifier>[/<option>] |
||
89 | * |
||
90 | * @param string $baseName |
||
91 | * |
||
92 | * @return string |
||
93 | */ |
||
94 | protected function getSolrFieldName($baseName) |
||
103 | |||
104 | /** |
||
105 | * Get facet key returned by SOLR. |
||
106 | * |
||
107 | * @param FacetBuilder $facetBuilder |
||
108 | * |
||
109 | * @return string |
||
110 | */ |
||
111 | protected function getFacetKey(FacetBuilder $facetBuilder) |
||
115 | } |
||
116 |