Skip to content

S
solarium
Commit 2f1edbf2 authored by Bas de Nooijer's avatar Bas de Nooijer
Browse files
Options

- lots of refactoring for the new solarium 2.0 structure 

- still very much a work in progress, largely untested!
parent a41cc287
Hide whitespace changes
Inline Side-by-side
Showing with 2064 additions and 588 deletions
library/Solarium/Client.php
View file @ 2f1edbf2
...@@ -55,6 +55,13 @@ ...@@ -55,6 +55,13 @@
class Solarium_Client extends Solarium_Configurable class Solarium_Client extends Solarium_Configurable
{ {
/**
* Querytype definitions
*/
const QUERYTYPE_SELECT = 'Select';
const QUERYTYPE_UPDATE = 'Update';
const QUERYTYPE_PING = 'Ping';
/** /**
* Default options * Default options
* *
...@@ -64,12 +71,25 @@ class Solarium_Client extends Solarium_Configurable ...@@ -64,12 +71,25 @@ class Solarium_Client extends Solarium_Configurable
* @var array * @var array
*/ */
protected $_options = array( protected $_options = array(
'host' => '127.0.0.1',
'port' => 8983,
'path' => '/solr',
'core' => null,
'adapter' => 'Solarium_Client_Adapter_Http', 'adapter' => 'Solarium_Client_Adapter_Http',
'timeout' => 5, );
/**
* Querytype mappings
*/
protected $_queryTypes = array(
self::QUERYTYPE_SELECT => array(
'requestbuilder' => 'Solarium_Client_RequestBuilder_Select',
'responseparser' => 'Solarium_Client_ResponseParser_Select'
),
self::QUERYTYPE_UPDATE => array(
'requestbuilder' => 'Solarium_Client_RequestBuilder_Update',
'responseparser' => 'Solarium_Client_ResponseParser_Update'
),
self::QUERYTYPE_PING => array(
'requestbuilder' => 'Solarium_Client_RequestBuilder_Ping',
'responseparser' => 'Solarium_Client_ResponseParser_Ping'
),
); );
/** /**
...@@ -87,131 +107,11 @@ class Solarium_Client extends Solarium_Configurable ...@@ -87,131 +107,11 @@ class Solarium_Client extends Solarium_Configurable
protected $_adapter; protected $_adapter;
/** /**
* Initialization hook * Request builder instances
*
* In this case the path needs to be cleaned of trailing slashes.
* @see setPath()
*/
protected function _init()
{
foreach ($this->_options AS $name => $value) {
switch ($name) {
case 'path':
$this->setPath($value);
break;
}
}
}
/**
* Set an option
*
* If any option of this client is changed after the adapter has been
* instantiated the change is propagated to the adapter. This allows for
* switching the client to another core for a second query, for instance.
*
* @param string $name
* @param mixed $value
* @return Solarium_Configurable
*/
protected function _setOption($name, $value)
{
parent::_setOption($name, $value);
if (null !== $this->_adapter) {
$this->_adapter->setOptions($this->_options);
}
return $this;
}
/**
* Set host option
*
* @param string $host This can be a hostname or an IP address
* @return Solarium_Client Provides fluent interface
*/
public function setHost($host)
{
return $this->_setOption('host', $host);
}
/**
* Get host option
*
* @return string
*/
public function getHost()
{
return $this->getOption('host');
}
/**
* Set port option
* *
* @param int $port Common values are 80, 8080 and 8983 * @var array
* @return Solarium_Client Provides fluent interface
*/
public function setPort($port)
{
return $this->_setOption('port', $port);
}
/**
* Get port option
*
* @return int
*/
public function getPort()
{
return $this->getOption('port');
}
/**
* Set path option
*
* If the path has a trailing slash it will be removed.
*
* @param string $path
* @return Solarium_Client Provides fluent interface
*/
public function setPath($path)
{
if (substr($path, -1) == '/') $path = substr($path, 0, -1);
return $this->_setOption('path', $path);
}
/**
* Get path option
*
* @return void
*/
public function getPath()
{
return $this->getOption('path');
}
/**
* Set core option
*
* @param string $core
* @return Solarium_Client Provides fluent interface
*/ */
public function setCore($core) protected $_requestBuilders;
{
return $this->_setOption('core', $core);
}
/**
* Get core option
*
* @return string
*/
public function getCore()
{
return $this->getOption('core');
}
/** /**
* Set the adapter * Set the adapter
...@@ -284,29 +184,92 @@ class Solarium_Client extends Solarium_Configurable ...@@ -284,29 +184,92 @@ class Solarium_Client extends Solarium_Configurable
} }
/** /**
* Set adapter options * Register a querytype
*
* You can also use this method to override any existing querytype with a new mapping
* *
* @param array|object $options * @param string $type
* @param string $requestBuilder
* @param string $responseParser
* @return Solarium_Client Provides fluent interface * @return Solarium_Client Provides fluent interface
*/ */
public function setAdapterOptions($options) public function registerQueryType($type, $requestBuilder, $responseParser)
{ {
// covert config object into an array if needed $this->_queryTypes[$type] = array(
if (is_object($options)) { 'requestbuilder' => $requestBuilder,
$options = $options->toArray(); 'responseparser' => $responseParser,
);
return $this;
}
/**
* Get all registered querytypes
*
* @return array
*/
public function getQueryTypes()
{
return $this->_queryTypes;
}
/**
* Creates a request based on a query instance
*
* @todo add caching of request builder?
*
* @param Solarium_Query $query
* @return Solarium_Client_Request
*/
public function createRequest($query)
{
$queryType = $query->getType();
if (!isset($this->_queryTypes[$queryType])) {
throw new Solarium_Exception('No requestbuilder registered for querytype: '. $queryType);
} }
return $this->_setOption('adapteroptions', $options); $requestBuilderClass = $this->_queryTypes[$queryType]['requestbuilder'];
$requestBuilder = new $requestBuilderClass;
return $requestBuilder->build($query);
} }
/** /**
* Get adapteroptions * Creates a result object
* *
* @return array * @param Solarium_Query $query
* @param array Solarium_Client_Response $response
* @return Solarium_Result
*/
public function createResult($query, $response)
{
$resultClass = $query->getResultClass();
return new $resultClass($this, $query, $response);
}
/**
* Execute a query
*
* @param Solarium_Query
* @return Solarium_Result
*/
public function execute($query)
{
$request = $this->createRequest($query);
$response = $this->executeRequest($request);
return $this->createResult($query, $response);
}
/**
* Execute a request and return the response
*
* @param Solarium_Client_Request
* @return Solarium_Client_Response
*/ */
public function getAdapterOptions() public function executeRequest($request)
{ {
return $this->getOption('adapteroptions'); return $this->getAdapter()->execute($request);
} }
/** /**
...@@ -330,7 +293,7 @@ class Solarium_Client extends Solarium_Configurable ...@@ -330,7 +293,7 @@ class Solarium_Client extends Solarium_Configurable
*/ */
public function ping($query) public function ping($query)
{ {
return $this->getAdapter()->ping($query); return $this->execute($query);
} }
/** /**
...@@ -356,7 +319,7 @@ class Solarium_Client extends Solarium_Configurable ...@@ -356,7 +319,7 @@ class Solarium_Client extends Solarium_Configurable
*/ */
public function update($query) public function update($query)
{ {
return $this->getAdapter()->update($query); return $this->execute($query);
} }
/** /**
...@@ -381,6 +344,6 @@ class Solarium_Client extends Solarium_Configurable ...@@ -381,6 +344,6 @@ class Solarium_Client extends Solarium_Configurable
*/ */
public function select($query) public function select($query)
{ {
return $this->getAdapter()->select($query); return $this->execute($query);
} }
} }
\ No newline at end of file
library/Solarium/Client/Adapter.php
View file @ 2f1edbf2
...@@ -56,58 +56,175 @@ ...@@ -56,58 +56,175 @@
*/ */
abstract class Solarium_Client_Adapter extends Solarium_Configurable abstract class Solarium_Client_Adapter extends Solarium_Configurable
{ {
/**
* Default options
*
* The defaults match a standard Solr example instance as distributed by
* the Apache Lucene Solr project.
*
* @var array
*/
protected $_options = array(
'host' => '127.0.0.1',
'port' => 8983,
'path' => '/solr',
'core' => null,
'timeout' => 5,
);
/**
* Initialization hook
*
* In this case the path needs to be cleaned of trailing slashes.
* @see setPath()
*/
protected function _init()
{
foreach ($this->_options AS $name => $value) {
switch ($name) {
case 'path':
$this->setPath($value);
break;
}
}
}
/**
* Set host option
*
* @param string $host This can be a hostname or an IP address
* @return Solarium_Client Provides fluent interface
*/
public function setHost($host)
{
return $this->_setOption('host', $host);
}
/**
* Get host option
*
* @return string
*/
public function getHost()
{
return $this->getOption('host');
}
/**
* Set port option
*
* @param int $port Common values are 80, 8080 and 8983
* @return Solarium_Client Provides fluent interface
*/
public function setPort($port)
{
return $this->_setOption('port', $port);
}
/**
* Get port option
*
* @return int
*/
public function getPort()
{
return $this->getOption('port');
}
/** /**
* Set options * Set path option
* *
* Overrides any existing values * If the path has a trailing slash it will be removed.
*
* @param string $path
* @return Solarium_Client Provides fluent interface
*/
public function setPath($path)
{
if (substr($path, -1) == '/') $path = substr($path, 0, -1);
return $this->_setOption('path', $path);
}
/**
* Get path option
* *
* @param array $options
* @return void * @return void
*/ */
public function setOptions($options) public function getPath()
{ {
$this->_setOptions($options, true); return $this->getOption('path');
} }
/** /**
* Execute a select query * Set core option
* *
* Abstract method to require an implementation inside all adapters. * @param string $core
* If the adapter cannot support this method it should implement a method * @return Solarium_Client Provides fluent interface
* that throws an exception. */
public function setCore($core)
{
return $this->_setOption('core', $core);
}
/**
* Get core option
* *
* @abstract * @return string
* @param Solarium_Query_Select $query
* @return Solarium_Result_Select
*/ */
abstract public function select($query); public function getCore()
{
return $this->getOption('core');
}
/** /**
* Execute a ping query * Set timeout option
* *
* Abstract method to require an implementation inside all adapters. * @param int $timeout
* If the adapter cannot support this method it should implement a method * @return Solarium_Client Provides fluent interface
* that throws an exception. */
public function setTimeout($timeout)
{
return $this->_setOption('timeout', $timeout);
}
/**
* Get timeout option
* *
* @abstract * @return string
* @param Solarium_Query_Ping $query
* @return boolean
*/ */
abstract public function ping($query); public function getTimeout()
{
return $this->getOption('timeout');
}
/** /**
* Execute an update query * Execute a request
* *
* Abstract method to require an implementation inside all adapters. * Abstract method to require an implementation inside all adapters.
* If the adapter cannot support this method it should implement a method
* that throws an exception.
* *
* @abstract * @abstract
* @param Solarium_Query_Update $query * @param Solarium_Client_Request $request
* @return Solarium_Result_Update * @return Solarium_Client_Response
*/
abstract public function execute($request);
/**
* Get the base url for all requests
*
* Based on host, path, port and core options.
*
* @return void
*/ */
abstract public function update($query); public function getBaseUri()
{
$uri = 'http://' . $this->getHost() . ':' . $this->getPort() . $this->getPath() . '/';
$core = $this->getCore();
if (!empty($core)) {
$uri .= $core.'/';
}
return $uri;
}
} }
\ No newline at end of file
library/Solarium/Client/Adapter/Http.php
View file @ 2f1edbf2
...@@ -44,67 +44,24 @@ ...@@ -44,67 +44,24 @@
class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter
{ {
/**
* Executes a select query
*
* @param Solarium_Query_Select $query
* @return Solarium_Result_Select
*/
public function select($query)
{
$request = new Solarium_Client_Request_Select($this->_options, $query);
$data = $this->_handleRequest($request);
$response = new Solarium_Client_Response_Select($query, $data);
return $response->getResult();
}
/**
* Executes a ping query
*
* @param Solarium_Query_Ping $query
* @return boolean
*/
public function ping($query)
{
$request = new Solarium_Client_Request_Ping($this->_options, $query);
return (boolean)$this->_handleRequest($request);
}
/**
* Executes an update query
*
* @param Solarium_Query_Update $query
* @return Solarium_Result_Update
*/
public function update($query)
{
$request = new Solarium_Client_Request_Update($this->_options, $query);
$data = $this->_handleRequest($request);
$response = new Solarium_Client_Response_Update($query, $data);
return $response->getResult();
}
/** /**
* Handle Solr communication * Handle Solr communication
* *
* @throws Solarium_Exception * @throws Solarium_Exception
* @param Solarium_Client_Request * @param Solarium_Client_Request
* @return array * @return Solarium_Client_Response
*/ */
protected function _handleRequest($request) public function execute($request)
{ {
$method = $request->getMethod(); $method = $request->getMethod();
$context = stream_context_create( $context = stream_context_create(
array('http' => array( array('http' => array(
'method' => $method, 'method' => $method,
'timeout' => $this->getOption('timeout') 'timeout' => $this->getTimeout()
)) ))
); );
if ($method == Solarium_Client_Request::POST) { if ($method == Solarium_Client_Request::METHOD_POST) {
$data = $request->getRawData(); $data = $request->getRawData();
if (null !== $data) { if (null !== $data) {
stream_context_set_option( stream_context_set_option(
...@@ -113,6 +70,7 @@ class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter ...@@ -113,6 +70,7 @@ class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter
'content', 'content',
$data $data
); );
//TODO header via request->setRawData!!
stream_context_set_option( stream_context_set_option(
$context, $context,
'http', 'http',
...@@ -122,85 +80,16 @@ class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter ...@@ -122,85 +80,16 @@ class Solarium_Client_Adapter_Http extends Solarium_Client_Adapter
} }
} }
$data = @file_get_contents($request->getUri(), false, $context); $uri = $this->getBaseUri() . $request->getUri();
$data = @file_get_contents($uri, false, $context);
// if there is no data and there are no headers it's a total failure, // if there is no data and there are no headers it's a total failure,
// a connection to the host was impossible. // a connection to the host was impossible.
if (false === $data && !isset($http_response_header)) { if (false === $data && !isset($http_response_header)) {
throw new Solarium_Client_HttpException("HTTP request failed"); throw new Solarium_Client_HttpException("HTTP request failed");
} }
$this->_checkHeaders($http_response_header); return new Solarium_Client_Response($data, $http_response_header);
if ($method == Solarium_Client_Request::HEAD) {
// HEAD request has no result data
return true;
} else {
if (false === $data) {
$error = error_get_last();
throw new Solarium_Exception($error['message']);
}
return $this->_jsonDecode($data);
}
} }
/**
* Check HTTP headers
*
* The status header is parsed, an exception will be thrown for an error
* code.
*
* @throws Solarium_Client_HttpException
* @param array $headers
* @return void
*/
protected function _checkHeaders($headers)
{
// get the status header
$statusHeader = null;
foreach ($headers AS $header) {
if (substr($header, 0, 4) == 'HTTP') {
$statusHeader = $header;
break;
}
}
if (null == $statusHeader) {
throw new Solarium_Client_HttpException("No HTTP status found");
}
// parse header like "$statusInfo[1]" into code and message
// $statusInfo[1] = the HTTP response code
// $statusInfo[2] = the response message
$statusInfo = explode(' ', $statusHeader, 3);
// check status for error (range of 400 and 500)
$statusNum = floor($statusInfo[1] / 100);
if ($statusNum == 4 || $statusNum == 5) {
throw new Solarium_Client_HttpException(
$statusInfo[2],
$statusInfo[1]
);
}
}
/**
* Decode json response data
*
* @throws Solarium_Exception
* @param string $data
* @return string
*/
protected function _jsonDecode($data)
{
$data = json_decode($data, true);
if (null === $data) {
throw new Solarium_Exception(
'Solr JSON response could not be decoded'
);
}
return $data;
}
} }
\ No newline at end of file
library/Solarium/Client/Request.php
View file @ 2f1edbf2
...@@ -36,102 +36,117 @@ ...@@ -36,102 +36,117 @@
*/ */
/** /**
* Base class for building Solr HTTP requests * Class for describing a request
* *
* Most {@link Solarium_Client_Adapter} implementations will use HTTP for * @todo support config mode
* communicating with Solr. While the HTTP part is adapter-specific, generating
* the HTTP request setting (url, postdata, etc.) is not.
* This abstract class is the base for several requestbuilders that generate the
* settings for the various querytypes.
* *
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
abstract class Solarium_Client_Request class Solarium_Client_Request extends Solarium_Configurable
{ {
/** /**
* Http request methods * Http request methods
*/ */
const GET = 'GET'; const METHOD_GET = 'get';
const POST = 'POST'; const METHOD_POST = 'post';
const HEAD = 'HEAD'; const METHOD_HEAD = 'head';
/** /**
* Query instance * Default options
* *
* The query that has to be used for building the request. * @var array
*
* @var Solarium_Query
*/ */
protected $_query; protected $_options = array(
'method' => self::METHOD_GET,
);
/** /**
* Adapter options * Request headers
*/
protected $_headers;
/**
* Request params
* *
* When the adapter class the {@link __construct()} method it forwards it's * Multivalue params are supported using a multidimensional array:
* options. These options are needed for building the right uri. * 'fq' => array('cat:1','published:1')
* *
* @var array * @var array
*/ */
protected $_options; protected $_params;
/** /**
* HTTP GET params * Raw POST data
* *
* Used for building the uri in {@link buildUri()} * @var string
*
* @var array
*/ */
protected $_params; protected $_rawData;
/** /**
* Constructor * Set request handler
* *
* @param array|object $options Passed on by the adapter * @param string $handler
* @param Solarium_Query $query * @return Solarium_Client_Request
*/ */
public function __construct($options, $query) public function setHandler($handler)
{ {
$this->_options = $options; $this->_setOption('handler', $handler);
$this->_query = $query; return $this;
} }
/** /**
* Get HTTP request method * Get request handler
* *
* @return string * @return string
*/ */
public function getMethod() public function getHandler()
{ {
return self::GET; return $this->getOption('handler');
} }
/** /**
* Get request uri * Set request method
* *
* To be implemented by query specific request builders. * Use one of the constants as value
* *
* @abstract * @param string $method
* @return string * @return Solarium_Client_Request
*/ */
abstract public function getUri(); public function setMethod($method)
{
$this->_setOption('method', $method);
return $this;
}
/** /**
* Get raw POST data * Get request method
* *
* Returns null by default, disabling raw POST. * @return string
* If raw POST data is needed for a request the builder must override this */
* method and return a data string. This string must be safely encoded. public function getMethod()
{
return $this->getOption('method');
}
/**
* Get a param value
* *
* @return null * @param string $key
* @return string|array
*/ */
public function getRawData() public function getParam($key)
{ {
return null; if (isset($this->_params[$key])) {
return $this->_params[$key];
} else {
return null;
}
} }
/** /**
* Get request GET params * Get all params
* *
* @return array * @return array
*/ */
...@@ -141,133 +156,193 @@ abstract class Solarium_Client_Request ...@@ -141,133 +156,193 @@ abstract class Solarium_Client_Request
} }
/** /**
* Build a URL for this request * Set request params
* *
* Based on {@link $_options} and {@link $_params} as input. * @param array $params
* @return Solarium_Client_Request
*/
public function setParams($params)
{
$this->clearParams();
$this->addParams($params);
return $this;
}
/**
* Add a request param
* *
* @internal Solr expects multiple GET params of the same name instead of * If you add a request param that already exists the param will be converted into a multivalue param,
* the PHP array type notation. Therefore the result of http_build_query * unless you set the overwrite param to true.
* has to be altered.
* *
* @return string * Empty params are not added to the request. If you want to empty a param disable it you should use
* remove param instead.
*
* @param string $key
* @param string|array $value
* @param boolean $overwrite
* @return Solarium_Client_Request
*/ */
public function buildUri() public function addParam($key, $value, $overwrite = false)
{ {
$queryString = ''; if (!empty($value)) {
if (count($this->_params) > 0) { if (!$overwrite && isset($this->_params[$key])) {
$queryString = http_build_query($this->_params, null, '&'); if (!is_array($this->_params[$key])) {
$queryString = preg_replace( $this->_params[$key] = array($this->_params[$key]);
'/%5B(?:[0-9]|[1-9][0-9]+)%5D=/', }
'=', $this->_params[$key][] = $value;
$queryString } else {
); $this->_params[$key] = $value;
}
} }
if (null !== $this->_options['core']) { return $this;
$core = '/' . $this->_options['core']; }
} else {
$core = ''; /**
* Add multiple params to the request
*
* @param array $params
* @param boolean $overwrite
* @return Solarium_Client_Request
*/
public function addParams($params, $overwrite = false)
{
foreach ($params as $key => $value) {
$this->addParam($key, $value, $overwrite);
} }
return 'http://' . $this->_options['host'] . ':' return $this;
. $this->_options['port'] . $this->_options['path']
. $core . '/' . $this->_query->getHandler() . '?'
. $queryString;
} }
/** /**
* Render a boolean attribute * Remove a param by key
* *
* For use in building XML messages * @param string $key
* * @return Solarium_Client_Request
* @param string $name
* @param boolean $value
* @return string
*/ */
public function boolAttrib($name, $value) public function removeParam($key)
{ {
if (null !== $value) { if (isset($this->_params[$key])) {
$value = (true == $value) ? 'true' : 'false'; unset($this->_params[$key]);
return $this->attrib($name, $value);
} else {
return '';
} }
return $this;
} }
/** /**
* Render an attribute * Clear all request params
*
* @return Solarium_Client_Request
*/
public function clearParams()
{
$this->_params = array();
return $this;
}
/**
* Get raw POST data
*
* @return null
*/
public function getRawData()
{
return $this->_rawData;
}
/**
* Set raw POST data
* *
* For use in building XML messages * This string must be safely encoded.
* *
* @param string $name * @param string $data
* @param striung $value * @return Solarium_Client_Request
* @return string
*/ */
public function attrib($name, $value) public function setRawData($data)
{ {
if (null !== $value) { $this->_rawData = $data;
return ' ' . $name . '="' . $value . '"'; return $this;
} else {
return '';
}
} }
/** /**
* Render a param with localParams * Get all request headers
* *
* LocalParams can be use in various Solr GET params. * @return array
* @link http://wiki.apache.org/solr/LocalParams */
public function getHeaders()
{
return $this->_headers;
}
/**
* Set request headers
* *
* @param string $value * @header array $headers
* @param array $localParams in key => value format * @return Solarium_Client_Request
* @return string with Solr localparams syntax
*/ */
public function renderLocalParams($value, $localParams = array()) public function setHeaders($headers)
{ {
$params = ''; $this->clearHeaders();
foreach ($localParams AS $paramName => $paramValue) { $this->addHeaders($headers);
if (empty($paramValue)) continue; return $this;
}
if (is_array($paramValue)) { /**
$paramValue = implode($paramValue, ','); * Add a request header
} *
* @header string $key
* @header string|array $value
* @return Solarium_Client_Request
*/
public function addHeader($key, $value)
{
$this->_headers[] = $value;
return $this;
}
$params .= $paramName . '=' . $paramValue . ' '; /**
* Add multiple headers to the request
*
* @header array $headers
* @return Solarium_Client_Request
*/
public function addHeaders($headers)
{
foreach ($headers as $key => $value) {
$this->addHeader($key, $value);
} }
if ($params !== '') { return $this;
$value = '{!' . trim($params) . '}' . $value; }
}
return $value; /**
* Clear all request headers
*
* @return Solarium_Client_Request
*/
public function clearHeaders()
{
$this->_headers = array();
return $this;
} }
/** /**
* Add a param to the request * Get an URI for this request
*
* This method makes adding params easy in two ways:
* - empty params are filtered out, so you don't to manually check each
* param
* - if you add the same param twice it will be converted into a multivalue
* param automatically. This way you don't need to check for single or
* multiple values beforehand.
* *
* @param string $name * @return string
* @param string $value
* @return void
*/ */
public function addParam($name, $value) public function getUri()
{ {
if (0 === strlen($value)) return; $queryString = '';
if (count($this->_params) > 0) {
if (!isset($this->_params[$name])) { $queryString = http_build_query($this->_params, null, '&');
$this->_params[$name] = $value; $queryString = preg_replace(
} else { '/%5B(?:[0-9]|[1-9][0-9]+)%5D=/',
if (!is_array($this->_params[$name])) { '=',
$this->_params[$name] = array($this->_params[$name]); $queryString
} );
$this->_params[$name][] = $value;
} }
return $this->getHandler() . '?' . $queryString;
} }
} }
\ No newline at end of file
library/Solarium/Client/RequestBuilder.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Class for building Solarium client requests
*
* @package Solarium
* @subpackage Client
*/
abstract class Solarium_Client_RequestBuilder
{
/**
* Render a param with localParams
*
* LocalParams can be use in various Solr GET params.
* @link http://wiki.apache.org/solr/LocalParams
*
* @param string $value
* @param array $localParams in key => value format
* @return string with Solr localparams syntax
*/
public function renderLocalParams($value, $localParams = array())
{
$params = '';
foreach ($localParams AS $paramName => $paramValue) {
if (empty($paramValue)) continue;
if (is_array($paramValue)) {
$paramValue = implode($paramValue, ',');
}
$params .= $paramName . '=' . $paramValue . ' ';
}
if ($params !== '') {
$value = '{!' . trim($params) . '}' . $value;
}
return $value;
}
}
\ No newline at end of file
library/Solarium/Client/Request/Ping.php → library/Solarium/Client/RequestBuilder/Ping.php
View file @ 2f1edbf2
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
class Solarium_Client_Request_Ping extends Solarium_Client_Request class Solarium_Client_RequestBuilder_Ping extends Solarium_Client_RequestBuilder
{ {
/** /**
......
library/Solarium/Client/RequestBuilder/Select.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Build a select request
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_RequestBuilder_Select extends Solarium_Client_RequestBuilder
{
/**
* Build request for a select query
*
* @param Solarium_Query_Select $query
* @return Solarium_Client_Request
*/
public function build($query)
{
$request = new Solarium_Client_Request;
$request->setHandler($query->getHandler());
// add basic params to request
$request->addParam('q', $query->getQuery());
$request->addParam('start', $query->getStart());
$request->addParam('rows', $query->getRows());
$request->addParam('fl', implode(',', $query->getFields()));
$request->addParam('wt', 'json');
// add sort fields to request
$sort = array();
foreach ($query->getSortFields() AS $field => $order) {
$sort[] = $field . ' ' . $order;
}
if (count($sort) !== 0) {
$request->addParam('sort', implode(',', $sort));
}
// add filterqueries to request
$filterQueries = $query->getFilterQueries();
if (count($filterQueries) !== 0) {
foreach ($filterQueries AS $filterQuery) {
$fq = $this->renderLocalParams(
$filterQuery->getQuery(),
array('tag' => $filterQuery->getTags())
);
$request->addParam('fq', $fq);
}
}
// add components to request
$types = $query->getComponentTypes();
foreach ($query->getComponents() as $component) {
$componentBuilderClass = $types[$component->getType()]['requestbuilder'];
if (!empty($componentBuilderClass)) {
// todo add caching?
$componentBuilder = new $componentBuilderClass;
$request = $componentBuilder->build($component, $request);
}
}
return $request;
}
}
\ No newline at end of file
library/Solarium/Client/RequestBuilder/Select/Component/DisMax.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Add select component dismax to the request
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_RequestBuilder_Select_Component_DisMax
{
/**
* Add request settings for Dismax
*
* @param Solarium_Query_Select_Component_Dismax $component
* @param Solarium_Client_Request $request
* @return Solarium_Client_Request
*/
public function build($component, $request)
{
// enable dismax
$request->addParam('defType', 'dismax');
$request->addParam('q.alt', $component->getQueryAlternative());
$request->addParam('qf', $component->getQueryFields());
$request->addParam('mm', $component->getMinimumMatch());
$request->addParam('pf', $component->getPhraseFields());
$request->addParam('ps', $component->getPhraseSlop());
$request->addParam('qs', $component->getQueryPhraseSlop());
$request->addParam('tie', $component->getTie());
$request->addParam('bq', $component->getBoostQuery());
$request->addParam('bf', $component->getBoostFunctions());
return $request;
}
}
\ No newline at end of file
library/Solarium/Client/Request/Select.php → library/Solarium/Client/RequestBuilder/Select/Component/FacetSet.php
View file @ 2f1edbf2
...@@ -36,127 +36,72 @@ ...@@ -36,127 +36,72 @@
*/ */
/** /**
* Build a select request * Add select component FacetSet to the request
* *
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
class Solarium_Client_Request_Select extends Solarium_Client_Request class Solarium_Client_RequestBuilder_Select_Component_FacetSet extends Solarium_Client_RequestBuilder
{ {
/** /**
* Get uri * Add request settings for FacetSet
*
* Builds a complex uri based on the query settings
* *
* @throws Solarium_Exception * @param Solarium_Query_Select_Component_FacetSet $component
* @return string * @param Solarium_Client_Request $request
* @return Solarium_Client_Request
*/ */
public function getUri() public function build($component, $request)
{ {
$this->_params = array( $facets = $component->getFacets();
'q' => $this->_query->getQuery(),
'start' => $this->_query->getStart(),
'rows' => $this->_query->getRows(),
'fl' => implode(',', $this->_query->getFields()),
'wt' => 'json',
);
$sort = array();
foreach ($this->_query->getSortFields() AS $field => $order) {
$sort[] = $field . ' ' . $order;
}
if (count($sort) !== 0) {
$this->addParam('sort', implode(',', $sort));
}
$filterQueries = $this->_query->getFilterQueries();
if (count($filterQueries) !== 0) {
foreach ($filterQueries AS $filterQuery) {
$fq = $this->renderLocalParams(
$filterQuery->getQuery(),
array('tag' => $filterQuery->getTags())
);
$this->addParam('fq', $fq);
}
}
foreach ($this->_query->getComponents() as $component) {
switch ($component->getType())
{
case Solarium_Query_Select_Component::MORELIKETHIS:
$this->addMoreLikeThis($component);
break;
case Solarium_Query_Select_Component::FACETSET:
$this->addFacetSet($component);
break;
case Solarium_Query_Select_Component::DISMAX:
$this->addDisMax($component);
break;
case Solarium_Query_Select_Component::HIGHLIGHTING:
$this->addHighlighting($component);
break;
default:
throw new Solarium_Exception('Unknown component type');
}
}
return $this->buildUri();
}
/**
* @throws Solarium_Exception
* @param Solarium_Query_Select_Component_FacetSet $facetSet
* @return void
*/
public function addFacetSet($facetSet)
{
$facets = $facetSet->getFacets();
if (count($facets) !== 0) { if (count($facets) !== 0) {
// enable faceting // enable faceting
$this->_params['facet'] = 'true'; $request->addParam('facet', 'true');
// global facet params // global facet params
$this->addParam('facet.sort', $facetSet->getSort()); $request->addParam('facet.sort', $component->getSort());
$this->addParam('facet.prefix', $facetSet->getPrefix()); $request->addParam('facet.prefix', $component->getPrefix());
$this->addParam('facet.missing', $facetSet->getMissing()); $request->addParam('facet.missing', $component->getMissing());
$this->addParam('facet.mincount', $facetSet->getMinCount()); $request->addParam('facet.mincount', $component->getMinCount());
$this->addParam('facet.limit', $facetSet->getLimit()); $request->addParam('facet.limit', $component->getLimit());
foreach ($facets AS $facet) { foreach ($facets AS $facet) {
switch ($facet->getType()) switch ($facet->getType())
{ {
case Solarium_Query_Select_Component_Facet::FIELD: case Solarium_Query_Select_Component_Facet::FIELD:
$this->addFacetField($facet); $this->addFacetField($request, $facet);
break; break;
case Solarium_Query_Select_Component_Facet::QUERY: case Solarium_Query_Select_Component_Facet::QUERY:
$this->addFacetQuery($facet); $this->addFacetQuery($request, $facet);
break; break;
case Solarium_Query_Select_Component_Facet::MULTIQUERY: case Solarium_Query_Select_Component_Facet::MULTIQUERY:
$this->addFacetMultiQuery($facet); $this->addFacetMultiQuery($request, $facet);
break; break;
case Solarium_Query_Select_Component_Facet::RANGE: case Solarium_Query_Select_Component_Facet::RANGE:
$this->addFacetRange($facet); $this->addFacetRange($request, $facet);
break; break;
default: default:
throw new Solarium_Exception('Unknown facet type'); throw new Solarium_Exception('Unknown facet type');
} }
} }
} }
return $request;
} }
/** /**
* Add params for a field facet to request * Add params for a field facet to request
* *
* @param Solarium_Client_Request $request
* @param Solarium_Query_Select_Component_Facet_Field $facet * @param Solarium_Query_Select_Component_Facet_Field $facet
* @return void * @return void
*/ */
public function addFacetField($facet) public function addFacetField($request, $facet)
{ {
$field = $facet->getField(); $field = $facet->getField();
$this->addParam( $request->addParam(
'facet.field', 'facet.field',
$this->renderLocalParams( $this->renderLocalParams(
$field, $field,
...@@ -164,24 +109,25 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request ...@@ -164,24 +109,25 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request
) )
); );
$this->addParam("f.$field.facet.limit", $facet->getLimit()); $request->addParam("f.$field.facet.limit", $facet->getLimit());
$this->addParam("f.$field.facet.sort", $facet->getSort()); $request->addParam("f.$field.facet.sort", $facet->getSort());
$this->addParam("f.$field.facet.prefix", $facet->getPrefix()); $request->addParam("f.$field.facet.prefix", $facet->getPrefix());
$this->addParam("f.$field.facet.offset", $facet->getOffset()); $request->addParam("f.$field.facet.offset", $facet->getOffset());
$this->addParam("f.$field.facet.mincount", $facet->getMinCount()); $request->addParam("f.$field.facet.mincount", $facet->getMinCount());
$this->addParam("f.$field.facet.missing", $facet->getMissing()); $request->addParam("f.$field.facet.missing", $facet->getMissing());
$this->addParam("f.$field.facet.method", $facet->getMethod()); $request->addParam("f.$field.facet.method", $facet->getMethod());
} }
/** /**
* Add params for a facet query to request * Add params for a facet query to request
* *
* @param Solarium_Client_Request $request
* @param Solarium_Query_Select_Component_Facet_Query $facet * @param Solarium_Query_Select_Component_Facet_Query $facet
* @return void * @return void
*/ */
public function addFacetQuery($facet) public function addFacetQuery($request, $facet)
{ {
$this->addParam( $request->addParam(
'facet.query', 'facet.query',
$this->renderLocalParams( $this->renderLocalParams(
$facet->getQuery(), $facet->getQuery(),
...@@ -193,27 +139,29 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request ...@@ -193,27 +139,29 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request
/** /**
* Add params for a multiquery facet to request * Add params for a multiquery facet to request
* *
* @param Solarium_Client_Request $request
* @param Solarium_Query_Select_Component_Facet_MultiQuery $facet * @param Solarium_Query_Select_Component_Facet_MultiQuery $facet
* @return void * @return void
*/ */
public function addFacetMultiQuery($facet) public function addFacetMultiQuery($request, $facet)
{ {
foreach ($facet->getQueries() AS $facetQuery) { foreach ($facet->getQueries() AS $facetQuery) {
$this->addFacetQuery($facetQuery); $this->addFacetQuery($request, $facetQuery);
} }
} }
/** /**
* Add params for a range facet to request * Add params for a range facet to request
* *
* @param Solarium_Client_Request $request
* @param Solarium_Query_Select_Component_Facet_Range $facet * @param Solarium_Query_Select_Component_Facet_Range $facet
* @return void * @return void
*/ */
public function addFacetRange($facet) public function addFacetRange($request, $facet)
{ {
$field = $facet->getField(); $field = $facet->getField();
$this->addParam( $request->addParam(
'facet.range', 'facet.range',
$this->renderLocalParams( $this->renderLocalParams(
$field, $field,
...@@ -221,98 +169,19 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request ...@@ -221,98 +169,19 @@ class Solarium_Client_Request_Select extends Solarium_Client_Request
) )
); );
$this->addParam("f.$field.facet.range.start", $facet->getStart()); $request->addParam("f.$field.facet.range.start", $facet->getStart());
$this->addParam("f.$field.facet.range.end", $facet->getEnd()); $request->addParam("f.$field.facet.range.end", $facet->getEnd());
$this->addParam("f.$field.facet.range.gap", $facet->getGap()); $request->addParam("f.$field.facet.range.gap", $facet->getGap());
$this->addParam("f.$field.facet.range.hardend", $facet->getHardend()); $request->addParam("f.$field.facet.range.hardend", $facet->getHardend());
$other = explode(',', $facet->getOther()); $other = explode(',', $facet->getOther());
foreach ($other AS $otherValue) { foreach ($other AS $otherValue) {
$this->addParam("f.$field.facet.range.other", trim($otherValue)); $request->addParam("f.$field.facet.range.other", trim($otherValue));
} }
$include = explode(',', $facet->getInclude()); $include = explode(',', $facet->getInclude());
foreach ($include AS $includeValue) { foreach ($include AS $includeValue) {
$this->addParam("f.$field.facet.range.include", trim($includeValue)); $request->addParam("f.$field.facet.range.include", trim($includeValue));
} }
} }
/**
* Add params for morelikethis
*
* @param Solarium_Query_Select_Component_MoreLikeThis $component
* @return void
*/
public function addMoreLikeThis($component)
{
// enable morelikethis
$this->_params['mlt'] = 'true';
$this->addParam('mlt.fl', $component->getFields());
$this->addParam('mlt.mintf', $component->getMinimumTermFrequency());
$this->addParam('mlt.mindf', $component->getMinimumDocumentFrequency());
$this->addParam('mlt.minwl', $component->getMinimumWordLength());
$this->addParam('mlt.maxwl', $component->getMaximumWordLength());
$this->addParam('mlt.maxqt', $component->getMaximumQueryTerms());
$this->addParam('mlt.maxntp', $component->getMaximumNumberOfTokens());
$this->addParam('mlt.boost', $component->getBoost());
$this->addParam('mlt.qf', $component->getQueryFields());
$this->addParam('mlt.count', $component->getCount());
}
/**
* Add params for DisMax
*
* @param Solarium_Query_Select_Component_DisMax $component
* @return void
*/
public function addDisMax($component)
{
// enable dismax
$this->_params['defType'] = 'dismax';
$this->addParam('q.alt', $component->getQueryAlternative());
$this->addParam('qf', $component->getQueryFields());
$this->addParam('mm', $component->getMinimumMatch());
$this->addParam('pf', $component->getPhraseFields());
$this->addParam('ps', $component->getPhraseSlop());
$this->addParam('qs', $component->getQueryPhraseSlop());
$this->addParam('tie', $component->getTie());
$this->addParam('bq', $component->getBoostQuery());
$this->addParam('bf', $component->getBoostFunctions());
}
/**
* Add params for highlighting
*
* @param Solarium_Query_Select_Component_Highlighting $component
* @return void
*/
public function addHighlighting($component)
{
// enable highlighting
$this->_params['hl'] = 'true';
$this->addParam('hl.fl', $component->getFields());
$this->addParam('hl.snippets', $component->getSnippets());
$this->addParam('hl.fragsize', $component->getFragSize());
$this->addParam('hl.mergeContiguous', $component->getMergeContiguous());
$this->addParam('hl.requireFieldMatch', $component->getRequireFieldMatch());
$this->addParam('hl.maxAnalyzedChars', $component->getMaxAnalyzedChars());
$this->addParam('hl.alternateField', $component->getAlternateField());
$this->addParam('hl.maxAlternateFieldLength', $component->getMaxAlternateFieldLength());
$this->addParam('hl.formatter', $component->getFormatter());
$this->addParam('hl.simple.pre', $component->getSimplePrefix());
$this->addParam('hl.simple.post', $component->getSimplePostfix());
$this->addParam('hl.fragmenter', $component->getFragmenter());
$this->addParam('hl.fragListBuilder', $component->getFragListBuilder());
$this->addParam('hl.fragmentsBuilder', $component->getFragmentsBuilder());
$this->addParam('hl.useFastVectorHighlighter', $component->getUseFastVectorHighlighter());
$this->addParam('hl.usePhraseHighlighter', $component->getUsePhraseHighlighter());
$this->addParam('hl.highlightMultiTerm', $component->getHighlightMultiTerm());
$this->addParam('hl.regex.slop', $component->getRegexSlop());
$this->addParam('hl.regex.pattern', $component->getRegexPattern());
$this->addParam('hl.regex.maxAnalyzedChars', $component->getRegexMaxAnalyzedChars());
}
} }
\ No newline at end of file
library/Solarium/Client/RequestBuilder/Select/Component/Highlighting.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Add select component Highlighting to the request
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_RequestBuilder_Select_Component_Highlighting
{
/**
* Add request settings for Highlighting
*
* @param Solarium_Query_Select_Component_Highlighting $component
* @param Solarium_Client_Request $request
* @return Solarium_Client_Request
*/
public function build($component, $request)
{
// enable highlighting
$request->addParam('hl', 'true');
$request->addParam('hl.fl', $component->getFields());
$request->addParam('hl.snippets', $component->getSnippets());
$request->addParam('hl.fragsize', $component->getFragSize());
$request->addParam('hl.mergeContiguous', $component->getMergeContiguous());
$request->addParam('hl.requireFieldMatch', $component->getRequireFieldMatch());
$request->addParam('hl.maxAnalyzedChars', $component->getMaxAnalyzedChars());
$request->addParam('hl.alternateField', $component->getAlternateField());
$request->addParam('hl.maxAlternateFieldLength', $component->getMaxAlternateFieldLength());
$request->addParam('hl.formatter', $component->getFormatter());
$request->addParam('hl.simple.pre', $component->getSimplePrefix());
$request->addParam('hl.simple.post', $component->getSimplePostfix());
$request->addParam('hl.fragmenter', $component->getFragmenter());
$request->addParam('hl.fragListBuilder', $component->getFragListBuilder());
$request->addParam('hl.fragmentsBuilder', $component->getFragmentsBuilder());
$request->addParam('hl.useFastVectorHighlighter', $component->getUseFastVectorHighlighter());
$request->addParam('hl.usePhraseHighlighter', $component->getUsePhraseHighlighter());
$request->addParam('hl.highlightMultiTerm', $component->getHighlightMultiTerm());
$request->addParam('hl.regex.slop', $component->getRegexSlop());
$request->addParam('hl.regex.pattern', $component->getRegexPattern());
$request->addParam('hl.regex.maxAnalyzedChars', $component->getRegexMaxAnalyzedChars());
return $request;
}
}
\ No newline at end of file
library/Solarium/Client/RequestBuilder/Select/Component/MoreLikeThis.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Add select component morelikethis to the request
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_RequestBuilder_Select_Component_MoreLikeThis
{
/**
* Add request settings for morelikethis
*
* @param Solarium_Query_Select_Component_MoreLikeThis $component
* @param Solarium_Client_Request $request
* @return Solarium_Client_Request
*/
public function build($component, $request)
{
// enable morelikethis
$request->addParam('mlt','true');
$request->addParam('mlt.fl', $component->getFields());
$request->addParam('mlt.mintf', $component->getMinimumTermFrequency());
$request->addParam('mlt.mindf', $component->getMinimumDocumentFrequency());
$request->addParam('mlt.minwl', $component->getMinimumWordLength());
$request->addParam('mlt.maxwl', $component->getMaximumWordLength());
$request->addParam('mlt.maxqt', $component->getMaximumQueryTerms());
$request->addParam('mlt.maxntp', $component->getMaximumNumberOfTokens());
$request->addParam('mlt.boost', $component->getBoost());
$request->addParam('mlt.qf', $component->getQueryFields());
$request->addParam('mlt.count', $component->getCount());
return $request;
}
}
\ No newline at end of file
library/Solarium/Client/Request/Update.php → library/Solarium/Client/RequestBuilder/Update.php
View file @ 2f1edbf2
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
class Solarium_Client_Request_Update extends Solarium_Client_Request class Solarium_Client_RequestBuilder_Update extends Solarium_Client_RequestBuilder
{ {
/** /**
......
library/Solarium/Client/Response.php
View file @ 2f1edbf2
...@@ -36,63 +36,124 @@ ...@@ -36,63 +36,124 @@
*/ */
/** /**
* Base class for handling Solr HTTP responses * Class for describing a response
*
* Most {@link Solarium_Client_Adapter} implementations will use HTTP for
* communicating with Solr. While the HTTP part is adapter-specific, the parsing
* of the response into Solarium_Result classes is not. This abstract class is
* the base for several response handlers that do just that for the various
* querytypes.
* *
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
abstract class Solarium_Client_Response class Solarium_Client_Response
{ {
/** /**
* Query instance * Headers
* *
* The query that was used for executing a request that led to this * @var array
* response. The query holds important settings for generating the right */
* result, like the resultclass and documentclass settings. protected $_headers;
/**
* Body
* *
* @var Solarium_Query * @var string
*/ */
protected $_query; protected $_body;
/** /**
* Response data * HTTP response code
* *
* A (json)decoded HTTP response body data array. * @var int
*/
protected $_statusCode;
/**
* HTTP response message
* *
* @var array * @var string
*/ */
protected $_data; protected $_statusMessage;
/** /**
* Constructor * Constructor
* *
* @param Solarium_Query $query Query instance that was used for the request * @param string $body
* @param array $data Decoded data array of the HTTP response * @param array $headers
*/ */
public function __construct($query, $data = null) public function __construct($body, $headers = array())
{ {
$this->_query = $query; $this->_body = $body;
$this->_data = $data; $this->_headers = $headers;
$this->_setHeaders($headers);
} }
/** /**
* Get a Solarium_Result instance for the response * Get body data
* *
* When this method is called the actual response parsing is started. * @return string
*/
public function getBody()
{
return $this->_body;
}
/**
* Get response headers
* *
* @internal Must be implemented in descendents because this parsing is * @return array
* query specific. */
public function getHeaders()
{
return $this->_headers;
}
/**
* Get status code
* *
* @abstract * @return int
* @return mixed
*/ */
abstract function getResult(); public function getStatusCode()
{
return $this->_statusCode;
}
/**
* Get status message
*
* @return string
*/
public function getStatusMessage()
{
return $this->_statusMessage;
}
/**
* Set headers
*
* @param array $headers
* @return void
*/
public function _setHeaders($headers)
{
$this->_headers = $headers;
// get the status header
$statusHeader = null;
foreach ($headers AS $header) {
if (substr($header, 0, 4) == 'HTTP') {
$statusHeader = $header;
break;
}
}
if (null == $statusHeader) {
throw new Solarium_Client_HttpException("No HTTP status found");
}
// parse header like "$statusInfo[1]" into code and message
// $statusInfo[1] = the HTTP response code
// $statusInfo[2] = the response message
$statusInfo = explode(' ', $statusHeader, 3);
$this->_statusCode = $statusInfo[1];
$this->_statusMessage = $statusInfo[2];
}
} }
\ No newline at end of file
library/Solarium/Client/ResponseParser.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Base class for handling Solr response data
*
* Most {@link Solarium_Client_Adapter} implementations will use HTTP for
* communicating with Solr. While the HTTP part is adapter-specific, the parsing
* of the response into Solarium_Result classes is not. This abstract class is
* the base for several response handlers that do just that for the various
* querytypes.
*
* @package Solarium
* @subpackage Client
*/
abstract class Solarium_Client_ResponseParser
{
/**
* Get a Solarium_Result instance for the given data
*
* When this method is called the actual response parsing is started.
*
* @internal Must be implemented in descendents because this parsing is
* query specific.
*
* @abstract
*
* @param Solarium_Result $result
* @return mixed
*/
abstract function parse($result);
}
\ No newline at end of file
library/Solarium/Client/ResponseParser/Select.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Parse select response data
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_ResponseParser_Select extends Solarium_Client_ResponseParser
{
/**
* Get result data for the response
*
* @param Solarium_Result_Select $result
* @return array
*/
public function parse($result)
{
$data = $result->getData();
$query = $result->getQuery();
// reset arrays
$this->_components = array();
// create document instances
$documentClass = $query->getOption('documentclass');
$documents = array();
if (isset($data['response']['docs'])) {
foreach ($data['response']['docs'] AS $doc) {
$fields = (array)$doc;
$documents[] = new $documentClass($fields);
}
}
// component results
$components = array();
$types = $query->getComponentTypes();
foreach ($query->getComponents() as $component) {
$componentParserClass = $types[$component->getType()]['responseparser'];
if (!empty($componentParserClass)) {
// todo add caching?
$componentParser = new $componentParserClass;
$components[$component->getType()] = $componentParser->parse($query, $component, $data);
}
}
return array(
'status' => $data['responseHeader']['status'],
'querytime' => $data['responseHeader']['QTime'],
'numfound' => $data['response']['numFound'],
'documents' => $documents,
'components' => $components,
);
}
}
\ No newline at end of file
library/Solarium/Client/Response/Select.php → library/Solarium/Client/ResponseParser/Select/Component/FacetSet.php
View file @ 2f1edbf2
...@@ -36,121 +36,63 @@ ...@@ -36,121 +36,63 @@
*/ */
/** /**
* Parse select response data * Parse select component FacetSet result from the data
*
* Will create a result object based on response data of the type
* {@Solarium_Result_Select} (or your own resultclass setting)
* *
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
class Solarium_Client_Response_Select extends Solarium_Client_Response class Solarium_Client_ResponseParser_Select_Component_FacetSet
{ {
/** /**
* Facet results * Parse result data into result objects
*
* Filled by the _addFacet* methods (for instance {@_addFacetField()})
* *
* @var array * @param Solarium_Query_Select $query
* @param Solarium_Query_Select_Component_FacetSet $facetSet
* @param array $data
* @return Solarium_Result_Select_FacetSet
*/ */
protected $_facets = array(); public function parse($query, $facetSet, $data)
/**
* Component results
*
* @var array
*/
protected $_components = array();
/**
* Get a result instance for the response
*
* When this method is called the actual response parsing is done.
*
* @return mixed
*/
public function getResult()
{
// create document instances
$documentClass = $this->_query->getOption('documentclass');
$documents = array();
if (isset($this->_data['response']['docs'])) {
foreach ($this->_data['response']['docs'] AS $doc) {
$fields = (array)$doc;
$documents[] = new $documentClass($fields);
}
}
// component results
foreach ($this->_query->getComponents() as $component) {
switch ($component->getType())
{
case Solarium_Query_Select_Component::MORELIKETHIS:
$this->_addMoreLikeThis($component);
break;
case Solarium_Query_Select_Component::FACETSET:
$this->_addFacetSet($component);
break;
case Solarium_Query_Select_Component::DISMAX:
// no result action needed
break;
case Solarium_Query_Select_Component::HIGHLIGHTING:
$this->_addHighlighting($component);
break;
default:
throw new Solarium_Exception('Unknown component type');
}
}
// add general data
$status = $this->_data['responseHeader']['status'];
$queryTime = $this->_data['responseHeader']['QTime'];
$numFound = $this->_data['response']['numFound'];
// create the result instance that combines all data
$resultClass = $this->_query->getOption('resultclass');
return new $resultClass(
$status, $queryTime, $numFound, $documents, $this->_facets, $this->_components
);
}
protected function _addFacetSet($facetSet)
{ {
// create facet results $facets = array();
foreach ($facetSet->getFacets() AS $facet) { foreach ($facetSet->getFacets() AS $key => $facet) {
switch ($facet->getType()) { switch ($facet->getType()) {
case Solarium_Query_Select_Component_Facet::FIELD: case Solarium_Query_Select_Component_Facet::FIELD:
$this->_addFacetField($facet); $result = $this->_facetField($facet, $data);
break; break;
case Solarium_Query_Select_Component_Facet::QUERY: case Solarium_Query_Select_Component_Facet::QUERY:
$this->_addFacetQuery($facet); $result = $this->_facetQuery($facet, $data);
break; break;
case Solarium_Query_Select_Component_Facet::MULTIQUERY: case Solarium_Query_Select_Component_Facet::MULTIQUERY:
$this->_addFacetMultiQuery($facet); $result = $this->_facetMultiQuery($facet, $data);
break; break;
case Solarium_Query_Select_Component_Facet::RANGE: case Solarium_Query_Select_Component_Facet::RANGE:
$this->_addFacetRange($facet); $result = $this->_facetRange($facet, $data);
break; break;
default: default:
throw new Solarium_Exception('Unknown facet type'); throw new Solarium_Exception('Unknown facet type');
} }
if($result !== null) $facets[$key] = $result;
} }
return new Solarium_Result_Select_FacetSet($facets);
} }
/** /**
* Add a facet result for a field facet * Add a facet result for a field facet
* *
* @param Solarium_Query_Select_Component_Facet_Field $facet * @param Solarium_Query_Select_Component_Facet_Field $facet
* @param array $data
* @return void * @return void
*/ */
protected function _addFacetField($facet) protected function _facetField($facet, $data)
{ {
$key = $facet->getKey(); $key = $facet->getKey();
if (isset($this->_data['facet_counts']['facet_fields'][$key])) { if (isset($data['facet_counts']['facet_fields'][$key])) {
$values = array_chunk( $values = array_chunk(
$this->_data['facet_counts']['facet_fields'][$key], $data['facet_counts']['facet_fields'][$key],
2 2
); );
...@@ -159,8 +101,7 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response ...@@ -159,8 +101,7 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response
$facetValues[$value[0]] = $value[1]; $facetValues[$value[0]] = $value[1];
} }
$this->_facets[$key] = return new Solarium_Result_Select_Facet_Field($facetValues);
new Solarium_Result_Select_Facet_Field($facetValues);
} }
} }
...@@ -168,16 +109,16 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response ...@@ -168,16 +109,16 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response
* Add a facet result for a facet query * Add a facet result for a facet query
* *
* @param Solarium_Query_Select_Component_Facet_Query $facet * @param Solarium_Query_Select_Component_Facet_Query $facet
* @param array $data
* @return void * @return void
*/ */
protected function _addFacetQuery($facet) protected function _facetQuery($facet, $data)
{ {
$key = $facet->getKey(); $key = $facet->getKey();
if (isset($this->_data['facet_counts']['facet_queries'][$key])) { if (isset($data['facet_counts']['facet_queries'][$key])) {
$value = $this->_data['facet_counts']['facet_queries'][$key]; $value = $data['facet_counts']['facet_queries'][$key];
$this->_facets[$key] = return new Solarium_Result_Select_Facet_Query($value);
new Solarium_Result_Select_Facet_Query($value);
} }
} }
...@@ -185,21 +126,21 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response ...@@ -185,21 +126,21 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response
* Add a facet result for a multiquery facet * Add a facet result for a multiquery facet
* *
* @param Solarium_Query_Select_Component_Facet_MultiQuery $facet * @param Solarium_Query_Select_Component_Facet_MultiQuery $facet
* @param array $data
* @return void * @return void
*/ */
protected function _addFacetMultiQuery($facet) protected function _facetMultiQuery($facet, $data)
{ {
$values = array(); $values = array();
foreach ($facet->getQueries() AS $query) { foreach ($facet->getQueries() AS $query) {
$key = $query->getKey(); $key = $query->getKey();
if (isset($this->_data['facet_counts']['facet_queries'][$key])) { if (isset($data['facet_counts']['facet_queries'][$key])) {
$count = $this->_data['facet_counts']['facet_queries'][$key]; $count = $data['facet_counts']['facet_queries'][$key];
$values[$key] = $count; $values[$key] = $count;
} }
} }
$this->_facets[$facet->getKey()] = return new Solarium_Result_Select_Facet_MultiQuery($values);
new Solarium_Result_Select_Facet_MultiQuery($values);
} }
...@@ -207,80 +148,22 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response ...@@ -207,80 +148,22 @@ class Solarium_Client_Response_Select extends Solarium_Client_Response
* Add a facet result for a range facet * Add a facet result for a range facet
* *
* @param Solarium_Query_Select_Component_Facet_Range $facet * @param Solarium_Query_Select_Component_Facet_Range $facet
* @param array $data
* @return void * @return void
*/ */
protected function _addFacetRange($facet) protected function _facetRange($facet, $data)
{ {
$key = $facet->getKey(); $key = $facet->getKey();
if (isset($this->_data['facet_counts']['facet_ranges'][$key])) { if (isset($data['facet_counts']['facet_ranges'][$key])) {
$data = $this->_data['facet_counts']['facet_ranges'][$key]; $data = $data['facet_counts']['facet_ranges'][$key];
$before = (isset($data['before'])) ? $data['before'] : null; $before = (isset($data['before'])) ? $data['before'] : null;
$after = (isset($data['after'])) ? $data['after'] : null; $after = (isset($data['after'])) ? $data['after'] : null;
$between = (isset($data['after'])) ? $data['after'] : null; $between = (isset($data['after'])) ? $data['after'] : null;
$this->_facets[$key] = return new Solarium_Result_Select_Facet_Range($data['counts'], $before, $after, $between);
new Solarium_Result_Select_Facet_Range($data['counts'], $before, $after, $between);
}
}
/**
* Add morelikethis result
*
* @param Solarium_Query_Select_Component_MoreLikeThis $component
* @return void
*/
protected function _addMoreLikeThis($component)
{
$results = array();
if (isset($this->_data['moreLikeThis'])) {
$documentClass = $this->_query->getOption('documentclass');
$searchResults = $this->_data['moreLikeThis'];
foreach ($searchResults AS $key => $result) {
// create document instances
$docs = array();
foreach ($result['docs'] AS $fields) {
$docs[] = new $documentClass($fields);
}
$results[$key] = new Solarium_Result_Select_MoreLikeThis_Result(
$result['numFound'],
$result['maxScore'],
$docs
);
}
} }
$moreLikeThis = new Solarium_Result_Select_MoreLikeThis($results);
$this->_components[$component->getType()] = $moreLikeThis;
} }
/**
* Add highlighting result
*
* @param Solarium_Query_Select_Component_Highlighting $component
* @return void
*/
protected function _addHighlighting($component)
{
$results = array();
if (isset($this->_data['highlighting'])) {
$highlightResults = $this->_data['highlighting'];
foreach ($highlightResults AS $key => $result) {
$results[$key] = new Solarium_Result_Select_Highlighting_Result(
$result
);
}
}
$highlighting = new Solarium_Result_Select_Highlighting($results);
$this->_components[$component->getType()] = $highlighting;
}
} }
\ No newline at end of file
library/Solarium/Client/ResponseParser/Select/Component/Highlighting.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Parse select component Highlighting result from the data
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_ResponseParser_Select_Component_Highlighting
{
/**
* Parse result data into result objects
*
* @param Solarium_Query_Select $query
* @param Solarium_Query_Select_Component_Highlighting $highlighting
* @param array $data
* @return Solarium_Result_Select_Highlighting
*/
public function parse($query, $highlighting, $data)
{
$results = array();
if (isset($data['highlighting'])) {
$highlightResults = $data['highlighting'];
foreach ($highlightResults AS $key => $result) {
$results[$key] = new Solarium_Result_Select_Highlighting_Result(
$result
);
}
}
return new Solarium_Result_Select_Highlighting($results);
}
}
\ No newline at end of file
library/Solarium/Client/ResponseParser/Select/Component/MoreLikeThis.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Client
*/
/**
* Parse select component MoreLikeThis result from the data
*
* @package Solarium
* @subpackage Client
*/
class Solarium_Client_ResponseParser_Select_Component_MoreLikeThis
{
/**
* Parse result data into result objects
*
* @param Solarium_Query_Select $query
* @param Solarium_Query_Select_Component_MoreLikeThis $moreLikeThis
* @param array $data
* @return Solarium_Result_Select_MoreLikeThis
*/
public function parse($query, $moreLikeThis, $data)
{
$results = array();
if (isset($data['moreLikeThis'])) {
$documentClass = $query->getOption('documentclass');
$searchResults = $data['moreLikeThis'];
foreach ($searchResults AS $key => $result) {
// create document instances
$docs = array();
foreach ($result['docs'] AS $fields) {
$docs[] = new $documentClass($fields);
}
$results[$key] = new Solarium_Result_Select_MoreLikeThis_Result(
$result['numFound'],
$result['maxScore'],
$docs
);
}
}
return new Solarium_Result_Select_MoreLikeThis($results);
}
}
\ No newline at end of file
library/Solarium/Client/Response/Update.php → library/Solarium/Client/ResponseParser/Update.php
View file @ 2f1edbf2
...@@ -38,29 +38,27 @@ ...@@ -38,29 +38,27 @@
/** /**
* Parse update response data * Parse update response data
* *
* Will create a result object based on response data of the type
* {@Solarium_Result_Update} (or your own resultclass setting)
*
* @package Solarium * @package Solarium
* @subpackage Client * @subpackage Client
*/ */
class Solarium_Client_Response_Update extends Solarium_Client_Response class Solarium_Client_ResponseParser_Update extends Solarium_Client_ResponseParser
{ {
/** /**
* Get a result instance for the response * Parse response data
*
* When this method is called the actual response parsing is done.
* *
* @return mixed * @param Solarium_Result_Select $result
* @return array
*/ */
public function getResult() public function parse($result)
{ {
$resultClass = $this->_query->getOption('resultclass'); $data = $result->getData();
$query = $result->getQuery();
$resultClass = $query->getResultClass();
return new $resultClass( return array(
$this->_data['responseHeader']['status'], 'status' => $data['responseHeader']['status'],
$this->_data['responseHeader']['QTime'] 'querytime' => $data['responseHeader']['QTime'],
); );
} }
......
library/Solarium/Configurable.php
View file @ 2f1edbf2
...@@ -58,7 +58,7 @@ class Solarium_Configurable ...@@ -58,7 +58,7 @@ class Solarium_Configurable
* Constructor * Constructor
* *
* If options are passed they will be merged with {@link $_options} using * If options are passed they will be merged with {@link $_options} using
* the {@link _setOptions()} method. * the {@link setOptions()} method.
* *
* After handling the options the {@link _init()} method is called. * After handling the options the {@link _init()} method is called.
* *
...@@ -68,7 +68,7 @@ class Solarium_Configurable ...@@ -68,7 +68,7 @@ class Solarium_Configurable
*/ */
public function __construct($options = null) public function __construct($options = null)
{ {
$this->_setOptions($options); $this->setOptions($options);
$this->_init(); $this->_init();
} }
...@@ -87,7 +87,7 @@ class Solarium_Configurable ...@@ -87,7 +87,7 @@ class Solarium_Configurable
* *
* @return void * @return void
*/ */
protected function _setOptions($options, $overwrite = false) public function setOptions($options, $overwrite = false)
{ {
if (null !== $options) { if (null !== $options) {
// first convert to array if needed // first convert to array if needed
...@@ -105,6 +105,9 @@ class Solarium_Configurable ...@@ -105,6 +105,9 @@ class Solarium_Configurable
} else { } else {
$this->_options = array_merge($this->_options, $options); $this->_options = array_merge($this->_options, $options);
} }
// re-init for new options
$this->_init();
} }
} }
......
library/Solarium/Query.php
View file @ 2f1edbf2
...@@ -41,8 +41,15 @@ ...@@ -41,8 +41,15 @@
* @package Solarium * @package Solarium
* @subpackage Query * @subpackage Query
*/ */
class Solarium_Query extends Solarium_Configurable abstract class Solarium_Query extends Solarium_Configurable
{ {
/**
* Get type for this query
*
* @return string
*/
abstract public function getType();
/** /**
* Set handler option * Set handler option
......
library/Solarium/Query/Ping.php
View file @ 2f1edbf2
...@@ -48,6 +48,16 @@ ...@@ -48,6 +48,16 @@
class Solarium_Query_Ping extends Solarium_Query class Solarium_Query_Ping extends Solarium_Query
{ {
/**
* Get type for this query
*
* @return string
*/
public function getType()
{
return Solarium_Client::QUERYTYPE_PING;
}
/** /**
* Default options * Default options
* *
......
library/Solarium/Query/Select.php
View file @ 2f1edbf2
...@@ -54,6 +54,24 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -54,6 +54,24 @@ class Solarium_Query_Select extends Solarium_Query
const SORT_DESC = 'desc'; const SORT_DESC = 'desc';
const SORT_ASC = 'asc'; const SORT_ASC = 'asc';
/**
* Query components
*/
const COMPONENT_FACETSET = 'facetset';
const COMPONENT_DISMAX = 'dismax';
const COMPONENT_MORELIKETHIS = 'morelikethis';
const COMPONENT_HIGHLIGHTING = 'highlighting';
/**
* Get type for this query
*
* @return string
*/
public function getType()
{
return Solarium_Client::QUERYTYPE_SELECT;
}
/** /**
* Default options * Default options
* *
...@@ -69,6 +87,34 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -69,6 +87,34 @@ class Solarium_Query_Select extends Solarium_Query
'fields' => '*,score', 'fields' => '*,score',
); );
/**
* Default select query component types
*
* @var array
*/
protected $_componentTypes = array(
self::COMPONENT_FACETSET => array(
'component' => 'Solarium_Query_Select_Component_FacetSet',
'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_FacetSet',
'responseparser' => 'Solarium_Client_ResponseParser_Select_Component_FacetSet',
),
self::COMPONENT_DISMAX => array(
'component' => 'Solarium_Query_Select_Component_DisMax',
'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_DisMax',
'responseparser' => null,
),
self::COMPONENT_MORELIKETHIS => array(
'component' => 'Solarium_Query_Select_Component_MoreLikeThis',
'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_MoreLikeThis',
'responseparser' => 'Solarium_Client_ResponseParser_Select_Component_MoreLikeThis',
),
self::COMPONENT_HIGHLIGHTING => array(
'component' => 'Solarium_Query_Select_Component_Highlighting',
'requestbuilder' => 'Solarium_Client_RequestBuilder_Select_Component_Highlighting',
'responseparser' => 'Solarium_Client_ResponseParser_Select_Component_Highlighting',
),
);
/** /**
* Fields to fetch * Fields to fetch
* *
...@@ -537,6 +583,36 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -537,6 +583,36 @@ class Solarium_Query_Select extends Solarium_Query
$this->addFilterQueries($filterQueries); $this->addFilterQueries($filterQueries);
} }
/**
* Get all registered component types
*
* @return array
*/
public function getComponentTypes()
{
return $this->_componentTypes;
}
/**
* Register a component type
*
* @param string $key
* @param string $component
* @param string $requestBuilder
* @param string $responseParser
* @return Solarium_Query Provides fluent interface
*/
public function registerComponentType($key, $component, $requestBuilder=null, $responseParser=null)
{
$this->_componentTypes[$key] = array(
'component' => $component,
'requestbuilder' => $requestBuilder,
'responseparser' => $responseParser,
);
return $this;
}
/** /**
* Get all registered components * Get all registered components
* *
...@@ -566,16 +642,16 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -566,16 +642,16 @@ class Solarium_Query_Select extends Solarium_Query
if ($autoload == true) { if ($autoload == true) {
switch ($key) { switch ($key) {
case Solarium_Query_Select_Component::MORELIKETHIS: case Solarium_Query_Select::COMPONENT_MORELIKETHIS:
$className = 'Solarium_Query_Select_Component_MoreLikeThis'; $className = 'Solarium_Query_Select_Component_MoreLikeThis';
break; break;
case Solarium_Query_Select_Component::FACETSET: case Solarium_Query_Select::COMPONENT_FACETSET:
$className = 'Solarium_Query_Select_Component_FacetSet'; $className = 'Solarium_Query_Select_Component_FacetSet';
break; break;
case Solarium_Query_Select_Component::DISMAX: case Solarium_Query_Select::COMPONENT_DISMAX:
$className = 'Solarium_Query_Select_Component_DisMax'; $className = 'Solarium_Query_Select_Component_DisMax';
break; break;
case Solarium_Query_Select_Component::HIGHLIGHTING: case Solarium_Query_Select::COMPONENT_HIGHLIGHTING:
$className = 'Solarium_Query_Select_Component_Highlighting'; $className = 'Solarium_Query_Select_Component_Highlighting';
break; break;
default: default:
...@@ -642,7 +718,7 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -642,7 +718,7 @@ class Solarium_Query_Select extends Solarium_Query
*/ */
public function getMoreLikeThis() public function getMoreLikeThis()
{ {
return $this->getComponent(Solarium_Query_Select_Component::MORELIKETHIS, true); return $this->getComponent(Solarium_Query_Select::COMPONENT_MORELIKETHIS, true);
} }
/** /**
...@@ -654,7 +730,7 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -654,7 +730,7 @@ class Solarium_Query_Select extends Solarium_Query
*/ */
public function getFacetSet() public function getFacetSet()
{ {
return $this->getComponent(Solarium_Query_Select_Component::FACETSET, true); return $this->getComponent(Solarium_Query_Select::COMPONENT_FACETSET, true);
} }
/** /**
...@@ -666,7 +742,7 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -666,7 +742,7 @@ class Solarium_Query_Select extends Solarium_Query
*/ */
public function getDisMax() public function getDisMax()
{ {
return $this->getComponent(Solarium_Query_Select_Component::DISMAX, true); return $this->getComponent(Solarium_Query_Select::COMPONENT_DISMAX, true);
} }
/** /**
...@@ -678,7 +754,7 @@ class Solarium_Query_Select extends Solarium_Query ...@@ -678,7 +754,7 @@ class Solarium_Query_Select extends Solarium_Query
*/ */
public function getHighlighting() public function getHighlighting()
{ {
return $this->getComponent(Solarium_Query_Select_Component::HIGHLIGHTING, true); return $this->getComponent(Solarium_Query_Select::COMPONENT_HIGHLIGHTING, true);
} }
/** /**
......
library/Solarium/Query/Select/Component.php
View file @ 2f1edbf2
...@@ -44,14 +44,6 @@ ...@@ -44,14 +44,6 @@
class Solarium_Query_Select_Component extends Solarium_Configurable class Solarium_Query_Select_Component extends Solarium_Configurable
{ {
/**
* Component types
*/
const MORELIKETHIS = 'morelikethis';
const FACETSET = 'facetset';
const DISMAX = 'dismax';
const HIGHLIGHTING = 'highlighting';
/** /**
* Component type * Component type
* *
......
library/Solarium/Query/Select/Component/DisMax.php
View file @ 2f1edbf2
...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_DisMax extends Solarium_Query_Select_Compo ...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_DisMax extends Solarium_Query_Select_Compo
* *
* @var string * @var string
*/ */
protected $_type = self::DISMAX; protected $_type = Solarium_Query_Select::COMPONENT_DISMAX;
/** /**
* Set QueryAlternative option * Set QueryAlternative option
......
library/Solarium/Query/Select/Component/FacetSet.php
View file @ 2f1edbf2
...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_FacetSet extends Solarium_Query_Select_Com ...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_FacetSet extends Solarium_Query_Select_Com
* *
* @var string * @var string
*/ */
protected $_type = self::FACETSET; protected $_type = Solarium_Query_Select::COMPONENT_FACETSET;
/** /**
* Default options * Default options
......
library/Solarium/Query/Select/Component/Highlighting.php
View file @ 2f1edbf2
...@@ -56,7 +56,7 @@ class Solarium_Query_Select_Component_Highlighting extends Solarium_Query_Select ...@@ -56,7 +56,7 @@ class Solarium_Query_Select_Component_Highlighting extends Solarium_Query_Select
* *
* @var string * @var string
*/ */
protected $_type = self::HIGHLIGHTING; protected $_type = Solarium_Query_Select::COMPONENT_HIGHLIGHTING;
/** /**
* Set fields option * Set fields option
......
library/Solarium/Query/Select/Component/MoreLikeThis.php
View file @ 2f1edbf2
...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_MoreLikeThis extends Solarium_Query_Select ...@@ -51,7 +51,7 @@ class Solarium_Query_Select_Component_MoreLikeThis extends Solarium_Query_Select
* *
* @var string * @var string
*/ */
protected $_type = self::MORELIKETHIS; protected $_type = Solarium_Query_Select::COMPONENT_MORELIKETHIS;
/** /**
* Set fields option * Set fields option
......
library/Solarium/Query/Update.php
View file @ 2f1edbf2
...@@ -48,6 +48,16 @@ ...@@ -48,6 +48,16 @@
class Solarium_Query_Update extends Solarium_Query class Solarium_Query_Update extends Solarium_Query
{ {
/**
* Get type for this query
*
* @return string
*/
public function getType()
{
return Solarium_Client::QUERYTYPE_UPDATE;
}
/** /**
* Default options * Default options
* *
......
library/Solarium/Result.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Result
*/
/**
* Query result
*
* This base class provides access to the response and decoded data. If you need more functionality
* like resultset parsing use one of the subclasses
*
* @package Solarium
* @subpackage Result
*/
class Solarium_Result
{
/**
* Response object
*
* @var Solarium_Client_Response
*/
protected $_response;
/**
* Decode response data
*
* This is lazy loaded, see getData()
*
* @var array
*/
protected $_data;
/**
* Query used for this request
*
* @var Solarium_Query
*/
protected $_query;
/**
* @var Solarium_Client
*/
protected $_client;
/**
* Constructor
*
* @param Solarium_Client $client
* @param Solarium_Query $query
* @param Solarium_Client_Response $response
* @return void
*/
public function __construct($client, $query, $response)
{
$this->_client = $client;
$this->_query = $query;
$this->_response = $response;
// check status for error (range of 400 and 500)
$statusNum = floor($response->getStatusCode() / 100);
if ($statusNum == 4 || $statusNum == 5) {
throw new Solarium_Client_HttpException(
$response->getStatusMessage(),
$response->getStatusCode()
);
}
}
/**
* Get response object
*
* This is the raw HTTP response object, not the parsed data!
*
* @return Solarium_Client_Response
*/
public function getResponse()
{
return $this->_response;
}
/**
* Get query instance
*
* @return Solarium_Query
*/
public function getQuery()
{
return $this->_query;
}
/**
* Get Solr response data
*
* Included a lazy loading mechanism: JSON body data is decoded on first use and then saved for reuse.
*
* @return array
*/
public function getData()
{
if (null == $this->_data) {
$this->_data = json_decode($this->_response->getBody(), true);
if (null === $this->_data) {
throw new Solarium_Exception(
'Solr JSON response could not be decoded'
);
}
}
return $this->_data;
}
}
\ No newline at end of file
library/Solarium/Result/QueryType.php 0 → 100644
View file @ 2f1edbf2
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @package Solarium
* @subpackage Result
*/
/**
* QueryType result
*
* TODO intro
*
* @package Solarium
* @subpackage Result
*/
class Solarium_Result_QueryType extends Solarium_Result
{
/**
* Lazy load parsing indicator
*
* @var bool
*/
protected $_parsed = false;
/**
* Parse response into result objects
*
* Only runs once
*
* @return void
*/
protected function _parseResponse()
{
if (!$this->_parsed) {
$queryType = $this->_query->getType();
$queryTypes = $this->_client->getQueryTypes();
if (!isset($queryTypes[$queryType])) {
throw new Solarium_Exception('No responseparser registered for querytype: '. $queryType);
}
$responseParserClass = $queryTypes[$queryType]['responseparser'];
$responseParser = new $responseParserClass;
$this->_mapData($responseParser->parse($this));
}
}
/**
* Map parser data into properties
*
* @param array $mapData
* @return void
*/
protected function _mapData($mapData)
{
foreach($mapData AS $key => $data) {
$this->{'_'.$key} = $data;
}
}
}
\ No newline at end of file
library/Solarium/Result/Select.php
View file @ 2f1edbf2
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
* @package Solarium * @package Solarium
* @subpackage Result * @subpackage Result
*/ */
class Solarium_Result_Select extends Solarium_Result_Query class Solarium_Result_Select extends Solarium_Result_QueryType
implements IteratorAggregate, Countable implements IteratorAggregate, Countable
{ {
...@@ -69,7 +69,7 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -69,7 +69,7 @@ class Solarium_Result_Select extends Solarium_Result_Query
* *
* @var int * @var int
*/ */
protected $_numFound; protected $_numfound;
/** /**
* Document instances array * Document instances array
...@@ -78,43 +78,11 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -78,43 +78,11 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
protected $_documents; protected $_documents;
/**
* Facet result instances
*
* @var array
*/
protected $_facets;
/** /**
* Component results * Component results
*/ */
protected $_components; protected $_components;
/**
* Constructor
*
* This is the only point where data can be set in this immutable value
* object.
*
* @param int $status
* @param int $queryTime
* @param int $numFound
* @param array $documents
* @param array $facets
* @param array $components
* @return void
*/
public function __construct($status, $queryTime, $numFound, $documents,
$facets, $components)
{
$this->_status = $status;
$this->_queryTime = $queryTime;
$this->_numFound = $numFound;
$this->_documents = $documents;
$this->_facets = $facets;
$this->_components = $components;
}
/** /**
* get Solr numFound * get Solr numFound
* *
...@@ -125,7 +93,9 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -125,7 +93,9 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getNumFound() public function getNumFound()
{ {
return $this->_numFound; $this->_parseResponse();
return $this->_numfound;
} }
/** /**
...@@ -135,32 +105,9 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -135,32 +105,9 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getDocuments() public function getDocuments()
{ {
return $this->_documents; $this->_parseResponse();
}
/**
* Get all facet results
*
* @return array
*/
public function getFacets()
{
return $this->_facets;
}
/** return $this->_documents;
* Get a facet result by key
*
* @param string $key
* @return Solarium_Result_Select_Facet
*/
public function getFacet($key)
{
if (isset($this->_facets[$key])) {
return $this->_facets[$key];
} else {
return null;
}
} }
/** /**
...@@ -170,6 +117,8 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -170,6 +117,8 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getIterator() public function getIterator()
{ {
$this->_parseResponse();
return new ArrayIterator($this->_documents); return new ArrayIterator($this->_documents);
} }
...@@ -180,6 +129,8 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -180,6 +129,8 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function count() public function count()
{ {
$this->_parseResponse();
return count($this->_documents); return count($this->_documents);
} }
...@@ -190,6 +141,8 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -190,6 +141,8 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getComponents() public function getComponents()
{ {
$this->_parseResponse();
return $this->_components; return $this->_components;
} }
...@@ -201,6 +154,8 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -201,6 +154,8 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getComponent($key) public function getComponent($key)
{ {
$this->_parseResponse();
if (isset($this->_components[$key])) { if (isset($this->_components[$key])) {
return $this->_components[$key]; return $this->_components[$key];
} else { } else {
...@@ -217,7 +172,7 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -217,7 +172,7 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getMoreLikeThis() public function getMoreLikeThis()
{ {
return $this->getComponent(Solarium_Query_Select_Component::MORELIKETHIS); return $this->getComponent(Solarium_Query_Select::COMPONENT_MORELIKETHIS);
} }
/** /**
...@@ -229,6 +184,18 @@ class Solarium_Result_Select extends Solarium_Result_Query ...@@ -229,6 +184,18 @@ class Solarium_Result_Select extends Solarium_Result_Query
*/ */
public function getHighlighting() public function getHighlighting()
{ {
return $this->getComponent(Solarium_Query_Select_Component::HIGHLIGHTING); return $this->getComponent(Solarium_Query_Select::COMPONENT_HIGHLIGHTING);
}
/**
* Get facetset component result
*
* This is a convenience method that maps presets to getComponent
*
* @return Solarium_Result_Select_Component_FacetSet
*/
public function getFacetSet()
{
return $this->getComponent(Solarium_Query_Select::COMPONENT_HIGHLIGHTING);
} }
} }
\ No newline at end of file
library/Solarium/Result/Query.php → library/Solarium/Result/Select/FacetSet.php
View file @ 2f1edbf2
...@@ -36,69 +36,74 @@ ...@@ -36,69 +36,74 @@
*/ */
/** /**
* Query result * Select component facetset result
*
* This base class provides methods for two common result values: status and
* querytime.
* *
* @package Solarium * @package Solarium
* @subpackage Result * @subpackage Result
*/ */
class Solarium_Result_Query class Solarium_Result_Select_FacetSet implements IteratorAggregate, Countable
{ {
/** /**
* Status code returned by Solr * Facet array
* *
* @var int * @var array
*/ */
protected $_status; protected $_facets;
/** /**
* Solr index queryTime * Constructor
*
* This doesn't include things like the HTTP responsetime. Purely the Solr
* query execution time.
* *
* @var int * @param array $facets
* @return void
*/ */
protected $_queryTime; public function __construct($facets)
{
$this->_facets = $facets;
}
/** /**
* Constructor * Get a facet by key
* *
* @param int $status * @param mixed $key
* @param int $queryTime * @return mixed
* @return void
*/ */
public function __construct($status, $queryTime) public function getFacet($key)
{ {
$this->_status = $status; if (isset($this->_facets[$key])) {
$this->_queryTime = $queryTime; return $this->_facets[$key];
} else {
return null;
}
} }
/** /**
* Get Solr status code * Get all results
* *
* This is not the HTTP status code! The normal value for success is 0. * @return array
*/
public function getFacets()
{
return $this->_facets;
}
/**
* IteratorAggregate implementation
* *
* @return int * @return ArrayIterator
*/ */
public function getStatus() public function getIterator()
{ {
return $this->_status; return new ArrayIterator($this->_facets);
} }
/** /**
* Get Solr query time * Countable implementation
* *
* This doesn't include things like the HTTP responsetime. Purely the Solr
* query execution time.
*
* @return int * @return int
*/ */
public function getQueryTime() public function count()
{ {
return $this->_queryTime; return count($this->_facets);
} }
} }
\ No newline at end of file
library/Solarium/Result/Update.php
View file @ 2f1edbf2
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
* @package Solarium * @package Solarium
* @subpackage Result * @subpackage Result
*/ */
class Solarium_Result_Update extends Solarium_Result_Query class Solarium_Result_Update extends Solarium_Result
{ {
} }
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment