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 | * Class for building Solarium client requests |
---|
41 | * |
---|
42 | * @package Solarium |
---|
43 | * @subpackage Client |
---|
44 | */ |
---|
45 | abstract class Solarium_Client_RequestBuilder |
---|
46 | { |
---|
47 | |
---|
48 | /** |
---|
49 | * Build request for a select query |
---|
50 | * |
---|
51 | * @param Solarium_Query $query |
---|
52 | * @return Solarium_Client_Request |
---|
53 | */ |
---|
54 | public function build($query) |
---|
55 | { |
---|
56 | $request = new Solarium_Client_Request; |
---|
57 | $request->setHandler($query->getHandler()); |
---|
58 | $request->addParams($query->getParams()); |
---|
59 | $request->addParam('wt', 'json'); |
---|
60 | |
---|
61 | return $request; |
---|
62 | } |
---|
63 | |
---|
64 | /** |
---|
65 | * Render a param with localParams |
---|
66 | * |
---|
67 | * LocalParams can be use in various Solr GET params. |
---|
68 | * @link http://wiki.apache.org/solr/LocalParams |
---|
69 | * |
---|
70 | * @param string $value |
---|
71 | * @param array $localParams in key => value format |
---|
72 | * @return string with Solr localparams syntax |
---|
73 | */ |
---|
74 | public function renderLocalParams($value, $localParams = array()) |
---|
75 | { |
---|
76 | $params = ''; |
---|
77 | foreach ($localParams AS $paramName => $paramValue) { |
---|
78 | if (empty($paramValue)) continue; |
---|
79 | |
---|
80 | if (is_array($paramValue)) { |
---|
81 | $paramValue = implode($paramValue, ','); |
---|
82 | } |
---|
83 | |
---|
84 | $params .= $paramName . '=' . $paramValue . ' '; |
---|
85 | } |
---|
86 | |
---|
87 | if ($params !== '') { |
---|
88 | $value = '{!' . trim($params) . '}' . $value; |
---|
89 | } |
---|
90 | |
---|
91 | return $value; |
---|
92 | } |
---|
93 | |
---|
94 | /** |
---|
95 | * Render a boolean attribute |
---|
96 | * |
---|
97 | * For use in building XML messages |
---|
98 | * |
---|
99 | * @param string $name |
---|
100 | * @param boolean $value |
---|
101 | * @return string |
---|
102 | */ |
---|
103 | public function boolAttrib($name, $value) |
---|
104 | { |
---|
105 | if (null !== $value) { |
---|
106 | $value = (true == $value) ? 'true' : 'false'; |
---|
107 | return $this->attrib($name, $value); |
---|
108 | } else { |
---|
109 | return ''; |
---|
110 | } |
---|
111 | } |
---|
112 | |
---|
113 | /** |
---|
114 | * Render an attribute |
---|
115 | * |
---|
116 | * For use in building XML messages |
---|
117 | * |
---|
118 | * @param string $name |
---|
119 | * @param striung $value |
---|
120 | * @return string |
---|
121 | */ |
---|
122 | public function attrib($name, $value) |
---|
123 | { |
---|
124 | if (null !== $value) { |
---|
125 | return ' ' . $name . '="' . $value . '"'; |
---|
126 | } else { |
---|
127 | return ''; |
---|
128 | } |
---|
129 | } |
---|
130 | } |
---|