[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 Query |
---|
| 37 | */ |
---|
| 38 | |
---|
| 39 | /** |
---|
| 40 | * Analysis document query |
---|
| 41 | * |
---|
| 42 | * @package Solarium |
---|
| 43 | * @subpackage Query |
---|
| 44 | */ |
---|
| 45 | class Solarium_Query_Analysis_Field extends Solarium_Query_Analysis |
---|
| 46 | { |
---|
| 47 | |
---|
| 48 | /** |
---|
| 49 | * Default options |
---|
| 50 | * |
---|
| 51 | * @var array |
---|
| 52 | */ |
---|
| 53 | protected $_options = array( |
---|
| 54 | 'handler' => 'analysis/field', |
---|
| 55 | 'resultclass' => 'Solarium_Result_Analysis_Field', |
---|
| 56 | ); |
---|
| 57 | |
---|
| 58 | /** |
---|
| 59 | * Get type for this query |
---|
| 60 | * |
---|
| 61 | * @return string |
---|
| 62 | */ |
---|
| 63 | public function getType() |
---|
| 64 | { |
---|
| 65 | return Solarium_Client::QUERYTYPE_ANALYSIS_FIELD; |
---|
| 66 | } |
---|
| 67 | |
---|
| 68 | /** |
---|
| 69 | * Set the field value option |
---|
| 70 | * |
---|
| 71 | * The text that will be analyzed. The analysis will mimic the index-time analysis. |
---|
| 72 | * |
---|
| 73 | * @param string $value |
---|
| 74 | * @return Solarium_Query_Analysis_Field Provides fluent interface |
---|
| 75 | */ |
---|
| 76 | public function setFieldValue($value) |
---|
| 77 | { |
---|
| 78 | return $this->_setOption('fieldvalue', $value); |
---|
| 79 | } |
---|
| 80 | |
---|
| 81 | /** |
---|
| 82 | * Get the field value option |
---|
| 83 | * |
---|
| 84 | * @return string |
---|
| 85 | */ |
---|
| 86 | public function getFieldValue() |
---|
| 87 | { |
---|
| 88 | return $this->getOption('fieldvalue'); |
---|
| 89 | } |
---|
| 90 | |
---|
| 91 | /** |
---|
| 92 | * Set the field type option |
---|
| 93 | * |
---|
| 94 | * When present, the text will be analyzed based on the specified type |
---|
| 95 | * |
---|
| 96 | * @param string $type |
---|
| 97 | * @return Solarium_Query_Analysis_Field Provides fluent interface |
---|
| 98 | */ |
---|
| 99 | public function setFieldType($type) |
---|
| 100 | { |
---|
| 101 | return $this->_setOption('fieldtype', $type); |
---|
| 102 | } |
---|
| 103 | |
---|
| 104 | /** |
---|
| 105 | * Get the fieldtype option |
---|
| 106 | * |
---|
| 107 | * @return string |
---|
| 108 | */ |
---|
| 109 | public function getFieldType() |
---|
| 110 | { |
---|
| 111 | return $this->getOption('fieldtype'); |
---|
| 112 | } |
---|
| 113 | |
---|
| 114 | /** |
---|
| 115 | * Set the field name option |
---|
| 116 | * |
---|
| 117 | * When present, the text will be analyzed based on the type of this field name |
---|
| 118 | * |
---|
| 119 | * @param string $name |
---|
| 120 | * @return Solarium_Query_Analysis_Field Provides fluent interface |
---|
| 121 | */ |
---|
| 122 | public function setFieldName($name) |
---|
| 123 | { |
---|
| 124 | return $this->_setOption('fieldname', $name); |
---|
| 125 | } |
---|
| 126 | |
---|
| 127 | /** |
---|
| 128 | * Get the fieldname option |
---|
| 129 | * |
---|
| 130 | * @return string |
---|
| 131 | */ |
---|
| 132 | public function getFieldName() |
---|
| 133 | { |
---|
| 134 | return $this->getOption('fieldname'); |
---|
| 135 | } |
---|
| 136 | |
---|
| 137 | } |
---|