Skip to content

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

Lots of code style fixes using php-cs (cs.sensiolabs.org)

parent 1ad41093
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 1292 additions and 1291 deletions
library/Solarium/Autoloader.php
View file @ b3963553
......@@ -61,7 +61,7 @@ class Autoloader
* @static
* @return void
*/
static public function register()
public static function register()
{
spl_autoload_register(array(new self, 'load'));
}
......@@ -73,10 +73,10 @@ class Autoloader
* The autoloader only acts for classnames that start with 'Solarium'.
*
* @static
* @param string $class
* @param string $class
* @return void
*/
static public function load($class)
public static function load($class)
{
if (substr($class, 0, 8) == 'Solarium') {
......@@ -92,4 +92,4 @@ class Autoloader
}
}
}
\ No newline at end of file
}
library/Solarium/Client.php
View file @ b3963553
......@@ -72,7 +72,6 @@ class Client extends CoreClient
*/
const VERSION = '3.0.0';
/**
* Check for an exact version
*
......@@ -97,15 +96,14 @@ class Client extends CoreClient
* @internal a string compare is used instead of version_compare because
* version_compare returns false for a compare of 1.0.0 with 1.0
*
* @param string $version
* @param string $version
* @return boolean
*/
static public function checkExact($version)
public static function checkExact($version)
{
return (substr(self::VERSION, 0, strlen($version)) == $version);
}
/**
* Check for a minimal version
*
......@@ -125,12 +123,12 @@ class Client extends CoreClient
* - 2 (the actual version is lower)
* - 1.3 (the actual version is lower)
*
* @param string $version
* @param string $version
* @return boolean
*/
static public function checkMinimal($version)
public static function checkMinimal($version)
{
return version_compare(self::VERSION, $version, '>=');
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/Adapter/AdapterInterface.php
View file @ b3963553
......@@ -63,10 +63,10 @@ interface AdapterInterface extends ConfigurableInterface
/**
* Execute a request
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return Response
*/
function execute($request, $endpoint);
public function execute($request, $endpoint);
}
\ No newline at end of file
}
library/Solarium/Core/Client/Adapter/Curl.php
View file @ b3963553
......@@ -71,8 +71,8 @@ class Curl extends Configurable implements AdapterInterface
/**
* Execute a Solr request using the cURL Http
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return Response
*/
public function execute($request, $endpoint)
......@@ -83,8 +83,8 @@ class Curl extends Configurable implements AdapterInterface
/**
* Execute request
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return array
*/
protected function getData($request, $endpoint)
......@@ -100,8 +100,8 @@ class Curl extends Configurable implements AdapterInterface
/**
* Get the response for a curl handle
*
* @param resource $handle
* @param string $httpResponse
* @param resource $handle
* @param string $httpResponse
* @return Response
*/
public function getResponse($handle, $httpResponse)
......@@ -119,6 +119,7 @@ class Curl extends Configurable implements AdapterInterface
curl_close($handle);
$this->check($data, $headers);
return new Response($data, $headers);
// @codeCoverageIgnoreEnd
}
......@@ -126,8 +127,8 @@ class Curl extends Configurable implements AdapterInterface
/**
* Create curl handle for a request
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return resource
*/
public function createHandle($request, $endpoint)
......@@ -159,10 +160,10 @@ class Curl extends Configurable implements AdapterInterface
curl_setopt($handler, CURLOPT_POST, true);
curl_setopt($handler, CURLOPT_POSTFIELDS, $request->getRawData());
$httpResponse = curl_exec($handler);
} else if ($method == Request::METHOD_GET) {
} elseif ($method == Request::METHOD_GET) {
curl_setopt($handler, CURLOPT_HTTPGET, true);
$httpResponse = curl_exec($handler);
} else if ($method == Request::METHOD_HEAD) {
} elseif ($method == Request::METHOD_HEAD) {
curl_setopt($handler, CURLOPT_CUSTOMREQUEST, 'HEAD');
$httpResponse = curl_exec($handler);
......@@ -177,8 +178,8 @@ class Curl extends Configurable implements AdapterInterface
/**
* Create http request options from request.
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return array
*/
protected function createOptions($request, $endpoint)
......@@ -193,6 +194,7 @@ class Curl extends Configurable implements AdapterInterface
$options['headers'][$header] = trim($value);
}
}
return $options;
// @codeCoverageIgnoreEnd
}
......@@ -201,8 +203,8 @@ class Curl extends Configurable implements AdapterInterface
* Check result of a request
*
* @throws HttpException
* @param string $data
* @param array $headers
* @param string $data
* @param array $headers
* @return void
*/
public function check($data, $headers)
......
library/Solarium/Core/Client/Adapter/Http.php
View file @ b3963553
......@@ -54,8 +54,8 @@ class Http extends Configurable implements AdapterInterface
* Handle Solr communication
*
* @throws Exception
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return Response
*/
public function execute($request, $endpoint)
......@@ -74,8 +74,8 @@ class Http extends Configurable implements AdapterInterface
* Check result of a request
*
* @throws HttpException
* @param string $data
* @param array $headers
* @param string $data
* @param array $headers
* @return void
*/
public function check($data, $headers)
......@@ -90,8 +90,8 @@ class Http extends Configurable implements AdapterInterface
/**
* Create a stream context for a request
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return resource
*/
public function createContext($request, $endpoint)
......@@ -134,8 +134,8 @@ class Http extends Configurable implements AdapterInterface
/**
* Execute request
*
* @param string $uri
* @param resource $context
* @param string $uri
* @param resource $context
* @return array
*/
protected function getData($uri, $context)
......@@ -153,4 +153,4 @@ class Http extends Configurable implements AdapterInterface
// @codeCoverageIgnoreEnd
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/Adapter/PeclHttp.php
View file @ b3963553
......@@ -72,8 +72,8 @@ class PeclHttp extends Configurable implements AdapterInterface
/**
* Execute a Solr request using the Pecl Http
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return Response
*/
public function execute($request, $endpoint)
......@@ -128,7 +128,7 @@ class PeclHttp extends Configurable implements AdapterInterface
* {@link http://us.php.net/manual/en/http.constants.php
* HTTP Predefined Constant}
*
* @param Request $request
* @param Request $request
* @param Endpoint $endpoint
* @param HttpRequest
*/
......@@ -145,7 +145,7 @@ class PeclHttp extends Configurable implements AdapterInterface
}
}
switch($request->getMethod()) {
switch ($request->getMethod()) {
case Request::METHOD_GET:
$method = HTTP_METH_GET;
break;
......
library/Solarium/Core/Client/Adapter/ZendHttp.php
View file @ b3963553
......@@ -80,9 +80,9 @@ class ZendHttp extends Configurable implements AdapterInterface
* The $options param should be an array or an object that has a toArray
* method, like Zend_Config
*
* @param array|object $options
* @param boolean $overwrite
* @return self Provides fluent interface
* @param array|object $options
* @param boolean $overwrite
* @return self Provides fluent interface
*/
public function setOptions($options, $overwrite = false)
{
......@@ -112,12 +112,13 @@ class ZendHttp extends Configurable implements AdapterInterface
* upon first use, using default and/or custom options (the most common use
* case)
*
* @param \Zend_Http_Client $zendHttp
* @return self Provides fluent interface
* @param \Zend_Http_Client $zendHttp
* @return self Provides fluent interface
*/
public function setZendHttp($zendHttp)
{
$this->zendHttp = $zendHttp;
return $this;
}
......@@ -155,8 +156,8 @@ class ZendHttp extends Configurable implements AdapterInterface
/**
* Execute a Solr request using the Zend_Http_Client instance
*
* @param Request $request
* @param Endpoint $endpoint
* @param Request $request
* @param Endpoint $endpoint
* @return Response
*/
public function execute($request, $endpoint)
......@@ -191,4 +192,4 @@ class ZendHttp extends Configurable implements AdapterInterface
return new Response($data, $headers);
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/Client.php
View file @ b3963553
This diff is collapsed.
library/Solarium/Core/Client/Endpoint.php
View file @ b3963553
......@@ -91,8 +91,8 @@ class Endpoint extends Configurable
/**
* Set key value
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setKey($value)
{
......@@ -102,8 +102,8 @@ class Endpoint extends Configurable
/**
* Set host option
*
* @param string $host This can be a hostname or an IP address
* @return self Provides fluent interface
* @param string $host This can be a hostname or an IP address
* @return self Provides fluent interface
*/
public function setHost($host)
{
......@@ -123,7 +123,7 @@ class Endpoint extends Configurable
/**
* Set port option
*
* @param int $port Common values are 80, 8080 and 8983
* @param int $port Common values are 80, 8080 and 8983
* @return self Provides fluent interface
*/
public function setPort($port)
......@@ -146,8 +146,8 @@ class Endpoint extends Configurable
*
* If the path has a trailing slash it will be removed.
*
* @param string $path
* @return self Provides fluent interface
* @param string $path
* @return self Provides fluent interface
*/
public function setPath($path)
{
......@@ -171,8 +171,8 @@ class Endpoint extends Configurable
/**
* Set core option
*
* @param string $core
* @return self Provides fluent interface
* @param string $core
* @return self Provides fluent interface
*/
public function setCore($core)
{
......@@ -192,7 +192,7 @@ class Endpoint extends Configurable
/**
* Set timeout option
*
* @param int $timeout
* @param int $timeout
* @return self Provides fluent interface
*/
public function setTimeout($timeout)
......@@ -228,4 +228,4 @@ class Endpoint extends Configurable
return $uri;
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/HttpException.php
View file @ b3963553
......@@ -72,7 +72,7 @@ class HttpException extends Exception
* more descriptive text. The original message is available using the
* {@link getStatusMessage} method.
*
* @param string $statusMessage
* @param string $statusMessage
* @param int|null $code
*/
public function __construct($statusMessage, $code = null)
......@@ -97,4 +97,4 @@ class HttpException extends Exception
return $this->statusMessage;
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/Request.php
View file @ b3963553
......@@ -114,12 +114,13 @@ class Request extends Configurable
/**
* Set request handler
*
* @param string $handler
* @return self Provides fluent interface
* @param string $handler
* @return self Provides fluent interface
*/
public function setHandler($handler)
{
$this->setOption('handler', $handler);
return $this;
}
......@@ -138,12 +139,13 @@ class Request extends Configurable
*
* Use one of the constants as value
*
* @param string $method
* @return self Provides fluent interface
* @param string $method
* @return self Provides fluent interface
*/
public function setMethod($method)
{
$this->setOption('method', $method);
return $this;
}
......@@ -160,7 +162,7 @@ class Request extends Configurable
/**
* Get a param value
*
* @param string $key
* @param string $key
* @return string|array
*/
public function getParam($key)
......@@ -185,13 +187,14 @@ class Request extends Configurable
/**
* Set request params
*
* @param array $params
* @return self Provides fluent interface
* @param array $params
* @return self Provides fluent interface
*/
public function setParams($params)
{
$this->clearParams();
$this->addParams($params);
return $this;
}
......@@ -204,10 +207,10 @@ class Request extends Configurable
* 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 self Provides fluent interface
* @param string $key
* @param string|array $value
* @param boolean $overwrite
* @return self Provides fluent interface
*/
public function addParam($key, $value, $overwrite = false)
{
......@@ -235,9 +238,9 @@ class Request extends Configurable
/**
* Add multiple params to the request
*
* @param array $params
* @param boolean $overwrite
* @return self Provides fluent interface
* @param array $params
* @param boolean $overwrite
* @return self Provides fluent interface
*/
public function addParams($params, $overwrite = false)
{
......@@ -251,14 +254,15 @@ class Request extends Configurable
/**
* Remove a param by key
*
* @param string $key
* @return self Provides fluent interface
* @param string $key
* @return self Provides fluent interface
*/
public function removeParam($key)
{
if (isset($this->params[$key])) {
unset($this->params[$key]);
}
return $this;
}
......@@ -270,6 +274,7 @@ class Request extends Configurable
public function clearParams()
{
$this->params = array();
return $this;
}
......@@ -288,12 +293,13 @@ class Request extends Configurable
*
* This string must be safely encoded.
*
* @param string $data
* @return self Provides fluent interface
* @param string $data
* @return self Provides fluent interface
*/
public function setRawData($data)
{
$this->rawData = $data;
return $this;
}
......@@ -310,21 +316,22 @@ class Request extends Configurable
/**
* Set request headers
*
* @param array $headers
* @return self Provides fluent interface
* @param array $headers
* @return self Provides fluent interface
*/
public function setHeaders($headers)
{
$this->clearHeaders();
$this->addHeaders($headers);
return $this;
}
/**
* Add a request header
*
* @param string|array $value
* @return self Provides fluent interface
* @param string|array $value
* @return self Provides fluent interface
*/
public function addHeader($value)
{
......@@ -336,8 +343,8 @@ class Request extends Configurable
/**
* Add multiple headers to the request
*
* @param array $headers
* @return self Provides fluent interface
* @param array $headers
* @return self Provides fluent interface
*/
public function addHeaders($headers)
{
......@@ -356,6 +363,7 @@ class Request extends Configurable
public function clearHeaders()
{
$this->headers = array();
return $this;
}
......@@ -409,4 +417,4 @@ class Request extends Configurable
return $output;
}
}
\ No newline at end of file
}
library/Solarium/Core/Client/Response.php
View file @ b3963553
......@@ -76,7 +76,7 @@ class Response
* Constructor
*
* @param string $body
* @param array $headers
* @param array $headers
*/
public function __construct($body, $headers = array())
{
......@@ -129,7 +129,7 @@ class Response
/**
* Set headers
*
* @param array $headers
* @param array $headers
* @return void
*/
public function setHeaders($headers)
......@@ -156,4 +156,4 @@ class Response
$this->statusCode = $statusInfo[1];
$this->statusMessage = $statusInfo[2];
}
}
\ No newline at end of file
}
library/Solarium/Core/Configurable.php
View file @ b3963553
......@@ -65,7 +65,7 @@ class Configurable implements ConfigurableInterface
* After handling the options the {@link _init()} method is called.
*
* @throws Exception
* @param array|\Zend_Config $options
* @param array|\Zend_Config $options
* @return void
*/
public function __construct($options = null)
......@@ -85,8 +85,8 @@ class Configurable implements ConfigurableInterface
* Zend Framework, but can also easily be implemented in any other object.
*
* @throws Exception
* @param array|\Zend_Config $options
* @param boolean $overwrite True for overwriting existing options, false
* @param array|\Zend_Config $options
* @param boolean $overwrite True for overwriting existing options, false
* for merging (new values overwrite old ones if needed)
*
* @return void
......@@ -138,9 +138,9 @@ class Configurable implements ConfigurableInterface
/**
* Set an option
*
* @param string $name
* @param mixed $value
* @return self Provides fluent interface
* @param string $name
* @param mixed $value
* @return self Provides fluent interface
*/
protected function setOption($name, $value)
{
......@@ -154,7 +154,7 @@ class Configurable implements ConfigurableInterface
*
* If the option is empty or not set a NULL value will be returned.
*
* @param string $name
* @param string $name
* @return mixed
*/
public function getOption($name)
......@@ -176,4 +176,4 @@ class Configurable implements ConfigurableInterface
return $this->options;
}
}
\ No newline at end of file
}
library/Solarium/Core/ConfigurableInterface.php
View file @ b3963553
......@@ -57,10 +57,10 @@ interface ConfigurableInterface
* After handling the options the {@link _init()} method is called.
*
* @throws Exception
* @param array|\Zend_Config $options
* @param array|\Zend_Config $options
* @return void
*/
function __construct($options = null);
public function __construct($options = null);
/**
* Set options
......@@ -70,29 +70,29 @@ interface ConfigurableInterface
* Zend Framework, but can also easily be implemented in any other object.
*
* @throws Exception
* @param array|\Zend_Config $options
* @param boolean $overwrite True for overwriting existing options, false
* @param array|\Zend_Config $options
* @param boolean $overwrite True for overwriting existing options, false
* for merging (new values overwrite old ones if needed)
*
* @return void
*/
function setOptions($options, $overwrite = false);
public function setOptions($options, $overwrite = false);
/**
* Get an option value by name
*
* If the option is empty or not set a NULL value will be returned.
*
* @param string $name
* @param string $name
* @return mixed
*/
function getOption($name);
public function getOption($name);
/**
* Get all options
*
* @return array
*/
function getOptions();
public function getOptions();
}
\ No newline at end of file
}
library/Solarium/Core/Exception.php
View file @ b3963553
......@@ -47,4 +47,4 @@ namespace Solarium\Core;
class Exception extends \Exception
{
}
\ No newline at end of file
}
library/Solarium/Core/Plugin.php
View file @ b3963553
......@@ -63,7 +63,7 @@ abstract class Plugin extends Configurable implements PluginInterface
* This method is called when the plugin is registered to a client instance
*
* @param Client $client
* @param array $options
* @param array $options
*/
public function initPlugin($client, $options)
{
......@@ -89,7 +89,7 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* preCreateRequest hook
*
* @param Query $query
* @param Query $query
* @return void|Request
*/
public function preCreateRequest($query)
......@@ -99,8 +99,8 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* postCreateRequest hook
*
* @param Query $query
* @param Request $request
* @param Query $query
* @param Request $request
* @return void
*/
public function postCreateRequest($query, $request)
......@@ -110,7 +110,7 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* preExecuteRequest hook
*
* @param Request $request
* @param Request $request
* @return void|Response
*/
public function preExecuteRequest($request)
......@@ -120,8 +120,8 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* postExecuteRequest hook
*
* @param Request $request
* @param Response $response
* @param Request $request
* @param Response $response
* @return void
*/
public function postExecuteRequest($request, $response)
......@@ -131,8 +131,8 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* preCreateResult hook
*
* @param Query $query
* @param Response $response
* @param Query $query
* @param Response $response
* @return void|Result
*/
public function preCreateResult($query, $response)
......@@ -142,9 +142,9 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* postCreateResult hook
*
* @param Query $query
* @param Response $response
* @param Result $result
* @param Query $query
* @param Response $response
* @param Result $result
* @return void
*/
public function postCreateResult($query, $response, $result)
......@@ -154,7 +154,7 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* preExecute hook
*
* @param Query $query
* @param Query $query
* @return void|Result
*/
public function preExecute($query)
......@@ -164,8 +164,8 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* postExecute hook
*
* @param Query $query
* @param Result $result
* @param Query $query
* @param Result $result
* @return void
*/
public function postExecute($query, $result)
......@@ -175,8 +175,8 @@ abstract class Plugin extends Configurable implements PluginInterface
/**
* preCreateQuery hook
*
* @param string $type
* @param mixed $options
* @param string $type
* @param mixed $options
* @return void|Query
*/
public function preCreateQuery($type, $options)
......@@ -187,7 +187,7 @@ abstract class Plugin extends Configurable implements PluginInterface
* postCreateQuery hook
*
* @param string $type
* @param mixed $options
* @param mixed $options
* @param Query
* @return void
*/
......@@ -195,4 +195,4 @@ abstract class Plugin extends Configurable implements PluginInterface
{
}
}
\ No newline at end of file
}
library/Solarium/Core/PluginInterface.php
View file @ b3963553
......@@ -55,97 +55,97 @@ interface PluginInterface extends ConfigurableInterface
* This method is called when the plugin is registered to a client instance
*
* @param Client $client
* @param array $options
* @param array $options
*/
function initPlugin($client, $options);
public function initPlugin($client, $options);
/**
* preCreateRequest hook
*
* @param Query $query
* @param Query $query
* @return void|Request
*/
function preCreateRequest($query);
public function preCreateRequest($query);
/**
* postCreateRequest hook
*
* @param Query $query
* @param Request $request
* @param Query $query
* @param Request $request
* @return void
*/
function postCreateRequest($query, $request);
public function postCreateRequest($query, $request);
/**
* preExecuteRequest hook
*
* @param Request $request
* @param Request $request
* @return void|Response
*/
function preExecuteRequest($request);
public function preExecuteRequest($request);
/**
* postExecuteRequest hook
*
* @param Request $request
* @param Response $response
* @param Request $request
* @param Response $response
* @return void
*/
function postExecuteRequest($request, $response);
public function postExecuteRequest($request, $response);
/**
* preCreateResult hook
*
* @param Query $query
* @param Response $response
* @param Query $query
* @param Response $response
* @return void|Result
*/
function preCreateResult($query, $response);
public function preCreateResult($query, $response);
/**
* postCreateResult hook
*
* @param Query $query
* @param Response $response
* @param Result $result
* @param Query $query
* @param Response $response
* @param Result $result
* @return void
*/
function postCreateResult($query, $response, $result);
public function postCreateResult($query, $response, $result);
/**
* preExecute hook
*
* @param Query $query
* @param Query $query
* @return void|Result
*/
function preExecute($query);
public function preExecute($query);
/**
* postExecute hook
*
* @param Query $query
* @param Result $result
* @param Query $query
* @param Result $result
* @return void
*/
function postExecute($query, $result);
public function postExecute($query, $result);
/**
* preCreateQuery hook
*
* @param string $type
* @param mixed $options
* @param string $type
* @param mixed $options
* @return void|Query
*/
function preCreateQuery($type, $options);
public function preCreateQuery($type, $options);
/**
* postCreateQuery hook
*
* @param string $type
* @param mixed $options
* @param mixed $options
* @param Query
* @return void
*/
function postCreateQuery($type, $options, $query);
public function postCreateQuery($type, $options, $query);
}
\ No newline at end of file
}
library/Solarium/Core/Query/Helper.php
View file @ b3963553
......@@ -98,7 +98,7 @@ class Helper
*
* @link http://lucene.apache.org/java/docs/queryparsersyntax.html#Escaping%20Special%20Characters
*
* @param string $input
* @param string $input
* @return string
*/
public function escapeTerm($input)
......@@ -120,7 +120,7 @@ class Helper
* this method, the whole query will be escaped. You need to escape only the
* 'content' of your query.
*
* @param string $input
* @param string $input
* @return string
*/
public function escapePhrase($input)
......@@ -136,20 +136,18 @@ class Helper
*
* @see http://lucene.apache.org/solr/api/org/apache/solr/schema/DateField.html
*
* @param int|string|\DateTime $input accepted formats: timestamp, date string or DateTime
* @return string|boolean false is returned in case of invalid input
* @param int|string|\DateTime $input accepted formats: timestamp, date string or DateTime
* @return string|boolean false is returned in case of invalid input
*/
public function formatDate($input)
{
switch(true){
switch (true) {
// input of datetime object
case $input instanceof \DateTime:
// no work needed
break;
// input of timestamp or date/time string
case is_string($input) || is_numeric($input):
......@@ -166,18 +164,15 @@ class Helper
}
break;
// any other input formats can be added in additional cases here...
// case $input instanceof Zend_Date:
// unsupported input format
default:
$input = false;
break;
}
// handle the filtered input
if ($input) {
// when we get here the input is always a datetime object
......@@ -185,6 +180,7 @@ class Helper
$iso8601 = $input->format(\DateTime::ISO8601);
$iso8601 = strstr($iso8601, '+', true); //strip timezone
$iso8601 .= 'Z';
return $iso8601;
} else {
// unsupported input
......@@ -200,10 +196,10 @@ class Helper
* Example: rangeQuery('store', '45,-94', '46,-93')
* Returns: store:[45,-94 TO 46,-93]
*
* @param string $field
* @param string $from
* @param string $to
* @param boolean $inclusive
* @param string $field
* @param string $from
* @param string $to
* @param boolean $inclusive
* @return string
*/
public function rangeQuery($field, $from, $to, $inclusive = true)
......@@ -246,10 +242,10 @@ class Helper
* guaranteed to encompass all of the points of interest, but it may also
* include other points that are slightly outside of the required distance.
*
* @param string $pointX
* @param string $pointY
* @param string $field
* @param string $distance
* @param string $pointX
* @param string $pointY
* @param string $field
* @param string $distance
* @return string
*/
public function bbox($pointX, $pointY, $field, $distance)
......@@ -289,9 +285,9 @@ class Helper
/**
* Render a qparser plugin call
*
* @param string $name
* @param array $params
* @param boolean $dereferenced
* @param string $name
* @param array $params
* @param boolean $dereferenced
* @return string
*/
public function qparser($name, $params = array(), $dereferenced = false)
......@@ -325,8 +321,8 @@ class Helper
/**
* Render a functionCall
*
* @param string $name
* @param array $params
* @param string $name
* @param array $params
* @return string
*/
public function functionCall($name, $params = array())
......@@ -353,8 +349,8 @@ class Helper
*
* @since 2.1.0
*
* @param string $query
* @param array $parts Array of strings
* @param string $query
* @param array $parts Array of strings
* @return string
*/
public function assemble($query, $parts)
......@@ -372,7 +368,7 @@ class Helper
* Render placeholders in a querystring
*
* @throws Exception
* @param array $matches
* @param array $matches
* @return string
*/
protected function renderPlaceHolder($matches)
......@@ -386,8 +382,7 @@ class Helper
throw new Exception('No value supplied for part #' . $partNumber . ' in query assembler');
}
switch($partMode)
{
switch ($partMode) {
case 'P':
$value = $this->escapePhrase($value);
break;
......@@ -405,9 +400,9 @@ class Helper
* @see http://wiki.apache.org/solr/Join
* @since 2.4.0
*
* @param string $from
* @param string $to
* @param boolean $dereferenced
* @param string $from
* @param string $to
* @param boolean $dereferenced
* @return string
*/
public function join($from, $to, $dereferenced = false)
......
library/Solarium/Core/Query/Query.php
View file @ b3963553
......@@ -63,8 +63,8 @@ abstract class Query extends Configurable implements QueryInterface
/**
* Set handler option
*
* @param string $handler
* @return self Provides fluent interface
* @param string $handler
* @return self Provides fluent interface
*/
public function setHandler($handler)
{
......@@ -91,8 +91,8 @@ abstract class Query extends Configurable implements QueryInterface
* Also you need to make sure it extends the orginal result class of the
* query or has an identical API.
*
* @param string $classname
* @return self Provides fluent interface
* @param string $classname
* @return self Provides fluent interface
*/
public function setResultClass($classname)
{
......@@ -131,13 +131,14 @@ abstract class Query extends Configurable implements QueryInterface
* Only intended for internal use, for instance with dereferenced params.
* Therefore the params are limited in functionality. Only add and get
*
* @param string $name
* @param string $value
* @return self Provides fluent interface
* @param string $name
* @param string $value
* @return self Provides fluent interface
*/
public function addParam($name, $value)
{
$this->params[$name] = $value;
return $this;
}
......@@ -151,4 +152,4 @@ abstract class Query extends Configurable implements QueryInterface
return $this->params;
}
}
\ No newline at end of file
}
library/Solarium/Core/Query/QueryInterface.php
View file @ b3963553
......@@ -46,43 +46,41 @@ use Solarium\Core\ConfigurableInterface;
interface QueryInterface extends ConfigurableInterface
{
/**
* Get type for this query
*
* @return string
*/
function getType();
public function getType();
/**
* Get the requestbuilder class for this query
*
* @return object
*/
function getRequestBuilder();
public function getRequestBuilder();
/**
* Get the response parser class for this query
*
* @return ResponseParserInterface
*/
function getResponseParser();
public function getResponseParser();
/**
* Set handler option
*
* @param string $handler
* @return self Provides fluent interface
* @param string $handler
* @return self Provides fluent interface
*/
function setHandler($handler);
public function setHandler($handler);
/**
* Get handler option
*
* @return string
*/
function getHandler();
public function getHandler();
/**
* Set resultclass option
......@@ -93,24 +91,24 @@ interface QueryInterface extends ConfigurableInterface
*
* Also you need to make sure this class implements the ResultInterface
*
* @param string $classname
* @return self Provides fluent interface
* @param string $classname
* @return self Provides fluent interface
*/
function setResultClass($classname);
public function setResultClass($classname);
/**
* Get resultclass option
*
* @return string
*/
function getResultClass();
public function getResultClass();
/**
* Get a helper instance
*
* @return Helper
*/
function getHelper();
public function getHelper();
/**
* Add extra params to the request
......@@ -118,11 +116,11 @@ interface QueryInterface extends ConfigurableInterface
* Only intended for internal use, for instance with dereferenced params.
* Therefore the params are limited in functionality. Only add and get
*
* @param string $name
* @param string $value
* @return self Provides fluent interface
* @param string $name
* @param string $value
* @return self Provides fluent interface
*/
function addParam($name, $value);
public function addParam($name, $value);
/**
* Get extra params
......@@ -131,4 +129,4 @@ interface QueryInterface extends ConfigurableInterface
*/
public function getParams();
}
\ No newline at end of file
}
library/Solarium/Core/Query/RequestBuilder.php
View file @ b3963553
......@@ -50,7 +50,7 @@ abstract class RequestBuilder implements RequestBuilderInterface
/**
* Build request for a select query
*
* @param Query $query
* @param Query $query
* @return Request
*/
public function build(QueryInterface $query)
......@@ -69,8 +69,8 @@ abstract class RequestBuilder implements RequestBuilderInterface
* 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
* @param string $value
* @param array $localParams in key => value format
* @return string with Solr localparams syntax
*/
public function renderLocalParams($value, $localParams = array())
......@@ -108,6 +108,7 @@ abstract class RequestBuilder implements RequestBuilderInterface
{
if (null !== $value) {
$value = (true == $value) ? 'true' : 'false';
return $this->attrib($name, $value);
} else {
return '';
......@@ -131,4 +132,4 @@ abstract class RequestBuilder implements RequestBuilderInterface
return '';
}
}
}
\ No newline at end of file
}
library/Solarium/Core/Query/RequestBuilderInterface.php
View file @ b3963553
......@@ -49,9 +49,9 @@ interface RequestBuilderInterface
/**
* Build request for a select query
*
* @param QueryInterface $query
* @param QueryInterface $query
* @return Request
*/
function build(QueryInterface $query);
public function build(QueryInterface $query);
}
\ No newline at end of file
}
library/Solarium/Core/Query/ResponseParserInterface.php
View file @ b3963553
......@@ -55,9 +55,9 @@ interface ResponseParserInterface
*
* When this method is called the actual response parsing is started.
*
* @param Result\Result $result
* @param Result\Result $result
* @return mixed
*/
function parse($result);
public function parse($result);
}
\ No newline at end of file
}
library/Solarium/Core/Query/Result/QueryType.php
View file @ b3963553
......@@ -78,7 +78,7 @@ class QueryType extends Result
/**
* Map parser data into properties
*
* @param array $mapData
* @param array $mapData
* @return void
*/
protected function mapData($mapData)
......@@ -88,4 +88,4 @@ class QueryType extends Result
}
}
}
\ No newline at end of file
}
library/Solarium/Core/Query/Result/Result.php
View file @ b3963553
......@@ -43,7 +43,6 @@ use Solarium\Core\Client\Response;
use Solarium\Core\Client\HttpException;
use Solarium\Core\Query\Query;
/**
* Query result
*
......@@ -86,9 +85,9 @@ class Result implements ResultInterface
/**
* Constructor
*
* @param Client $client
* @param Query $query
* @param Response $response
* @param Client $client
* @param Query $query
* @param Response $response
* @return void
*/
public function __construct($client, $query, $response)
......@@ -149,4 +148,4 @@ class Result implements ResultInterface
return $this->data;
}
}
\ No newline at end of file
}
library/Solarium/Core/Query/Result/ResultInterface.php
View file @ b3963553
......@@ -40,7 +40,6 @@ namespace Solarium\Core\Query\Result;
use Solarium\Core\Client\Response;
use Solarium\Core\Query\Query;
/**
* Query result interface
*/
......@@ -54,14 +53,14 @@ interface ResultInterface
*
* @return Response
*/
function getResponse();
public function getResponse();
/**
* Get query instance
*
* @return Query
*/
function getQuery();
public function getQuery();
/**
* Get Solr response data
......@@ -70,5 +69,5 @@ interface ResultInterface
*
* @return array
*/
function getData();
}
\ No newline at end of file
public function getData();
}
library/Solarium/Plugin/BufferedAdd.php
View file @ b3963553
......@@ -91,7 +91,7 @@ class BufferedAdd extends Plugin
/**
* Set buffer size option
*
* @param int $size
* @param int $size
* @return self
*/
public function setBufferSize($size)
......@@ -112,9 +112,9 @@ class BufferedAdd extends Plugin
/**
* Create a document object instance and add it to the buffer
*
* @param array $fields
* @param array $boosts
* @return self Provides fluent interface
* @param array $fields
* @param array $boosts
* @return self Provides fluent interface
*/
public function createDocument($fields, $boosts = array())
{
......@@ -127,8 +127,8 @@ class BufferedAdd extends Plugin
/**
* Add a document
*
* @param ReadOnlyDocument $document
* @return self Provides fluent interface
* @param ReadOnlyDocument $document
* @return self Provides fluent interface
*/
public function addDocument($document)
{
......@@ -176,14 +176,15 @@ class BufferedAdd extends Plugin
{
$this->updateQuery = $this->client->createUpdate();
$this->buffer = array();
return $this;
}
/**
* Flush any buffered documents to Solr
*
* @param boolean $overwrite
* @param int $commitWithin
* @param boolean $overwrite
* @param int $commitWithin
* @return boolean|UpdateResult
*/
public function flush($overwrite = null, $commitWithin = null)
......@@ -209,10 +210,10 @@ class BufferedAdd extends Plugin
*
* Any remaining documents in the buffer will also be flushed
*
* @param boolean $overwrite
* @param boolean $waitFlush
* @param boolean $waitSearcher
* @param boolean $expungeDeletes
* @param boolean $overwrite
* @param boolean $waitFlush
* @param boolean $waitSearcher
* @param boolean $expungeDeletes
* @return UpdateResult
*/
public function commit($overwrite = null, $waitFlush = null, $waitSearcher = null, $expungeDeletes = null)
......@@ -229,4 +230,4 @@ class BufferedAdd extends Plugin
return $result;
}
}
\ No newline at end of file
}
library/Solarium/Plugin/CustomizeRequest/Customization.php
View file @ b3963553
......@@ -72,12 +72,13 @@ class Customization extends Configurable
/**
* Set key value
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setKey($value)
{
$this->setOption('key', $value);
return $this;
}
......@@ -94,12 +95,13 @@ class Customization extends Configurable
/**
* Set type value
*
* @param string $value
* @param string $value
* @return Customization
*/
public function setType($value)
{
$this->setOption('type', $value);
return $this;
}
......@@ -116,12 +118,13 @@ class Customization extends Configurable
/**
* Set name value
*
* @param string $value
* @param string $value
* @return Customization
*/
public function setName($value)
{
$this->setOption('name', $value);
return $this;
}
......@@ -138,12 +141,13 @@ class Customization extends Configurable
/**
* Set value
*
* @param string $value
* @param string $value
* @return Customization
*/
public function setValue($value)
{
$this->setOption('value', $value);
return $this;
}
......@@ -160,12 +164,13 @@ class Customization extends Configurable
/**
* Set persistent on/off
*
* @param boolean $value
* @param boolean $value
* @return Customization
*/
public function setPersistent($value)
{
$this->setOption('persistent', $value);
return $this;
}
......@@ -182,12 +187,13 @@ class Customization extends Configurable
/**
* Set overwrite option on/off
*
* @param boolean $value
* @param boolean $value
* @return Customization
*/
public function setOverwrite($value)
{
$this->setOption('overwrite', $value);
return $this;
}
......@@ -220,4 +226,4 @@ class Customization extends Configurable
return true;
}
}
\ No newline at end of file
}
library/Solarium/Plugin/CustomizeRequest/CustomizeRequest.php
View file @ b3963553
......@@ -84,7 +84,7 @@ class CustomizeRequest extends Plugin
* When no key is supplied the Customization cannot be added, in that case you will need to add it manually
* after setting the key, by using the addCustomization method.
*
* @param mixed $options
* @param mixed $options
* @return Customization
*/
public function createCustomization($options = null)
......@@ -109,8 +109,8 @@ class CustomizeRequest extends Plugin
* Supports a Customization instance or a config array, in that case a new
* Customization instance wil be created based on the options.
*
* @param Customization|array $customization
* @return self Provides fluent interface
* @param Customization|array $customization
* @return self Provides fluent interface
*/
public function addCustomization($customization)
{
......@@ -141,7 +141,7 @@ class CustomizeRequest extends Plugin
/**
* Add multiple Customizations
*
* @param array $customizations
* @param array $customizations
* @return CustomizeRequest Provides fluent interface
*/
public function addCustomizations(array $customizations)
......@@ -162,7 +162,7 @@ class CustomizeRequest extends Plugin
/**
* Get a Customization
*
* @param string $key
* @param string $key
* @return string
*/
public function getCustomization($key)
......@@ -189,8 +189,8 @@ class CustomizeRequest extends Plugin
*
* You can remove a Customization by passing it's key, or by passing the Customization instance
*
* @param string|Customization $customization
* @return CustomizeRequest Provides fluent interface
* @param string|Customization $customization
* @return CustomizeRequest Provides fluent interface
*/
public function removeCustomization($customization)
{
......@@ -213,6 +213,7 @@ class CustomizeRequest extends Plugin
public function clearCustomizations()
{
$this->customizations = array();
return $this;
}
......@@ -232,8 +233,8 @@ class CustomizeRequest extends Plugin
/**
* Event hook to customize the request object
*
* @param Query $query
* @param Request $request
* @param Query $query
* @param Request $request
* @return void
*/
public function postCreateRequest($query, $request)
......@@ -266,4 +267,4 @@ class CustomizeRequest extends Plugin
}
}
}
\ No newline at end of file
}
library/Solarium/Plugin/Loadbalancer/Loadbalancer.php
View file @ b3963553
......@@ -160,7 +160,7 @@ class Loadbalancer extends Plugin
/**
* Set failover enabled option
*
* @param bool $value
* @param bool $value
* @return self Provides fluent interface
*/
public function setFailoverEnabled($value)
......@@ -181,7 +181,7 @@ class Loadbalancer extends Plugin
/**
* Set failover max retries
*
* @param int $value
* @param int $value
* @return self Provides fluent interface
*/
public function setFailoverMaxRetries($value)
......@@ -202,9 +202,9 @@ class Loadbalancer extends Plugin
/**
* Add an endpoint to the loadbalacing 'pool'
*
* @param Endpoint|string $endpoint
* @param int $weight Must be a positive number
* @return self Provides fluent interface
* @param Endpoint|string $endpoint
* @param int $weight Must be a positive number
* @return self Provides fluent interface
*/
public function addEndpoint($endpoint, $weight = 1)
{
......@@ -227,8 +227,8 @@ class Loadbalancer extends Plugin
/**
* Add multiple endpoints
*
* @param array $endpoints
* @return self Provides fluent interface
* @param array $endpoints
* @return self Provides fluent interface
*/
public function addEndpoints(array $endpoints)
{
......@@ -262,8 +262,8 @@ class Loadbalancer extends Plugin
/**
* Remove an endpoint by key
*
* @param Endpoint|string $endpoint
* @return self Provides fluent interface
* @param Endpoint|string $endpoint
* @return self Provides fluent interface
*/
public function removeEndpoint($endpoint)
{
......@@ -300,8 +300,8 @@ class Loadbalancer extends Plugin
* If the next query cannot be loadbalanced (for instance based on the querytype) this setting is ignored
* but will still be reset.
*
* @param string|null|Endpoint $endpoint
* @return self Provides fluent interface
* @param string|null|Endpoint $endpoint
* @return self Provides fluent interface
*/
public function setForcedEndpointForNextQuery($endpoint)
{
......@@ -314,6 +314,7 @@ class Loadbalancer extends Plugin
}
$this->nextEndpoint = $endpoint;
return $this;
}
......@@ -342,21 +343,22 @@ class Loadbalancer extends Plugin
*
* Overwrites any existing types
*
* @param array $types Use an array with the constants defined in Solarium\Client as values
* @return self Provides fluent interface
* @param array $types Use an array with the constants defined in Solarium\Client as values
* @return self Provides fluent interface
*/
public function setBlockedQueryTypes($types)
{
$this->clearBlockedQueryTypes();
$this->addBlockedQueryTypes($types);
return $this;
}
/**
* Add a querytype to block from loadbalancing
*
* @param string $type Use one of the constants defined in Solarium\Client
* @return self Provides fluent interface
* @param string $type Use one of the constants defined in Solarium\Client
* @return self Provides fluent interface
*/
public function addBlockedQueryType($type)
{
......@@ -372,8 +374,8 @@ class Loadbalancer extends Plugin
*
* Appended to any existing types
*
* @param array $types Use an array with the constants defined in Solarium\Client as values
* @return self Provides fluent interface
* @param array $types Use an array with the constants defined in Solarium\Client as values
* @return self Provides fluent interface
*/
public function addBlockedQueryTypes($types)
{
......@@ -385,7 +387,7 @@ class Loadbalancer extends Plugin
/**
* Remove a single querytype from the block list
*
* @param string $type
* @param string $type
* @return void
*/
public function removeBlockedQueryType($type)
......@@ -420,7 +422,7 @@ class Loadbalancer extends Plugin
/**
* Event hook to capture querytype
*
* @param Query $query
* @param Query $query
* @return void
*/
public function preCreateRequest($query)
......@@ -431,7 +433,7 @@ class Loadbalancer extends Plugin
/**
* Event hook to adjust client settings just before query execution
*
* @param Request $request
* @param Request $request
* @return Response
*/
public function preExecuteRequest($request)
......@@ -458,7 +460,7 @@ class Loadbalancer extends Plugin
/**
* Execute a request using the adapter
*
* @param Request $request
* @param Request $request
* @return Response $response
*/
protected function getLoadbalancedResponse($request)
......@@ -486,6 +488,7 @@ class Loadbalancer extends Plugin
} else {
// no failover retries, just execute and let an exception bubble upwards
$endpoint = $this->getRandomEndpoint();
return $adapter->execute($request, $endpoint);
}
}
......@@ -508,6 +511,7 @@ class Loadbalancer extends Plugin
$this->endpointExcludes[] = $key;
$this->lastEndpoint = $key;
return $this->client->getEndpoint($key);
}
......@@ -525,4 +529,4 @@ class Loadbalancer extends Plugin
return $this->randomizer;
}
}
\ No newline at end of file
}
library/Solarium/Plugin/Loadbalancer/WeightedRandomChoice.php
View file @ b3963553
......@@ -92,7 +92,7 @@ class WeightedRandomChoice
/**
* Get a (weighted) random entry
*
* @param array $excludes Keys to exclude
* @param array $excludes Keys to exclude
* @return string
*/
public function getRandom($excludes = array())
......@@ -129,7 +129,7 @@ class WeightedRandomChoice
$probe = (int) (($high + $low) / 2);
if ($this->lookup[$probe] < $random) {
$low = $probe + 1;
} else if ($this->lookup[$probe] > $random) {
} elseif ($this->lookup[$probe] > $random) {
$high = $probe - 1;
} else {
return $probe;
......@@ -144,4 +144,4 @@ class WeightedRandomChoice
}
}
\ No newline at end of file
}
library/Solarium/Plugin/ParallelExecution.php
View file @ b3963553
......@@ -83,10 +83,10 @@ class ParallelExecution extends Plugin
/**
* Add a query to execute
*
* @param string $key
* @param Query $query
* @param null|string|Endpoint $endpoint
* @return self Provides fluent interface
* @param string $key
* @param Query $query
* @param null|string|Endpoint $endpoint
* @return self Provides fluent interface
*/
public function addQuery($key, $query, $endpoint = null)
{
......@@ -124,6 +124,7 @@ class ParallelExecution extends Plugin
public function clearQueries()
{
$this->queries = array();
return $this;
}
......
library/Solarium/Plugin/PostBigRequest.php
View file @ b3963553
......@@ -67,8 +67,8 @@ class PostBigRequest extends Plugin
/**
* Set maxquerystringlength enabled option
*
* @param integer $value
* @return self Provides fluent interface
* @param integer $value
* @return self Provides fluent interface
*/
public function setMaxQueryStringLength($value)
{
......@@ -88,8 +88,8 @@ class PostBigRequest extends Plugin
/**
* Event hook to adjust client settings just before query execution
*
* @param Query $query
* @param Request $request
* @param Query $query
* @param Request $request
* @return void
*/
public function postCreateRequest($query, $request)
......@@ -105,4 +105,4 @@ class PostBigRequest extends Plugin
}
}
}
\ No newline at end of file
}
library/Solarium/Plugin/PrefetchIterator.php
View file @ b3963553
......@@ -98,8 +98,8 @@ class PrefetchIterator extends Plugin implements \Iterator, \Countable
/**
* Set prefetch option
*
* @param integer $value
* @return self Provides fluent interface
* @param integer $value
* @return self Provides fluent interface
*/
public function setPrefetch($value)
{
......@@ -119,12 +119,13 @@ class PrefetchIterator extends Plugin implements \Iterator, \Countable
/**
* Set query to use for prefetching
*
* @param SelectQuery $query
* @return self Provides fluent interface
* @param SelectQuery $query
* @return self Provides fluent interface
*/
public function setQuery($query)
{
$this->query = $query;
return $this;
}
......@@ -172,6 +173,7 @@ class PrefetchIterator extends Plugin implements \Iterator, \Countable
public function current()
{
$adjustedIndex = $this->position % $this->options['prefetch'];
return $this->documents[$adjustedIndex];
}
......@@ -222,4 +224,4 @@ class PrefetchIterator extends Plugin implements \Iterator, \Countable
$this->documents = $this->result->getDocuments();
$this->start += $this->getPrefetch();
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Query/Document.php
View file @ b3963553
......@@ -97,8 +97,8 @@ class Document extends Query
/**
* Add a single document
*
* @param object $document
* @return self Provides fluent interface
* @param object $document
* @return self Provides fluent interface
*/
public function addDocument($document)
{
......@@ -110,12 +110,13 @@ class Document extends Query
/**
* Add multiple documents
*
* @param array $documents
* @return self fluent interface
* @param array $documents
* @return self fluent interface
*/
public function addDocuments($documents)
{
$this->documents = array_merge($this->documents, $documents);
return $this;
}
......@@ -129,4 +130,4 @@ class Document extends Query
return $this->documents;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Query/Field.php
View file @ b3963553
......@@ -92,8 +92,8 @@ class Field extends Query
*
* The text that will be analyzed. The analysis will mimic the index-time analysis.
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setFieldValue($value)
{
......@@ -115,8 +115,8 @@ class Field extends Query
*
* When present, the text will be analyzed based on the specified type
*
* @param string $type
* @return self Provides fluent interface
* @param string $type
* @return self Provides fluent interface
*/
public function setFieldType($type)
{
......@@ -138,8 +138,8 @@ class Field extends Query
*
* When present, the text will be analyzed based on the type of this field name
*
* @param string $name
* @return self Provides fluent interface
* @param string $name
* @return self Provides fluent interface
*/
public function setFieldName($name)
{
......@@ -156,4 +156,4 @@ class Field extends Query
return $this->getOption('fieldname');
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Query/Query.php
View file @ b3963553
......@@ -50,9 +50,9 @@ abstract class Query extends BaseQuery
*
* When present, the text that will be analyzed. The analysis will mimic the query-time analysis.
*
* @param string $query
* @param array $bind Optional bind values for placeholders in the query string
* @return self Provides fluent interface
* @param string $query
* @param array $bind Optional bind values for placeholders in the query string
* @return self Provides fluent interface
*/
public function setQuery($query, $bind = null)
{
......@@ -76,8 +76,8 @@ abstract class Query extends BaseQuery
/**
* Set the showmatch option
*
* @param boolean $show
* @return self Provides fluent interface
* @param boolean $show
* @return self Provides fluent interface
*/
public function setShowMatch($show)
{
......@@ -94,4 +94,4 @@ abstract class Query extends BaseQuery
return $this->getOption('showmatch');
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/RequestBuilder/Document.php
View file @ b3963553
......@@ -50,7 +50,7 @@ class Document extends BaseRequestBuilder
/**
* Build request for an analysis document query
*
* @param Document $query
* @param Document $query
* @return Request
*/
public function build(QueryInterface $query)
......@@ -65,7 +65,7 @@ class Document extends BaseRequestBuilder
/**
* Create the raw post data (xml)
*
* @param Document $query
* @param Document $query
* @return string
*/
public function getRawData($query)
......@@ -96,8 +96,8 @@ class Document extends BaseRequestBuilder
/**
* Build XML for a field
*
* @param string $name
* @param mixed $value
* @param string $name
* @param mixed $value
* @return string
*/
protected function buildFieldXml($name, $value)
......@@ -105,4 +105,4 @@ class Document extends BaseRequestBuilder
return '<field name="' . $name . '">' . htmlspecialchars($value, ENT_NOQUOTES, 'UTF-8') . '</field>';
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/RequestBuilder/Field.php
View file @ b3963553
......@@ -50,7 +50,7 @@ class Field extends RequestBuilder
/**
* Build request for an analysis field query
*
* @param QueryField $query
* @param QueryField $query
* @return Request
*/
public function build(QueryInterface $query)
......@@ -64,4 +64,4 @@ class Field extends RequestBuilder
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/RequestBuilder/RequestBuilder.php
View file @ b3963553
......@@ -52,7 +52,7 @@ class RequestBuilder extends BaseRequestBuilder
/**
* Build request for an analysis query
*
* @param Query $query
* @param Query $query
* @return Request
*/
public function build(QueryInterface $query)
......@@ -64,4 +64,4 @@ class RequestBuilder extends BaseRequestBuilder
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/ResponseParser/Document.php
View file @ b3963553
......@@ -48,7 +48,7 @@ class Document extends Field
/**
* Parse implementation
*
* @param array $data
* @param array $data
* @return array
*/
protected function parseAnalysis($data)
......@@ -62,4 +62,4 @@ class Document extends Field
return $documents;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/ResponseParser/Field.php
View file @ b3963553
......@@ -50,7 +50,7 @@ class Field implements ResponseParserInterface
/**
* Parse response data
*
* @param Result $result
* @param Result $result
* @return array
*/
public function parse($result)
......@@ -73,7 +73,7 @@ class Field implements ResponseParserInterface
/**
* Parser
*
* @param array $data
* @param array $data
* @return array
*/
protected function parseAnalysis($data)
......@@ -90,7 +90,7 @@ class Field implements ResponseParserInterface
/**
* Parse analysis types and items
*
* @param array $typeData
* @param array $typeData
* @return array
*/
protected function parseTypes($typeData)
......@@ -149,4 +149,4 @@ class Field implements ResponseParserInterface
return $results;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Result/Document.php
View file @ b3963553
......@@ -137,7 +137,7 @@ class Document extends BaseResult implements \IteratorAggregate, \Countable
/**
* Get a document by uniquekey value
*
* @param string $key
* @param string $key
* @return ResultList|null
*/
public function getDocument($key)
......@@ -151,4 +151,4 @@ class Document extends BaseResult implements \IteratorAggregate, \Countable
}
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Result/Field.php
View file @ b3963553
......@@ -134,4 +134,4 @@ class Field extends BaseResult implements \IteratorAggregate, \Countable
return count($this->items);
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Result/Item.php
View file @ b3963553
......@@ -205,4 +205,4 @@ class Item
return $this->match;
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Result/ResultList.php
View file @ b3963553
......@@ -58,12 +58,11 @@ class ResultList implements \IteratorAggregate, \Countable
*/
protected $items;
/**
* Constructor
*
* @param string $name
* @param array $items
* @param array $items
*/
public function __construct($name, $items)
{
......@@ -111,4 +110,4 @@ class ResultList implements \IteratorAggregate, \Countable
return count($this->items);
}
}
\ No newline at end of file
}
library/Solarium/Query/Analysis/Result/Types.php
View file @ b3963553
......@@ -76,4 +76,4 @@ class Types extends ResultList
return null;
}
}
\ No newline at end of file
}
library/Solarium/Query/MoreLikeThis/Query.php
View file @ b3963553
......@@ -110,8 +110,8 @@ class Query extends SelectQuery
*
* @link http://wiki.apache.org/solr/ContentStream ContentStream
*
* @param boolean $stream
* @return self Provides fluent interface
* @param boolean $stream
* @return self Provides fluent interface
*/
public function setQueryStream($stream)
{
......@@ -132,8 +132,8 @@ class Query extends SelectQuery
* Set the interestingTerms parameter. Must be one of: none, list, details.
*
* @see http://wiki.apache.org/solr/MoreLikeThisHandler#Params
* @param string $term
* @return self Provides fluent interface
* @param string $term
* @return self Provides fluent interface
*/
public function setInterestingTerms($term)
{
......@@ -155,8 +155,8 @@ class Query extends SelectQuery
*
* @see http://wiki.apache.org/solr/MoreLikeThisHandler#Params
*
* @param boolean $include
* @return self Provides fluent interface
* @param boolean $include
* @return self Provides fluent interface
*/
public function setMatchInclude($include)
{
......@@ -181,8 +181,8 @@ class Query extends SelectQuery
*
* Separate multiple fields with commas.
*
* @param string $fields
* @return self Provides fluent interface
* @param string $fields
* @return self Provides fluent interface
*/
public function setMltFields($fields)
{
......@@ -205,7 +205,7 @@ class Query extends SelectQuery
* Minimum Term Frequency - the frequency below which terms will be ignored
* in the source doc.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumTermFrequency($minimum)
......@@ -229,7 +229,7 @@ class Query extends SelectQuery
* Minimum Document Frequency - the frequency at which words will be
* ignored which do not occur in at least this many docs.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumDocumentFrequency($minimum)
......@@ -252,7 +252,7 @@ class Query extends SelectQuery
*
* Minimum word length below which words will be ignored.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumWordLength($minimum)
......@@ -275,7 +275,7 @@ class Query extends SelectQuery
*
* Maximum word length above which words will be ignored.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumWordLength($maximum)
......@@ -299,7 +299,7 @@ class Query extends SelectQuery
* Maximum number of query terms that will be included in any generated
* query.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumQueryTerms($maximum)
......@@ -323,7 +323,7 @@ class Query extends SelectQuery
* Maximum number of tokens to parse in each example doc field that is not
* stored with TermVector support.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumNumberOfTokens($maximum)
......@@ -346,8 +346,8 @@ class Query extends SelectQuery
*
* If true the query will be boosted by the interesting term relevance.
*
* @param boolean $boost
* @return self Provides fluent interface
* @param boolean $boost
* @return self Provides fluent interface
*/
public function setBoost($boost)
{
......@@ -372,8 +372,8 @@ class Query extends SelectQuery
*
* Separate multiple fields with commas.
*
* @param string $queryFields
* @return self Provides fluent interface
* @param string $queryFields
* @return self Provides fluent interface
*/
public function setQueryFields($queryFields)
{
......
library/Solarium/Query/MoreLikeThis/RequestBuilder.php
View file @ b3963553
......@@ -53,7 +53,7 @@ class RequestBuilder extends SelectRequestBuilder
/**
* Build request for a MoreLikeThis query
*
* @param Query $query
* @param Query $query
* @return Request
*/
public function build(QueryInterface $query)
......
library/Solarium/Query/MoreLikeThis/ResponseParser.php
View file @ b3963553
......@@ -49,7 +49,7 @@ class ResponseParser extends SelectResponseParser
/**
* Get result data for the response
*
* @param Result $result
* @param Result $result
* @return array
*/
public function parse($result)
......
library/Solarium/Query/MoreLikeThis/Result.php
View file @ b3963553
......@@ -88,6 +88,7 @@ class Result extends SelectResult
throw new Exception('interestingterms is none');
}
$this->parseResponse();
return $this->interestingTerms;
}
......@@ -106,6 +107,7 @@ class Result extends SelectResult
throw new Exception('matchinclude was disabled in the MLT query');
}
$this->parseResponse();
return $this->match;
}
}
library/Solarium/Query/Ping/Query.php
View file @ b3963553
......@@ -91,4 +91,4 @@ class Query extends BaseQuery
'handler' => 'admin/ping',
);
}
\ No newline at end of file
}
library/Solarium/Query/Ping/RequestBuilder.php
View file @ b3963553
......@@ -50,7 +50,7 @@ class RequestBuilder extends BaseRequestBuilder
/**
* Build request for a ping query
*
* @param Query $query
* @param Query $query
* @return Request
*/
public function build(QueryInterface $query)
......@@ -61,4 +61,4 @@ class RequestBuilder extends BaseRequestBuilder
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Ping/Result.php
View file @ b3963553
......@@ -61,4 +61,4 @@ class Result extends BaseResult
return 0;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Component.php
View file @ b3963553
......@@ -59,7 +59,6 @@ abstract class Component extends Configurable
*/
abstract public function getRequestBuilder();
/**
* Get the response parser class for this query
*
......@@ -67,4 +66,4 @@ abstract class Component extends Configurable
*/
abstract public function getResponseParser();
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Debug.php
View file @ b3963553
......@@ -92,12 +92,12 @@ class Debug extends Component
/**
* Set the explainOther query
*
* @param string $query
* @return self Provides fluent interface
* @param string $query
* @return self Provides fluent interface
*/
public function setExplainOther($query)
{
return $this->setOption('explainother', $query);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/DisMax.php
View file @ b3963553
......@@ -94,8 +94,8 @@ class DisMax extends Component
* standard query parsing syntax) when the main query string is not
* specified or blank.
*
* @param string $queryAlternative
* @return self Provides fluent interface
* @param string $queryAlternative
* @return self Provides fluent interface
*/
public function setQueryAlternative($queryAlternative)
{
......@@ -120,8 +120,8 @@ class DisMax extends Component
*
* The format supported is "fieldOne^2.3 fieldTwo fieldThree^0.4"
*
* @param string $queryFields
* @return self Provides fluent interface
* @param string $queryFields
* @return self Provides fluent interface
*/
public function setQueryFields($queryFields)
{
......@@ -144,8 +144,8 @@ class DisMax extends Component
* This option makes it possible to say that a certain minimum number of
* clauses must match. See Solr manual for details.
*
* @param string $minimumMatch
* @return self Provides fluent interface
* @param string $minimumMatch
* @return self Provides fluent interface
*/
public function setMinimumMatch($minimumMatch)
{
......@@ -170,8 +170,8 @@ class DisMax extends Component
*
* Format is: "fieldA^1.0 fieldB^2.2"
*
* @param string $phraseFields
* @return self Provides fluent interface
* @param string $phraseFields
* @return self Provides fluent interface
*/
public function setPhraseFields($phraseFields)
{
......@@ -194,8 +194,8 @@ class DisMax extends Component
* Amount of slop on phrase queries built for "pf" fields
* (affects boosting)
*
* @param string $phraseSlop
* @return self Provides fluent interface
* @param string $phraseSlop
* @return self Provides fluent interface
*/
public function setPhraseSlop($phraseSlop)
{
......@@ -218,8 +218,8 @@ class DisMax extends Component
* Amount of slop on phrase queries explicitly included in the user's
* query string (in qf fields; affects matching)
*
* @param string $queryPhraseSlop
* @return self Provides fluent interface
* @param string $queryPhraseSlop
* @return self Provides fluent interface
*/
public function setQueryPhraseSlop($queryPhraseSlop)
{
......@@ -241,8 +241,8 @@ class DisMax extends Component
*
* Float value to use as tiebreaker in DisjunctionMaxQueries
*
* @param float $tie
* @return self Provides fluent interface
* @param float $tie
* @return self Provides fluent interface
*/
public function setTie($tie)
{
......@@ -265,8 +265,8 @@ class DisMax extends Component
* A raw query string (in the SolrQuerySyntax) that will be included
* with the user's query to influence the score.
*
* @param string $boostQuery
* @return self Provides fluent interface
* @param string $boostQuery
* @return self Provides fluent interface
*/
public function setBoostQuery($boostQuery)
{
......@@ -291,8 +291,8 @@ class DisMax extends Component
*
* Format is: "funcA(arg1,arg2)^1.2 funcB(arg3,arg4)^2.2"
*
* @param string $boostFunctions
* @return self Provides fluent interface
* @param string $boostFunctions
* @return self Provides fluent interface
*/
public function setBoostFunctions($boostFunctions)
{
......@@ -316,8 +316,8 @@ class DisMax extends Component
*
* @since 2.1.0
*
* @param string $parser
* @return self Provides fluent interface
* @param string $parser
* @return self Provides fluent interface
*/
public function setQueryParser($parser)
{
......@@ -336,4 +336,4 @@ class DisMax extends Component
return $this->getOption('queryparser');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/DistributedSearch.php
View file @ b3963553
......@@ -107,14 +107,15 @@ class DistributedSearch extends Component
/**
* Add a shard
*
* @param string $key unique string
* @param string $shard The syntax is host:port/base_url
* @return self Provides fluent interface
* @param string $key unique string
* @param string $shard The syntax is host:port/base_url
* @return self Provides fluent interface
* @link http://wiki.apache.org/solr/DistributedSearch
*/
public function addShard($key, $shard)
{
$this->shards[$key] = $shard;
return $this;
}
......@@ -132,8 +133,8 @@ class DistributedSearch extends Component
* ));
* $result = $client->select($query);
* </code>
* @param array $shards
* @return self Provides fluent interface
* @param array $shards
* @return self Provides fluent interface
*/
public function addShards(array $shards)
{
......@@ -147,8 +148,8 @@ class DistributedSearch extends Component
/**
* Remove a shard
*
* @param string $key
* @return self Provides fluent interface
* @param string $key
* @return self Provides fluent interface
*/
public function removeShard($key)
{
......@@ -167,6 +168,7 @@ class DistributedSearch extends Component
public function clearShards()
{
$this->shards = array();
return $this;
}
......@@ -187,8 +189,8 @@ class DistributedSearch extends Component
* $result = $client->select($query);
* </code>
*
* @param array $shards Associative array of shards
* @return self Provides fluent interface
* @param array $shards Associative array of shards
* @return self Provides fluent interface
*/
public function setShards(array $shards)
{
......@@ -218,6 +220,7 @@ class DistributedSearch extends Component
public function setShardRequestHandler($handler)
{
$this->setOption('shardhandler', $handler);
return $this;
}
......@@ -231,4 +234,4 @@ class DistributedSearch extends Component
{
return $this->getOption('shardhandler');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/EDisMax.php
View file @ b3963553
......@@ -38,7 +38,6 @@
*/
namespace Solarium\Query\Select\Query\Component;
use Solarium\Query\Select\Query\Query as SelectQuery;
use Solarium\Query\Select\RequestBuilder\Component\DisMax as RequestBuilder;
/**
* EdisMax component
......@@ -75,8 +74,8 @@ class EdisMax extends DisMax
*
* Format is: "funcA(arg1,arg2)^1.2 funcB(arg3,arg4)^2.2"
*
* @param string $boostFunctionsMult
* @return self Provides fluent interface
* @param string $boostFunctionsMult
* @return self Provides fluent interface
*/
public function setBoostFunctionsMult($boostFunctionsMult)
{
......@@ -101,8 +100,8 @@ class EdisMax extends DisMax
*
* Format is: "fieldA^1.0 fieldB^2.2 fieldC^3.5"
*
* @param string $phraseBigramFields
* @return self Provides fluent interface
* @param string $phraseBigramFields
* @return self Provides fluent interface
*/
public function setPhraseBigramFields($phraseBigramFields)
{
......@@ -125,8 +124,8 @@ class EdisMax extends DisMax
* As with 'ps' but sets default slop factor for 'pf2'.
* If not specified, 'ps' will be used.
*
* @param string $phraseBigramSlop
* @return self Provides fluent interface
* @param string $phraseBigramSlop
* @return self Provides fluent interface
*/
public function setPhraseBigramSlop($phraseBigramSlop)
{
......@@ -151,8 +150,8 @@ class EdisMax extends DisMax
*
* Format is: "fieldA^1.0 fieldB^2.2 fieldC^3.5"
*
* @param string $phraseTrigramFields
* @return self Provides fluent interface
* @param string $phraseTrigramFields
* @return self Provides fluent interface
*/
public function setPhraseTrigramFields($phraseTrigramFields)
{
......@@ -175,8 +174,8 @@ class EdisMax extends DisMax
* As with 'ps' but sets default slop factor for 'pf3'.
* If not specified, 'ps' will be used.
*
* @param string $phraseTrigramSlop
* @return self Provides fluent interface
* @param string $phraseTrigramSlop
* @return self Provides fluent interface
*/
public function setPhraseTrigramSlop($phraseTrigramSlop)
{
......@@ -204,8 +203,8 @@ class EdisMax extends DisMax
* To allow all fields except title, use &uf=* -title. To disallow all fielded searches, use &uf=-*.
* The uf parameter was introduced in Solr3.6
*
* @param string $userFields
* @return self Provides fluent interface
* @param string $userFields
* @return self Provides fluent interface
*/
public function setUserFields($userFields)
{
......@@ -222,4 +221,4 @@ class EdisMax extends DisMax
return $this->getOption('userfields');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Facet/Facet.php
View file @ b3963553
......@@ -98,8 +98,8 @@ abstract class Facet extends Configurable
/**
* Set key value
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setKey($value)
{
......@@ -109,20 +109,21 @@ abstract class Facet extends Configurable
/**
* Add an exclude tag
*
* @param string $tag
* @return self Provides fluent interface
* @param string $tag
* @return self Provides fluent interface
*/
public function addExclude($tag)
{
$this->excludes[$tag] = true;
return $this;
}
/**
* Add multiple exclude tags
*
* @param array $excludes
* @return self Provides fluent interface
* @param array $excludes
* @return self Provides fluent interface
*/
public function addExcludes(array $excludes)
{
......@@ -146,8 +147,8 @@ abstract class Facet extends Configurable
/**
* Remove a single exclude tag
*
* @param string $exclude
* @return self Provides fluent interface
* @param string $exclude
* @return self Provides fluent interface
*/
public function removeExclude($exclude)
{
......@@ -166,6 +167,7 @@ abstract class Facet extends Configurable
public function clearExcludes()
{
$this->excludes = array();
return $this;
}
......@@ -181,4 +183,4 @@ abstract class Facet extends Configurable
$this->clearExcludes();
$this->addExcludes($excludes);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Facet/Field.php
View file @ b3963553
......@@ -89,8 +89,8 @@ class Field extends Facet
/**
* Set the field name
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function setField($field)
{
......@@ -112,8 +112,8 @@ class Field extends Facet
*
* Use one of the SORT_* constants as the value
*
* @param string $sort
* @return self Provides fluent interface
* @param string $sort
* @return self Provides fluent interface
*/
public function setSort($sort)
{
......@@ -133,8 +133,8 @@ class Field extends Facet
/**
* Limit the terms for faceting by a prefix
*
* @param string $prefix
* @return self Provides fluent interface
* @param string $prefix
* @return self Provides fluent interface
*/
public function setPrefix($prefix)
{
......@@ -154,7 +154,7 @@ class Field extends Facet
/**
* Set the facet limit
*
* @param int $limit
* @param int $limit
* @return self Provides fluent interface
*/
public function setLimit($limit)
......@@ -175,7 +175,7 @@ class Field extends Facet
/**
* Set the facet offset
*
* @param int $offset
* @param int $offset
* @return self Provides fluent interface
*/
public function setOffset($offset)
......@@ -196,7 +196,7 @@ class Field extends Facet
/**
* Set the facet mincount
*
* @param int $minCount
* @param int $minCount
* @return self Provides fluent interface
*/
public function setMinCount($minCount)
......@@ -217,8 +217,8 @@ class Field extends Facet
/**
* Set the missing count option
*
* @param boolean $missing
* @return self Provides fluent interface
* @param boolean $missing
* @return self Provides fluent interface
*/
public function setMissing($missing)
{
......@@ -240,8 +240,8 @@ class Field extends Facet
*
* Use one of the METHOD_* constants as value
*
* @param string $method
* @return self Provides fluent interface
* @param string $method
* @return self Provides fluent interface
*/
public function setMethod($method)
{
......@@ -258,4 +258,4 @@ class Field extends Facet
return $this->getOption('method');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Facet/MultiQuery.php
View file @ b3963553
......@@ -96,10 +96,10 @@ class MultiQuery extends Facet
* Convenience method so you don't need to manually create facetquery
* objects.
*
* @param string $key
* @param string $query
* @param array $excludes
* @return self Provides fluent interface
* @param string $key
* @param string $query
* @param array $excludes
* @return self Provides fluent interface
*/
public function createQuery($key, $query, $excludes = array())
{
......@@ -120,8 +120,8 @@ class MultiQuery extends Facet
* Supports a facetquery instance or a config array, in that case a new
* facetquery instance wil be created based on the options.
*
* @param Query|array $facetQuery
* @return self Provides fluent interface
* @param Query|array $facetQuery
* @return self Provides fluent interface
*/
public function addQuery($facetQuery)
{
......@@ -143,14 +143,15 @@ class MultiQuery extends Facet
$facetQuery->addExcludes($this->getExcludes());
$this->facetQueries[$key] = $facetQuery;
return $this;
}
/**
* Add multiple facetqueries
*
* @param array $facetQueries Instances or config array
* @return self Provides fluent interface
* @param array $facetQueries Instances or config array
* @return self Provides fluent interface
*/
public function addQueries(array $facetQueries)
{
......@@ -170,7 +171,7 @@ class MultiQuery extends Facet
/**
* Get a facetquery
*
* @param string $key
* @param string $key
* @return string
*/
public function getQuery($key)
......@@ -197,8 +198,8 @@ class MultiQuery extends Facet
*
* You can remove a facetquery by passing it's key or the facetquery instance
*
* @param string|Query $query
* @return self Provides fluent interface
* @param string|Query $query
* @return self Provides fluent interface
*/
public function removeQuery($query)
{
......@@ -221,6 +222,7 @@ class MultiQuery extends Facet
public function clearQueries()
{
$this->facetQueries = array();
return $this;
}
......@@ -229,12 +231,13 @@ class MultiQuery extends Facet
*
* This overwrites any existing facetqueries
*
* @param array $facetQueries
* @return self Provides fluent interface
* @param array $facetQueries
* @return self Provides fluent interface
*/
public function setQueries($facetQueries)
{
$this->clearQueries();
return $this->addQueries($facetQueries);
}
......@@ -247,8 +250,8 @@ class MultiQuery extends Facet
* If you don't want to share an exclude use the addExclude method of a
* specific FacetQuery instance instead.
*
* @param string $tag
* @return self Provides fluent interface
* @param string $tag
* @return self Provides fluent interface
*/
public function addExclude($tag)
{
......@@ -268,8 +271,8 @@ class MultiQuery extends Facet
* If you don't want this use the removeExclude method of a
* specific FacetQuery instance instead.
*
* @param string $exclude
* @return self Provides fluent interface
* @param string $exclude
* @return self Provides fluent interface
*/
public function removeExclude($exclude)
{
......@@ -300,4 +303,4 @@ class MultiQuery extends Facet
return parent::clearExcludes();
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Facet/Query.php
View file @ b3963553
......@@ -72,9 +72,9 @@ class Query extends Facet
*
* This overwrites the current value
*
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
*/
public function setQuery($query, $bind = null)
{
......@@ -96,4 +96,4 @@ class Query extends Facet
return $this->getOption('query');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Facet/Range.php
View file @ b3963553
......@@ -134,8 +134,8 @@ class Range extends Facet
/**
* Set the field name
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function setField($field)
{
......@@ -155,8 +155,8 @@ class Range extends Facet
/**
* Set the lower bound of the range
*
* @param string $start
* @return self Provides fluent interface
* @param string $start
* @return self Provides fluent interface
*/
public function setStart($start)
{
......@@ -176,8 +176,8 @@ class Range extends Facet
/**
* Set the upper bound of the range
*
* @param string $end
* @return self Provides fluent interface
* @param string $end
* @return self Provides fluent interface
*/
public function setEnd($end)
{
......@@ -199,8 +199,8 @@ class Range extends Facet
*
* The size of each range expressed as a value to be added to the lower bound
*
* @param string $gap
* @return self Provides fluent interface
* @param string $gap
* @return self Provides fluent interface
*/
public function setGap($gap)
{
......@@ -225,8 +225,8 @@ class Range extends Facet
* A Boolean parameter instructing Solr what to do in the event that facet.range.gap
* does not divide evenly between facet.range.start and facet.range.end
*
* @param boolean $hardend
* @return self Provides fluent interface
* @param boolean $hardend
* @return self Provides fluent interface
*/
public function setHardend($hardend)
{
......@@ -249,8 +249,8 @@ class Range extends Facet
* Use one of the constants as value.
* If you want to use multiple values supply an array or comma separated string
*
* @param string|array $other
* @return self Provides fluent interface
* @param string|array $other
* @return self Provides fluent interface
*/
public function setOther($other)
{
......@@ -279,8 +279,8 @@ class Range extends Facet
* Use one of the constants as value.
* If you want to use multiple values supply an array or comma separated string
*
* @param string|array $include
* @return self Provides fluent interface
* @param string|array $include
* @return self Provides fluent interface
*/
public function setInclude($include)
{
......@@ -302,4 +302,4 @@ class Range extends Facet
{
return $this->getOption('include');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/FacetSet.php
View file @ b3963553
......@@ -152,8 +152,8 @@ class FacetSet extends Component
*
* This is a global value for all facets in this facetset
*
* @param string $prefix
* @return self Provides fluent interface
* @param string $prefix
* @return self Provides fluent interface
*/
public function setPrefix($prefix)
{
......@@ -179,8 +179,8 @@ class FacetSet extends Component
*
* This is a global value for all facets in this facetset
*
* @param string $sort
* @return self Provides fluent interface
* @param string $sort
* @return self Provides fluent interface
*/
public function setSort($sort)
{
......@@ -204,7 +204,7 @@ class FacetSet extends Component
*
* This is a global value for all facets in this facetset
*
* @param int $limit
* @param int $limit
* @return self Provides fluent interface
*/
public function setLimit($limit)
......@@ -229,7 +229,7 @@ class FacetSet extends Component
*
* This is a global value for all facets in this facetset
*
* @param int $minCount
* @param int $minCount
* @return self Provides fluent interface
*/
public function setMinCount($minCount)
......@@ -254,8 +254,8 @@ class FacetSet extends Component
*
* This is a global value for all facets in this facetset
*
* @param boolean $missing
* @return self Provides fluent interface
* @param boolean $missing
* @return self Provides fluent interface
*/
public function setMissing($missing)
{
......@@ -277,8 +277,8 @@ class FacetSet extends Component
/**
* Add a facet
*
* @param Facet\Facet|array $facet
* @return self Provides fluent interface
* @param Facet\Facet|array $facet
* @return self Provides fluent interface
*/
public function addFacet($facet)
{
......@@ -306,8 +306,8 @@ class FacetSet extends Component
/**
* Add multiple facets
*
* @param array $facets
* @return self Provides fluent interface
* @param array $facets
* @return self Provides fluent interface
*/
public function addFacets(array $facets)
{
......@@ -327,7 +327,7 @@ class FacetSet extends Component
/**
* Get a facet
*
* @param string $key
* @param string $key
* @return string
*/
public function getFacet($key)
......@@ -354,8 +354,8 @@ class FacetSet extends Component
*
* You can remove a facet by passing it's key or the facet instance
*
* @param string|Facet\Facet $facet
* @return self Provides fluent interface
* @param string|Facet\Facet $facet
* @return self Provides fluent interface
*/
public function removeFacet($facet)
{
......@@ -378,6 +378,7 @@ class FacetSet extends Component
public function clearFacets()
{
$this->facets = array();
return $this;
}
......@@ -404,9 +405,9 @@ class FacetSet extends Component
* When no key is supplied the facet cannot be added, in that case you will need to add it manually
* after setting the key, by using the addFacet method.
*
* @param string $type
* @param array|object|null $options
* @param boolean $add
* @param string $type
* @param array|object|null $options
* @param boolean $add
* @return Facet\Facet
*/
public function createFacet($type, $options = null, $add = true)
......@@ -436,7 +437,7 @@ class FacetSet extends Component
/**
* Get a facet field instance
*
* @param mixed $options
* @param mixed $options
* @return Facet\Field
*/
public function createFacetField($options = null)
......@@ -447,7 +448,7 @@ class FacetSet extends Component
/**
* Get a facet query instance
*
* @param mixed $options
* @param mixed $options
* @return Facet\Query
*/
public function createFacetQuery($options = null)
......@@ -458,7 +459,7 @@ class FacetSet extends Component
/**
* Get a facet multiquery instance
*
* @param mixed $options
* @param mixed $options
* @return Facet\MultiQuery
*/
public function createFacetMultiQuery($options = null)
......@@ -469,7 +470,7 @@ class FacetSet extends Component
/**
* Get a facet range instance
*
* @param mixed $options
* @param mixed $options
* @return Facet\Range
*/
public function createFacetRange($options = null)
......@@ -477,4 +478,4 @@ class FacetSet extends Component
return $this->createFacet(self::FACET_RANGE, $options);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Grouping.php
View file @ b3963553
......@@ -141,8 +141,8 @@ class Grouping extends Component
*
* Group based on the unique values of a field
*
* @param string $field
* @return self fluent interface
* @param string $field
* @return self fluent interface
*/
public function addField($field)
{
......@@ -156,8 +156,8 @@ class Grouping extends Component
*
* You can use an array or a comma separated string as input
*
* @param array|string $fields
* @return self Provides fluent interface
* @param array|string $fields
* @return self Provides fluent interface
*/
public function addFields($fields)
{
......@@ -189,6 +189,7 @@ class Grouping extends Component
public function clearFields()
{
$this->fields = array();
return $this;
}
......@@ -210,8 +211,8 @@ class Grouping extends Component
*
* Group documents that match the given query
*
* @param string $query
* @return self fluent interface
* @param string $query
* @return self fluent interface
*/
public function addQuery($query)
{
......@@ -223,8 +224,8 @@ class Grouping extends Component
/**
* Add multiple grouping queries
*
* @param array|string $queries
* @return self Provides fluent interface
* @param array|string $queries
* @return self Provides fluent interface
*/
public function addQueries($queries)
{
......@@ -255,6 +256,7 @@ class Grouping extends Component
public function clearQueries()
{
$this->queries = array();
return $this;
}
......@@ -276,7 +278,7 @@ class Grouping extends Component
*
* The number of results (documents) to return for each group
*
* @param int $limit
* @param int $limit
* @return self Provides fluent interface
*/
public function setLimit($limit)
......@@ -299,7 +301,7 @@ class Grouping extends Component
*
* The offset into the document list of each group.
*
* @param int $offset
* @param int $offset
* @return self Provides fluent interface
*/
public function setOffset($offset)
......@@ -322,8 +324,8 @@ class Grouping extends Component
*
* How to sort documents within a single group
*
* @param string $sort
* @return self Provides fluent interface
* @param string $sort
* @return self Provides fluent interface
*/
public function setSort($sort)
{
......@@ -346,8 +348,8 @@ class Grouping extends Component
* If true, the result of the first field grouping command is used as the main
* result list in the response, using group format 'simple'
*
* @param boolean $value
* @return self Provides fluent interface
* @param boolean $value
* @return self Provides fluent interface
*/
public function setMainResult($value)
{
......@@ -369,8 +371,8 @@ class Grouping extends Component
*
* If true, includes the number of groups that have matched the query.
*
* @param boolean $value
* @return self Provides fluent interface
* @param boolean $value
* @return self Provides fluent interface
*/
public function setNumberOfGroups($value)
{
......@@ -397,8 +399,8 @@ class Grouping extends Component
* wildcard queries and fuzzy queries. For simple queries like a term query or
* a match all query this cache has a negative impact on performance
*
* @param integer $value
* @return self Provides fluent interface
* @param integer $value
* @return self Provides fluent interface
*/
public function setCachePercentage($value)
{
......@@ -421,8 +423,8 @@ class Grouping extends Component
* If true, facet counts are based on the most relevant document of each group matching the query.
* Same applies for StatsComponent. Default is false. Only available from Solr 3.4
*
* @param boolean $value
* @return self Provides fluent interface
* @param boolean $value
* @return self Provides fluent interface
*/
public function setTruncate($value)
{
......@@ -439,4 +441,4 @@ class Grouping extends Component
return $this->getOption('truncate');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Highlighting/Field.php
View file @ b3963553
......@@ -69,8 +69,8 @@ class Field extends Configurable
/**
* Set name option
*
* @param string $name
* @return self Provides fluent interface
* @param string $name
* @return self Provides fluent interface
*/
public function setName($name)
{
......@@ -82,7 +82,7 @@ class Field extends Configurable
*
* Maximum number of snippets per field
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setSnippets($maximum)
......@@ -105,7 +105,7 @@ class Field extends Configurable
*
* The size, in characters, of fragments to consider for highlighting
*
* @param int $size
* @param int $size
* @return self Provides fluent interface
*/
public function setFragSize($size)
......@@ -128,8 +128,8 @@ class Field extends Configurable
*
* Collapse contiguous fragments into a single fragment
*
* @param boolean $merge
* @return self Provides fluent interface
* @param boolean $merge
* @return self Provides fluent interface
*/
public function setMergeContiguous($merge)
{
......@@ -149,8 +149,8 @@ class Field extends Configurable
/**
* Set alternatefield option
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function setAlternateField($field)
{
......@@ -170,8 +170,8 @@ class Field extends Configurable
/**
* Set formatter option
*
* @param string $formatter
* @return self Provides fluent interface
* @param string $formatter
* @return self Provides fluent interface
*/
public function setFormatter($formatter = 'simple')
{
......@@ -193,8 +193,8 @@ class Field extends Configurable
*
* Solr option h1.simple.pre
*
* @param string $prefix
* @return self Provides fluent interface
* @param string $prefix
* @return self Provides fluent interface
*/
public function setSimplePrefix($prefix)
{
......@@ -218,8 +218,8 @@ class Field extends Configurable
*
* Solr option h1.simple.post
*
* @param string $postfix
* @return self Provides fluent interface
* @param string $postfix
* @return self Provides fluent interface
*/
public function setSimplePostfix($postfix)
{
......@@ -243,8 +243,8 @@ class Field extends Configurable
*
* Use one of the constants as value.
*
* @param string $fragmenter
* @return self Provides fluent interface
* @param string $fragmenter
* @return self Provides fluent interface
*/
public function setFragmenter($fragmenter)
{
......@@ -264,8 +264,8 @@ class Field extends Configurable
/**
* Set useFastVectorHighlighter option
*
* @param boolean $use
* @return self Provides fluent interface
* @param boolean $use
* @return self Provides fluent interface
*/
public function setUseFastVectorHighlighter($use)
{
......@@ -282,4 +282,4 @@ class Field extends Configurable
return $this->getOption('usefastvectorhighlighter');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Highlighting/Highlighting.php
View file @ b3963553
......@@ -118,16 +118,17 @@ class Highlighting extends Component
/**
* Get a field options object
*
* @param string $name
* @param boolean $autocreate
* @param string $name
* @param boolean $autocreate
* @return Field
*/
public function getField($name, $autocreate = true)
{
if (isset($this->fields[$name])) {
return $this->fields[$name];
} else if ($autocreate) {
} elseif ($autocreate) {
$this->addField($name);
return $this->fields[$name];
} else {
return null;
......@@ -137,15 +138,15 @@ class Highlighting extends Component
/**
* Add a field for highlighting
*
* @param string|array|Field $field
* @return self Provides fluent interface
* @param string|array|Field $field
* @return self Provides fluent interface
*/
public function addField($field)
{
// autocreate object for string input
if (is_string($field)) {
$field = new Field(array('name' => $field));
} else if (is_array($field)) {
} elseif (is_array($field)) {
$field = new Field($field);
}
......@@ -155,6 +156,7 @@ class Highlighting extends Component
}
$this->fields[$field->getName()] = $field;
return $this;
}
......@@ -189,8 +191,8 @@ class Highlighting extends Component
/**
* Remove a highlighting field
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function removeField($field)
{
......@@ -209,6 +211,7 @@ class Highlighting extends Component
public function clearFields()
{
$this->fields = array();
return $this;
}
......@@ -227,8 +230,8 @@ class Highlighting extends Component
*
* This overwrites any existing fields
*
* @param array $fields
* @return self Provides fluent interface
* @param array $fields
* @return self Provides fluent interface
*/
public function setFields($fields)
{
......@@ -243,7 +246,7 @@ class Highlighting extends Component
*
* Maximum number of snippets per field
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setSnippets($maximum)
......@@ -266,7 +269,7 @@ class Highlighting extends Component
*
* The size, in characters, of fragments to consider for highlighting
*
* @param int $size
* @param int $size
* @return self Provides fluent interface
*/
public function setFragSize($size)
......@@ -289,8 +292,8 @@ class Highlighting extends Component
*
* Collapse contiguous fragments into a single fragment
*
* @param boolean $merge
* @return self Provides fluent interface
* @param boolean $merge
* @return self Provides fluent interface
*/
public function setMergeContiguous($merge)
{
......@@ -310,8 +313,8 @@ class Highlighting extends Component
/**
* Set requireFieldMatch option
*
* @param boolean $require
* @return self Provides fluent interface
* @param boolean $require
* @return self Provides fluent interface
*/
public function setRequireFieldMatch($require)
{
......@@ -333,7 +336,7 @@ class Highlighting extends Component
*
* How many characters into a document to look for suitable snippets
*
* @param int $chars
* @param int $chars
* @return self Provides fluent interface
*/
public function setMaxAnalyzedChars($chars)
......@@ -354,8 +357,8 @@ class Highlighting extends Component
/**
* Set alternatefield option
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function setAlternateField($field)
{
......@@ -375,7 +378,7 @@ class Highlighting extends Component
/**
* Set maxAlternateFieldLength option
*
* @param int $length
* @param int $length
* @return self Provides fluent interface
*/
public function setMaxAlternateFieldLength($length)
......@@ -396,8 +399,8 @@ class Highlighting extends Component
/**
* Set formatter option
*
* @param string $formatter
* @return self Provides fluent interface
* @param string $formatter
* @return self Provides fluent interface
*/
public function setFormatter($formatter = 'simple')
{
......@@ -419,8 +422,8 @@ class Highlighting extends Component
*
* Solr option h1.simple.pre
*
* @param string $prefix
* @return self Provides fluent interface
* @param string $prefix
* @return self Provides fluent interface
*/
public function setSimplePrefix($prefix)
{
......@@ -444,8 +447,8 @@ class Highlighting extends Component
*
* Solr option h1.simple.post
*
* @param string $postfix
* @return self Provides fluent interface
* @param string $postfix
* @return self Provides fluent interface
*/
public function setSimplePostfix($postfix)
{
......@@ -469,8 +472,8 @@ class Highlighting extends Component
*
* Use one of the constants as value.
*
* @param string $fragmenter
* @return self Provides fluent interface
* @param string $fragmenter
* @return self Provides fluent interface
*/
public function setFragmenter($fragmenter)
{
......@@ -490,8 +493,8 @@ class Highlighting extends Component
/**
* Set fraglistbuilder option
*
* @param string $builder
* @return self Provides fluent interface
* @param string $builder
* @return self Provides fluent interface
*/
public function setFragListBuilder($builder)
{
......@@ -511,8 +514,8 @@ class Highlighting extends Component
/**
* Set fragmentsbuilder option
*
* @param string $builder
* @return self Provides fluent interface
* @param string $builder
* @return self Provides fluent interface
*/
public function setFragmentsBuilder($builder)
{
......@@ -532,8 +535,8 @@ class Highlighting extends Component
/**
* Set useFastVectorHighlighter option
*
* @param boolean $use
* @return self Provides fluent interface
* @param boolean $use
* @return self Provides fluent interface
*/
public function setUseFastVectorHighlighter($use)
{
......@@ -553,8 +556,8 @@ class Highlighting extends Component
/**
* Set usePhraseHighlighter option
*
* @param boolean $use
* @return self Provides fluent interface
* @param boolean $use
* @return self Provides fluent interface
*/
public function setUsePhraseHighlighter($use)
{
......@@ -574,8 +577,8 @@ class Highlighting extends Component
/**
* Set HighlightMultiTerm option
*
* @param boolean $highlight
* @return self Provides fluent interface
* @param boolean $highlight
* @return self Provides fluent interface
*/
public function setHighlightMultiTerm($highlight)
{
......@@ -595,8 +598,8 @@ class Highlighting extends Component
/**
* Set RegexSlop option
*
* @param float $slop
* @return self Provides fluent interface
* @param float $slop
* @return self Provides fluent interface
*/
public function setRegexSlop($slop)
{
......@@ -616,8 +619,8 @@ class Highlighting extends Component
/**
* Set RegexPattern option
*
* @param string $pattern
* @return self Provides fluent interface
* @param string $pattern
* @return self Provides fluent interface
*/
public function setRegexPattern($pattern)
{
......@@ -637,7 +640,7 @@ class Highlighting extends Component
/**
* Set RegexMaxAnalyzedChars option
*
* @param int $chars
* @param int $chars
* @return self Provides fluent interface
*/
public function setRegexMaxAnalyzedChars($chars)
......@@ -660,8 +663,8 @@ class Highlighting extends Component
*
* Overrides the q parameter for highlighting
*
* @param string $query
* @return self Provides fluent interface
* @param string $query
* @return self Provides fluent interface
*/
public function setQuery($query)
{
......@@ -681,7 +684,7 @@ class Highlighting extends Component
/**
* Set phraselimit option
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setPhraseLimit($maximum)
......@@ -699,4 +702,4 @@ class Highlighting extends Component
return $this->getOption('phraselimit');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/MoreLikeThis.php
View file @ b3963553
......@@ -87,8 +87,8 @@ class MoreLikeThis extends Component
*
* Separate multiple fields with commas.
*
* @param string $fields
* @return self Provides fluent interface
* @param string $fields
* @return self Provides fluent interface
*/
public function setFields($fields)
{
......@@ -111,7 +111,7 @@ class MoreLikeThis extends Component
* Minimum Term Frequency - the frequency below which terms will be ignored
* in the source doc.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumTermFrequency($minimum)
......@@ -135,7 +135,7 @@ class MoreLikeThis extends Component
* Minimum Document Frequency - the frequency at which words will be
* ignored which do not occur in at least this many docs.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumDocumentFrequency($minimum)
......@@ -158,7 +158,7 @@ class MoreLikeThis extends Component
*
* Minimum word length below which words will be ignored.
*
* @param int $minimum
* @param int $minimum
* @return self Provides fluent interface
*/
public function setMinimumWordLength($minimum)
......@@ -181,7 +181,7 @@ class MoreLikeThis extends Component
*
* Maximum word length above which words will be ignored.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumWordLength($maximum)
......@@ -205,7 +205,7 @@ class MoreLikeThis extends Component
* Maximum number of query terms that will be included in any generated
* query.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumQueryTerms($maximum)
......@@ -229,7 +229,7 @@ class MoreLikeThis extends Component
* Maximum number of tokens to parse in each example doc field that is not
* stored with TermVector support.
*
* @param int $maximum
* @param int $maximum
* @return self Provides fluent interface
*/
public function setMaximumNumberOfTokens($maximum)
......@@ -252,8 +252,8 @@ class MoreLikeThis extends Component
*
* If true the query will be boosted by the interesting term relevance.
*
* @param boolean $boost
* @return self Provides fluent interface
* @param boolean $boost
* @return self Provides fluent interface
*/
public function setBoost($boost)
{
......@@ -278,8 +278,8 @@ class MoreLikeThis extends Component
*
* Separate multiple fields with commas.
*
* @param string $queryFields
* @return self Provides fluent interface
* @param string $queryFields
* @return self Provides fluent interface
*/
public function setQueryFields($queryFields)
{
......@@ -301,7 +301,7 @@ class MoreLikeThis extends Component
*
* The number of similar documents to return for each result
*
* @param int $count
* @param int $count
* @return self Provides fluent interface
*/
public function setCount($count)
......@@ -319,4 +319,4 @@ class MoreLikeThis extends Component
return $this->getOption('count');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Spellcheck.php
View file @ b3963553
......@@ -83,8 +83,8 @@ class Spellcheck extends Component
*
* Query to spellcheck
*
* @param string $query
* @return self Provides fluent interface
* @param string $query
* @return self Provides fluent interface
*/
public function setQuery($query)
{
......@@ -106,8 +106,8 @@ class Spellcheck extends Component
*
* Build the spellcheck?
*
* @param boolean $build
* @return self Provides fluent interface
* @param boolean $build
* @return self Provides fluent interface
*/
public function setBuild($build)
{
......@@ -129,8 +129,8 @@ class Spellcheck extends Component
*
* Reload the dictionary?
*
* @param boolean $reload
* @return self Provides fluent interface
* @param boolean $reload
* @return self Provides fluent interface
*/
public function setReload($reload)
{
......@@ -152,8 +152,8 @@ class Spellcheck extends Component
*
* The name of the dictionary to use
*
* @param string $dictionary
* @return self Provides fluent interface
* @param string $dictionary
* @return self Provides fluent interface
*/
public function setDictionary($dictionary)
{
......@@ -173,9 +173,9 @@ class Spellcheck extends Component
/**
* Set count option
*
* The maximum number of suggestions to return
*
* @param int $count
* The maximum number of suggestions to return
*
* @param int $count
* @return self Provides fluent interface
*/
public function setCount($count)
......@@ -198,8 +198,8 @@ class Spellcheck extends Component
*
* Only return suggestions that result in more hits for the query than the existing query
*
* @param boolean $onlyMorePopular
* @return self Provides fluent interface
* @param boolean $onlyMorePopular
* @return self Provides fluent interface
*/
public function setOnlyMorePopular($onlyMorePopular)
{
......@@ -219,8 +219,8 @@ class Spellcheck extends Component
/**
* Set extendedResults option
*
* @param boolean $extendedResults
* @return self Provides fluent interface
* @param boolean $extendedResults
* @return self Provides fluent interface
*/
public function setExtendedResults($extendedResults)
{
......@@ -240,8 +240,8 @@ class Spellcheck extends Component
/**
* Set collate option
*
* @param boolean $collate
* @return self Provides fluent interface
* @param boolean $collate
* @return self Provides fluent interface
*/
public function setCollate($collate)
{
......@@ -261,7 +261,7 @@ class Spellcheck extends Component
/**
* Set maxCollations option
*
* @param int $maxCollations
* @param int $maxCollations
* @return self Provides fluent interface
*/
public function setMaxCollations($maxCollations)
......@@ -282,8 +282,8 @@ class Spellcheck extends Component
/**
* Set maxCollationTries option
*
* @param string $maxCollationTries
* @return self Provides fluent interface
* @param string $maxCollationTries
* @return self Provides fluent interface
*/
public function setMaxCollationTries($maxCollationTries)
{
......@@ -303,7 +303,7 @@ class Spellcheck extends Component
/**
* Set maxCollationEvaluations option
*
* @param int $maxCollationEvaluations
* @param int $maxCollationEvaluations
* @return self Provides fluent interface
*/
public function setMaxCollationEvaluations($maxCollationEvaluations)
......@@ -324,8 +324,8 @@ class Spellcheck extends Component
/**
* Set collateExtendedResults option
*
* @param string $collateExtendedResults
* @return self Provides fluent interface
* @param string $collateExtendedResults
* @return self Provides fluent interface
*/
public function setCollateExtendedResults($collateExtendedResults)
{
......@@ -345,8 +345,8 @@ class Spellcheck extends Component
/**
* Set accuracy option
*
* @param float $accuracy
* @return self Provides fluent interface
* @param float $accuracy
* @return self Provides fluent interface
*/
public function setAccuracy($accuracy)
{
......@@ -363,4 +363,4 @@ class Spellcheck extends Component
return $this->getOption('accuracy');
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Stats/Field.php
View file @ b3963553
......@@ -84,8 +84,8 @@ class Field extends Configurable
/**
* Set key value
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setKey($value)
{
......@@ -95,12 +95,13 @@ class Field extends Configurable
/**
* Specify a facet to return in the resultset
*
* @param string $facet
* @return self Provides fluent interface
* @param string $facet
* @return self Provides fluent interface
*/
public function addFacet($facet)
{
$this->facets[$facet] = true;
return $this;
}
......@@ -129,8 +130,8 @@ class Field extends Configurable
/**
* Remove a facet from the facet list
*
* @param string $facet
* @return self Provides fluent interface
* @param string $facet
* @return self Provides fluent interface
*/
public function removeFacet($facet)
{
......@@ -149,6 +150,7 @@ class Field extends Configurable
public function clearFacets()
{
$this->facets = array();
return $this;
}
......@@ -167,8 +169,8 @@ class Field extends Configurable
*
* This overwrites any existing facets
*
* @param array $facets
* @return self Provides fluent interface
* @param array $facets
* @return self Provides fluent interface
*/
public function setFacets($facets)
{
......@@ -178,4 +180,4 @@ class Field extends Configurable
return $this;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Component/Stats/Stats.php
View file @ b3963553
......@@ -127,7 +127,7 @@ class Stats extends Component
* When no key is supplied the field cannot be added, in that case you will need to add it manually
* after setting the key, by using the addField method.
*
* @param mixed $options
* @param mixed $options
* @return Field
*/
public function createField($options = null)
......@@ -152,8 +152,8 @@ class Stats extends Component
* Supports a field instance or a config array, in that case a new
* field instance wil be created based on the options.
*
* @param Field|array $field
* @return self Provides fluent interface
* @param Field|array $field
* @return self Provides fluent interface
*/
public function addField($field)
{
......@@ -181,8 +181,8 @@ class Stats extends Component
/**
* Add multiple fields
*
* @param array $fields
* @return self Provides fluent interface
* @param array $fields
* @return self Provides fluent interface
*/
public function addFields(array $fields)
{
......@@ -202,7 +202,7 @@ class Stats extends Component
/**
* Get a field
*
* @param string $key
* @param string $key
* @return string
*/
public function getField($key)
......@@ -229,8 +229,8 @@ class Stats extends Component
*
* You can remove a field by passing it's key, or by passing the field instance
*
* @param string|Field $field
* @return self Provides fluent interface
* @param string|Field $field
* @return self Provides fluent interface
*/
public function removeField($field)
{
......@@ -253,6 +253,7 @@ class Stats extends Component
public function clearFields()
{
$this->fields = array();
return $this;
}
......@@ -272,12 +273,13 @@ class Stats extends Component
/**
* Specify a facet to return in the resultset
*
* @param string $facet
* @return self Provides fluent interface
* @param string $facet
* @return self Provides fluent interface
*/
public function addFacet($facet)
{
$this->facets[$facet] = true;
return $this;
}
......@@ -306,8 +308,8 @@ class Stats extends Component
/**
* Remove a facet from the facet list
*
* @param string $facet
* @return self Provides fluent interface
* @param string $facet
* @return self Provides fluent interface
*/
public function removeFacet($facet)
{
......@@ -326,6 +328,7 @@ class Stats extends Component
public function clearFacets()
{
$this->facets = array();
return $this;
}
......@@ -344,8 +347,8 @@ class Stats extends Component
*
* This overwrites any existing facets
*
* @param array $facets
* @return self Provides fluent interface
* @param array $facets
* @return self Provides fluent interface
*/
public function setFacets($facets)
{
......@@ -355,5 +358,4 @@ class Stats extends Component
return $this;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/FilterQuery.php
View file @ b3963553
......@@ -100,8 +100,8 @@ class FilterQuery extends Configurable
/**
* Set key value
*
* @param string $value
* @return self Provides fluent interface
* @param string $value
* @return self Provides fluent interface
*/
public function setKey($value)
{
......@@ -113,9 +113,9 @@ class FilterQuery extends Configurable
*
* This overwrites the current value
*
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
*/
public function setQuery($query, $bind = null)
{
......@@ -125,6 +125,7 @@ class FilterQuery extends Configurable
}
$this->query = trim($query);
return $this;
}
......@@ -141,26 +142,28 @@ class FilterQuery extends Configurable
/**
* Add a tag
*
* @param string $tag
* @return self Provides fluent interface
* @param string $tag
* @return self Provides fluent interface
*/
public function addTag($tag)
{
$this->tags[$tag] = true;
return $this;
}
/**
* Add tags
*
* @param array $tags
* @return self Provides fluent interface
* @param array $tags
* @return self Provides fluent interface
*/
public function addTags($tags)
{
foreach ($tags as $tag) {
$this->addTag($tag);
}
return $this;
}
......@@ -177,8 +180,8 @@ class FilterQuery extends Configurable
/**
* Remove a tag
*
* @param string $tag
* @return self Provides fluent interface
* @param string $tag
* @return self Provides fluent interface
*/
public function removeTag($tag)
{
......@@ -197,6 +200,7 @@ class FilterQuery extends Configurable
public function clearTags()
{
$this->tags = array();
return $this;
}
......@@ -205,13 +209,14 @@ class FilterQuery extends Configurable
*
* This overwrites any existing tags
*
* @param array $filterQueries
* @return self Provides fluent interface
* @param array $filterQueries
* @return self Provides fluent interface
*/
public function setTags($filterQueries)
{
$this->clearTags();
return $this->addTags($filterQueries);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/Query/Query.php
View file @ b3963553
......@@ -257,9 +257,9 @@ class Query extends BaseQuery
* Overwrites the current value. You are responsible for the correct
* escaping of user input.
*
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
* @param string $query
* @param array $bind Bind values for placeholders in the query string
* @return self Provides fluent interface
*/
public function setQuery($query, $bind = null)
{
......@@ -285,8 +285,8 @@ class Query extends BaseQuery
*
* Use one of the constants as value
*
* @param string $operator
* @return self Provides fluent interface
* @param string $operator
* @return self Provides fluent interface
*/
public function setQueryDefaultOperator($operator)
{
......@@ -306,8 +306,8 @@ class Query extends BaseQuery
/**
* Set default query field
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function setQueryDefaultField($field)
{
......@@ -327,8 +327,8 @@ class Query extends BaseQuery
/**
* Set the start offset
*
* @param integer $start
* @return self Provides fluent interface
* @param integer $start
* @return self Provides fluent interface
*/
public function setStart($start)
{
......@@ -348,8 +348,8 @@ class Query extends BaseQuery
/**
* Set a custom resultclass
*
* @param string $value classname
* @return self Provides fluent interface
* @param string $value classname
* @return self Provides fluent interface
*/
public function setResultClass($value)
{
......@@ -371,8 +371,8 @@ class Query extends BaseQuery
/**
* Set a custom document class
*
* @param string $value classname
* @return self Provides fluent interface
* @param string $value classname
* @return self Provides fluent interface
*/
public function setDocumentClass($value)
{
......@@ -394,8 +394,8 @@ class Query extends BaseQuery
/**
* Set the number of rows to fetch
*
* @param integer $rows
* @return self Provides fluent interface
* @param integer $rows
* @return self Provides fluent interface
*/
public function setRows($rows)
{
......@@ -415,12 +415,13 @@ class Query extends BaseQuery
/**
* Specify a field to return in the resultset
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function addField($field)
{
$this->fields[$field] = true;
return $this;
}
......@@ -449,8 +450,8 @@ class Query extends BaseQuery
/**
* Remove a field from the field list
*
* @param string $field
* @return self Provides fluent interface
* @param string $field
* @return self Provides fluent interface
*/
public function removeField($field)
{
......@@ -469,6 +470,7 @@ class Query extends BaseQuery
public function clearFields()
{
$this->fields = array();
return $this;
}
......@@ -487,8 +489,8 @@ class Query extends BaseQuery
*
* This overwrites any existing fields
*
* @param array $fields
* @return self Provides fluent interface
* @param array $fields
* @return self Provides fluent interface
*/
public function setFields($fields)
{
......@@ -501,9 +503,9 @@ class Query extends BaseQuery
/**
* Add a sort
*
* @param string $sort
* @param string $order
* @return self Provides fluent interface
* @param string $sort
* @param string $order
* @return self Provides fluent interface
*/
public function addSort($sort, $order)
{
......@@ -517,8 +519,8 @@ class Query extends BaseQuery
*
* The input array must contain sort items as keys and the order as values.
*
* @param array $sorts
* @return self Provides fluent interface
* @param array $sorts
* @return self Provides fluent interface
*/
public function addSorts(array $sorts)
{
......@@ -532,8 +534,8 @@ class Query extends BaseQuery
/**
* Remove a sort
*
* @param string $sort
* @return self Provides fluent interface
* @param string $sort
* @return self Provides fluent interface
*/
public function removeSort($sort)
{
......@@ -552,6 +554,7 @@ class Query extends BaseQuery
public function clearSorts()
{
$this->sorts = array();
return $this;
}
......@@ -570,8 +573,8 @@ class Query extends BaseQuery
*
* This overwrites any existing sorts
*
* @param array $sorts
* @return self Provides fluent interface
* @param array $sorts
* @return self Provides fluent interface
*/
public function setSorts($sorts)
{
......@@ -591,7 +594,7 @@ class Query extends BaseQuery
* When no key is supplied the filterquery cannot be added, in that case you will need to add it manually
* after setting the key, by using the addFilterQuery method.
*
* @param mixed $options
* @param mixed $options
* @return FilterQuery
*/
public function createFilterQuery($options = null)
......@@ -616,8 +619,8 @@ class Query extends BaseQuery
* Supports a filterquery instance or a config array, in that case a new
* filterquery instance wil be created based on the options.
*
* @param FilterQuery|array $filterQuery
* @return self Provides fluent interface
* @param FilterQuery|array $filterQuery
* @return self Provides fluent interface
*/
public function addFilterQuery($filterQuery)
{
......@@ -645,8 +648,8 @@ class Query extends BaseQuery
/**
* Add multiple filterqueries
*
* @param array $filterQueries
* @return self Provides fluent interface
* @param array $filterQueries
* @return self Provides fluent interface
*/
public function addFilterQueries(array $filterQueries)
{
......@@ -666,7 +669,7 @@ class Query extends BaseQuery
/**
* Get a filterquery
*
* @param string $key
* @param string $key
* @return string
*/
public function getFilterQuery($key)
......@@ -693,8 +696,8 @@ class Query extends BaseQuery
*
* You can remove a filterquery by passing it's key, or by passing the filterquery instance
*
* @param string|FilterQuery $filterQuery
* @return self Provides fluent interface
* @param string|FilterQuery $filterQuery
* @return self Provides fluent interface
*/
public function removeFilterQuery($filterQuery)
{
......@@ -717,6 +720,7 @@ class Query extends BaseQuery
public function clearFilterQueries()
{
$this->filterQueries = array();
return $this;
}
......@@ -746,13 +750,14 @@ class Query extends BaseQuery
/**
* Register a component type
*
* @param string $key
* @param string $component
* @return self Provides fluent interface
* @param string $key
* @param string $component
* @return self Provides fluent interface
*/
public function registerComponentType($key, $component)
{
$this->componentTypes[$key] = $component;
return $this;
}
......@@ -772,9 +777,9 @@ class Query extends BaseQuery
* You can optionally supply an autoload class to create a new component
* instance if there is no registered component for the given key yet.
*
* @param string $key Use one of the constants
* @param string $autoload Class to autoload if component needs to be created
* @param array $config Configuration to use for autoload
* @param string $key Use one of the constants
* @param string $autoload Class to autoload if component needs to be created
* @param array $config Configuration to use for autoload
* @return object|null
*/
public function getComponent($key, $autoload = false, $config = null)
......@@ -792,8 +797,10 @@ class Query extends BaseQuery
$className = class_exists($className) ? $className : $className.strrchr($className, '\\');
$component = new $className($config);
$this->setComponent($key, $component);
return $component;
}
return null;
}
}
......@@ -803,13 +810,14 @@ class Query extends BaseQuery
*
* This overwrites any existing component registered with the same key.
*
* @param string $key
* @param object|null $value
* @return self Provides fluent interface
* @param string $key
* @param object|null $value
* @return self Provides fluent interface
*/
public function setComponent($key, $value)
{
$this->components[$key] = $value;
return $this;
}
......@@ -818,8 +826,8 @@ class Query extends BaseQuery
*
* You can remove a component by passing it's key or the component instance
*
* @param string|Component\Component $component
* @return self Provides fluent interface
* @param string|Component\Component $component
* @return self Provides fluent interface
*/
public function removeComponent($component)
{
......@@ -835,14 +843,14 @@ class Query extends BaseQuery
unset($this->components[$component]);
}
}
return $this;
}
/**
* Build component instances based on config
*
* @param array $configs
* @param array $configs
* @return void
*/
protected function createComponents($configs)
......
library/Solarium/Query/Select/RequestBuilder/Component/Debug.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class Debug
/**
* Add request settings for the debug component
*
* @param DebugComponent $component
* @param Request $request
* @param DebugComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -61,4 +61,4 @@ class Debug
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/DisMax.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class DisMax
/**
* Add request settings for Dismax
*
* @param DismaxComponent $component
* @param Request $request
* @param DismaxComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -70,4 +70,4 @@ class DisMax
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/DistributedSearch.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class DistributedSearch
/**
* Add request settings for DistributedSearch
*
* @param DistributedSearchComponent $component
* @param Request $request
* @param DistributedSearchComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -64,4 +64,4 @@ class DistributedSearch
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/EDisMax.php
View file @ b3963553
......@@ -50,8 +50,8 @@ class EdisMax
/**
* Add request settings for EdismaxComponent
*
* @param EdismaxComponent $component
* @param Request $request
* @param EdismaxComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -77,4 +77,4 @@ class EdisMax
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/FacetSet.php
View file @ b3963553
......@@ -46,7 +46,6 @@ use Solarium\Query\Select\Query\Component\Facet\MultiQuery as FacetMultiQuery;
use Solarium\Query\Select\Query\Component\Facet\Query as FacetQuery;
use Solarium\Query\Select\Query\Component\Facet\Range as FacetRange;
/**
* Add select component FacetSet to the request
*/
......@@ -56,8 +55,8 @@ class FacetSet extends RequestBuilder
/**
* Add request settings for FacetSet
*
* @param FacetsetComponent $component
* @param Request $request
* @param FacetsetComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -76,8 +75,7 @@ class FacetSet extends RequestBuilder
$request->addParam('facet.limit', $component->getLimit());
foreach ($facets as $facet) {
switch ($facet->getType())
{
switch ($facet->getType()) {
case FacetsetComponent::FACET_FIELD:
$this->addFacetField($request, $facet);
break;
......@@ -102,8 +100,8 @@ class FacetSet extends RequestBuilder
/**
* Add params for a field facet to request
*
* @param Request $request
* @param FacetField $facet
* @param Request $request
* @param FacetField $facet
* @return void
*/
public function addFacetField($request, $facet)
......@@ -130,8 +128,8 @@ class FacetSet extends RequestBuilder
/**
* Add params for a facet query to request
*
* @param Request $request
* @param FacetQuery $facet
* @param Request $request
* @param FacetQuery $facet
* @return void
*/
public function addFacetQuery($request, $facet)
......@@ -148,8 +146,8 @@ class FacetSet extends RequestBuilder
/**
* Add params for a multiquery facet to request
*
* @param Request $request
* @param FacetMultiQuery $facet
* @param Request $request
* @param FacetMultiQuery $facet
* @return void
*/
public function addFacetMultiQuery($request, $facet)
......@@ -162,8 +160,8 @@ class FacetSet extends RequestBuilder
/**
* Add params for a range facet to request
*
* @param Request $request
* @param FacetRange $facet
* @param Request $request
* @param FacetRange $facet
* @return void
*/
public function addFacetRange($request, $facet)
......@@ -197,4 +195,4 @@ class FacetSet extends RequestBuilder
}
}
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/Grouping.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class Grouping
/**
* Add request settings for Grouping
*
* @param GroupingComponent $component
* @param Request $request
* @param GroupingComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -70,4 +70,4 @@ class Grouping
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/Highlighting.php
View file @ b3963553
......@@ -50,8 +50,8 @@ class Highlighting
/**
* Add request settings for Highlighting
*
* @param HighlightingComponent $component
* @param Request $request
* @param HighlightingComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent(HighlightingComponent $component, Request $request)
......@@ -94,8 +94,8 @@ class Highlighting
/**
* Add per-field override options to the request
*
* @param HighlightingField $field
* @param Request $request
* @param HighlightingField $field
* @param Request $request
* @return void
*/
protected function addFieldParams($field, $request)
......@@ -112,4 +112,4 @@ class Highlighting
$request->addParam($prefix.'useFastVectorHighlighter', $field->getUseFastVectorHighlighter());
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/MoreLikeThis.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class MoreLikeThis
/**
* Add request settings for morelikethis
*
* @param MoreLikeThisComponent $component
* @param Request $request
* @param MoreLikeThisComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -71,4 +71,4 @@ class MoreLikeThis
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/Spellcheck.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class Spellcheck
/**
* Add request settings for Spellcheck
*
* @param SpellcheckComponent $component
* @param Request $request
* @param SpellcheckComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -74,4 +74,4 @@ class Spellcheck
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/Component/Stats.php
View file @ b3963553
......@@ -49,8 +49,8 @@ class Stats
/**
* Add request settings for the stats component
*
* @param StatsComponent $component
* @param Request $request
* @param StatsComponent $component
* @param Request $request
* @return Request
*/
public function buildComponent($component, $request)
......@@ -76,4 +76,4 @@ class Stats
return $request;
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/RequestBuilder/RequestBuilder.php
View file @ b3963553
......@@ -51,7 +51,7 @@ class RequestBuilder extends BaseRequestBuilder
/**
* Build request for a select query
*
* @param SelectQuery $query
* @param SelectQuery $query
* @return Request
*/
public function build(QueryInterface $query)
......
library/Solarium/Query/Select/ResponseParser/Component/Debug.php
View file @ b3963553
......@@ -50,9 +50,9 @@ class Debug
/**
* Parse result data into result objects
*
* @param Query $query
* @param DebugComponent $component
* @param array $data
* @param Query $query
* @param DebugComponent $component
* @param array $data
* @return DebugResult\Result|null
*/
public function parse($query, $component, $data)
......@@ -88,7 +88,7 @@ class Debug
$time = null;
$timingPhases = array();
foreach ($debug['timing'] as $key => $timingData) {
switch($key) {
switch ($key) {
case 'time':
$time = $timingData;
break;
......@@ -119,7 +119,7 @@ class Debug
*
* Used for explain and explainOther
*
* @param array $data
* @param array $data
* @return DebugResult\DocumentSet
*/
protected function parseDocumentSet($data)
......@@ -153,8 +153,8 @@ class Debug
/**
* Parse raw timing phase data into a result class
*
* @param string $name
* @param array $data
* @param string $name
* @param array $data
* @return DebugResult\TimingPhase
*/
protected function parseTimingPhase($name, $data)
......@@ -162,7 +162,7 @@ class Debug
$time = 0.0;
$classes = array();
foreach ($data as $key => $timingData) {
switch($key) {
switch ($key) {
case 'time':
$time = $timingData;
break;
......@@ -174,4 +174,4 @@ class Debug
return new DebugResult\TimingPhase($name, $time, $classes);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/ResponseParser/Component/FacetSet.php
View file @ b3963553
......@@ -53,9 +53,9 @@ class FacetSet
/**
* Parse result data into result objects
*
* @param Query $query
* @param QueryFacetSet $facetSet
* @param array $data
* @param Query $query
* @param QueryFacetSet $facetSet
* @param array $data
* @return ResultFacetSet
*/
public function parse($query, $facetSet, $data)
......@@ -90,7 +90,7 @@ class FacetSet
/**
* Create a facetset result object
*
* @param array $facets
* @param array $facets
* @return ResultFacetSet
*/
protected function createFacetSet($facets)
......@@ -101,8 +101,8 @@ class FacetSet
/**
* Add a facet result for a field facet
*
* @param QueryFacet\Field $facet
* @param array $data
* @param QueryFacet\Field $facet
* @param array $data
* @return ResultFacet\Field
*/
protected function facetField($facet, $data)
......@@ -127,8 +127,8 @@ class FacetSet
/**
* Add a facet result for a facet query
*
* @param QueryFacet\Query $facet
* @param array $data
* @param QueryFacet\Query $facet
* @param array $data
* @return ResultFacet\Query
*/
protected function facetQuery($facet, $data)
......@@ -137,6 +137,7 @@ class FacetSet
if (isset($data['facet_counts']['facet_queries'][$key])) {
$value = $data['facet_counts']['facet_queries'][$key];
return new ResultFacet\Query($value);
}
}
......@@ -144,8 +145,8 @@ class FacetSet
/**
* Add a facet result for a multiquery facet
*
* @param QueryFacet\MultiQuery $facet
* @param array $data
* @param QueryFacet\MultiQuery $facet
* @param array $data
* @return ResultFacet\MultiQuery
*/
protected function facetMultiQuery($facet, $data)
......@@ -164,12 +165,11 @@ class FacetSet
}
}
/**
* Add a facet result for a range facet
*
* @param QueryFacet\Range $facet
* @param array $data
* @param QueryFacet\Range $facet
* @param array $data
* @return ResultFacet\Range
*/
protected function facetRange($facet, $data)
......@@ -193,4 +193,4 @@ class FacetSet
}
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/ResponseParser/Component/Grouping.php
View file @ b3963553
......@@ -50,9 +50,9 @@ class Grouping
/**
* Parse result data into result objects
*
* @param Query $query
* @param GroupingComponent $grouping
* @param array $data
* @param Query $query
* @param GroupingComponent $grouping
* @param array $data
* @return GroupingResult\Result
*/
public function parse($query, $grouping, $data)
......@@ -133,4 +133,4 @@ class Grouping
return new GroupingResult\Result($groups);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/ResponseParser/Component/Highlighting.php
View file @ b3963553
......@@ -50,9 +50,9 @@ class Highlighting
/**
* Parse result data into result objects
*
* @param Query $query
* @param HighlightingComponent $highlighting
* @param array $data
* @param Query $query
* @param HighlightingComponent $highlighting
* @param array $data
* @return HighlightingResult\Highlighting
*/
public function parse($query, $highlighting, $data)
......@@ -70,4 +70,4 @@ class Highlighting
return new HighlightingResult\Highlighting($results);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/ResponseParser/Component/MoreLikeThis.php
View file @ b3963553
......@@ -50,9 +50,9 @@ class MoreLikeThis
/**
* Parse result data into result objects
*
* @param Query $query
* @param MoreLikeThisComponent $moreLikeThis
* @param array $data
* @param Query $query
* @param MoreLikeThisComponent $moreLikeThis
* @param array $data
* @return MoreLikeThisResult\MoreLikeThis
*/
public function parse($query, $moreLikeThis, $data)
......@@ -81,4 +81,4 @@ class MoreLikeThis
return new MoreLikeThisResult\MoreLikeThis($results);
}
}
\ No newline at end of file
}
library/Solarium/Query/Select/ResponseParser/Component/Spellcheck.php
View file @ b3963553
......@@ -50,9 +50,9 @@ class Spellcheck
/**
* Parse result data into result objects
*
* @param Query $query
* @param SpellcheckComponent $spellcheck
* @param array $data
* @param Query $query
* @param SpellcheckComponent $spellcheck
* @param array $data
* @return SpellcheckResult\Result|null
*/
public function parse($query, $spellcheck, $data)
......@@ -98,7 +98,7 @@ class Spellcheck
/**
* Parse collation data into a result object
*
* @param array $values
* @param array $values
* @return SpellcheckResult\Collation
*/
protected function parseCollation($values)
......@@ -152,8 +152,8 @@ class Spellcheck
/**
* Parse suggestion data into a result object
*
* @param string $key
* @param array $value
* @param string $key
* @param array $value
* @return SpellcheckResult\Suggestion
*/
protected function parseSuggestion($key, $value)
......@@ -175,4 +175,4 @@ class Spellcheck
$numFound, $startOffset, $endOffset, $originalFrequency, $word, $frequency
);
}
}
\ No newline at end of file
}
library/Solarium/Query/Suggester/Query.php
View file @ b3963553
This diff is collapsed.
library/Solarium/Query/Terms/Query.php
View file @ b3963553
This diff is collapsed.
library/Solarium/Query/Terms/Result.php
View file @ b3963553
This diff is collapsed.
library/Solarium/Query/Update/Result.php
View file @ b3963553
This diff is collapsed.
tests/Solarium/Tests/ClientTest.php
View file @ b3963553
This diff is collapsed.
tests/Solarium/Tests/Core/PluginTest.php
View file @ b3963553
This diff is collapsed.
tests/bootstrap.php
View file @ b3963553
This diff is collapsed.
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