[7588] | 1 | <?php |
---|
| 2 | /** |
---|
| 3 | * Copyright 2011 Bas de Nooijer. All rights reserved. |
---|
| 4 | * |
---|
| 5 | * Redistribution and use in source and binary forms, with or without |
---|
| 6 | * modification, are permitted provided that the following conditions are met: |
---|
| 7 | * |
---|
| 8 | * 1. Redistributions of source code must retain the above copyright notice, |
---|
| 9 | * this list of conditions and the following disclaimer. |
---|
| 10 | * |
---|
| 11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
---|
| 12 | * this listof conditions and the following disclaimer in the documentation |
---|
| 13 | * and/or other materials provided with the distribution. |
---|
| 14 | * |
---|
| 15 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" |
---|
| 16 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
| 17 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
| 18 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
---|
| 19 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
| 20 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
| 21 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
| 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
| 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
| 24 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
| 25 | * POSSIBILITY OF SUCH DAMAGE. |
---|
| 26 | * |
---|
| 27 | * The views and conclusions contained in the software and documentation are |
---|
| 28 | * those of the authors and should not be interpreted as representing official |
---|
| 29 | * policies, either expressed or implied, of the copyright holder. |
---|
| 30 | * |
---|
| 31 | * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl> |
---|
| 32 | * @license http://github.com/basdenooijer/solarium/raw/master/COPYING |
---|
| 33 | * @link http://www.solarium-project.org/ |
---|
| 34 | * |
---|
| 35 | * @package Solarium |
---|
| 36 | * @subpackage Client |
---|
| 37 | */ |
---|
| 38 | |
---|
| 39 | /** |
---|
| 40 | * Add select component Highlighting to the request |
---|
| 41 | * |
---|
| 42 | * @package Solarium |
---|
| 43 | * @subpackage Client |
---|
| 44 | */ |
---|
| 45 | class Solarium_Client_RequestBuilder_Select_Component_Highlighting |
---|
| 46 | { |
---|
| 47 | |
---|
| 48 | /** |
---|
| 49 | * Add request settings for Highlighting |
---|
| 50 | * |
---|
| 51 | * @param Solarium_Query_Select_Component_Highlighting $component |
---|
| 52 | * @param Solarium_Client_Request $request |
---|
| 53 | * @return Solarium_Client_Request |
---|
| 54 | */ |
---|
| 55 | public function buildComponent( |
---|
| 56 | Solarium_Query_Select_Component_Highlighting $component, |
---|
| 57 | Solarium_Client_Request $request) |
---|
| 58 | { |
---|
| 59 | // enable highlighting |
---|
| 60 | $request->addParam('hl', 'true'); |
---|
| 61 | |
---|
| 62 | // set global highlighting params |
---|
| 63 | $request->addParam('hl.fl', implode(',', array_keys($component->getFields()))); |
---|
| 64 | $request->addParam('hl.snippets', $component->getSnippets()); |
---|
| 65 | $request->addParam('hl.fragsize', $component->getFragSize()); |
---|
| 66 | $request->addParam('hl.mergeContiguous', $component->getMergeContiguous()); |
---|
| 67 | $request->addParam('hl.requireFieldMatch', $component->getRequireFieldMatch()); |
---|
| 68 | $request->addParam('hl.maxAnalyzedChars', $component->getMaxAnalyzedChars()); |
---|
| 69 | $request->addParam('hl.alternateField', $component->getAlternateField()); |
---|
| 70 | $request->addParam('hl.maxAlternateFieldLength', $component->getMaxAlternateFieldLength()); |
---|
| 71 | $request->addParam('hl.formatter', $component->getFormatter()); |
---|
| 72 | $request->addParam('hl.simple.pre', $component->getSimplePrefix()); |
---|
| 73 | $request->addParam('hl.simple.post', $component->getSimplePostfix()); |
---|
| 74 | $request->addParam('hl.fragmenter', $component->getFragmenter()); |
---|
| 75 | $request->addParam('hl.fragListBuilder', $component->getFragListBuilder()); |
---|
| 76 | $request->addParam('hl.fragmentsBuilder', $component->getFragmentsBuilder()); |
---|
| 77 | $request->addParam('hl.useFastVectorHighlighter', $component->getUseFastVectorHighlighter()); |
---|
| 78 | $request->addParam('hl.usePhraseHighlighter', $component->getUsePhraseHighlighter()); |
---|
| 79 | $request->addParam('hl.highlightMultiTerm', $component->getHighlightMultiTerm()); |
---|
| 80 | $request->addParam('hl.regex.slop', $component->getRegexSlop()); |
---|
| 81 | $request->addParam('hl.regex.pattern', $component->getRegexPattern()); |
---|
| 82 | $request->addParam('hl.regex.maxAnalyzedChars', $component->getRegexMaxAnalyzedChars()); |
---|
| 83 | $request->addParam('hl.q', $component->getQuery()); |
---|
| 84 | $request->addParam('hl.phraseLimit', $component->getPhraseLimit()); |
---|
| 85 | |
---|
| 86 | // set per-field highlighting params |
---|
| 87 | foreach ($component->getFields() as $field) { |
---|
| 88 | $this->_addFieldParams($field, $request); |
---|
| 89 | } |
---|
| 90 | |
---|
| 91 | return $request; |
---|
| 92 | } |
---|
| 93 | |
---|
| 94 | /** |
---|
| 95 | * Add per-field override options to the request |
---|
| 96 | * |
---|
| 97 | * @param Solarium_Query_Select_Component_Highlighting_Field $field |
---|
| 98 | * @param Solarium_Client_Request $request |
---|
| 99 | * @return void |
---|
| 100 | */ |
---|
| 101 | protected function _addFieldParams($field, $request) |
---|
| 102 | { |
---|
| 103 | $prefix = 'f.' . $field->getName() . '.hl.'; |
---|
| 104 | $request->addParam($prefix.'snippets', $field->getSnippets()); |
---|
| 105 | $request->addParam($prefix.'fragsize', $field->getFragSize()); |
---|
| 106 | $request->addParam($prefix.'mergeContiguous', $field->getMergeContiguous()); |
---|
| 107 | $request->addParam($prefix.'alternateField', $field->getAlternateField()); |
---|
| 108 | $request->addParam($prefix.'formatter', $field->getFormatter()); |
---|
| 109 | $request->addParam($prefix.'simple.pre', $field->getSimplePrefix()); |
---|
| 110 | $request->addParam($prefix.'simple.post', $field->getSimplePostfix()); |
---|
| 111 | $request->addParam($prefix.'fragmenter', $field->getFragmenter()); |
---|
| 112 | $request->addParam($prefix.'useFastVectorHighlighter', $field->getUseFastVectorHighlighter()); |
---|
| 113 | } |
---|
| 114 | |
---|
| 115 | } |
---|