summaryrefslogtreecommitdiff
path: root/vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php')
-rw-r--r--vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php47
1 files changed, 25 insertions, 22 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php b/vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php
index 73b0f1a1..a3a46693 100644
--- a/vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php
+++ b/vendor/ruflin/elastica/lib/Elastica/Query/Fuzzy.php
@@ -1,27 +1,24 @@
<?php
-
namespace Elastica\Query;
use Elastica\Exception\InvalidException;
/**
- * Fuzzy query
+ * Fuzzy query.
*
- * @category Xodoa
- * @package Elastica
* @author Nicolas Ruflin <spam@ruflin.com>
- * @link http://www.elasticsearch.org/guide/reference/query-dsl/fuzzy-query.html
+ *
+ * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html
*/
class Fuzzy extends AbstractQuery
{
/**
- * Construct a fuzzy query
+ * Construct a fuzzy query.
*
- * @param string $fieldName Field name
- * @param string $value String to search for
- * @return \Elastica\Query\Fuzzy Current object
+ * @param string $fieldName Field name
+ * @param string $value String to search for
*/
- public function __construct ($fieldName = null, $value = null)
+ public function __construct($fieldName = null, $value = null)
{
if ($fieldName and $value) {
$this->setField($fieldName, $value);
@@ -29,13 +26,14 @@ class Fuzzy extends AbstractQuery
}
/**
- * Set field for fuzzy query
+ * Set field for fuzzy query.
*
- * @param string $fieldName Field name
- * @param string $value String to search for
- * @return \Elastica\Query\Fuzzy Current object
+ * @param string $fieldName Field name
+ * @param string $value String to search for
+ *
+ * @return $this
*/
- public function setField ($fieldName, $value)
+ public function setField($fieldName, $value)
{
if (!is_string($value) or !is_string($fieldName)) {
throw new InvalidException('The field and value arguments must be of type string.');
@@ -43,30 +41,34 @@ class Fuzzy extends AbstractQuery
if (count($this->getParams()) > 0 and array_shift(array_keys($this->getParams())) != $fieldName) {
throw new InvalidException('Fuzzy query can only support a single field.');
}
+
return $this->setParam($fieldName, array('value' => $value));
}
/**
- * Set optional parameters on the existing query
+ * Set optional parameters on the existing query.
*
- * @param string $param option name
- * @param mixed $value Value of the parameter
- * @return \Elastica\Query\Fuzzy Current object
+ * @param string $param option name
+ * @param mixed $value Value of the parameter
+ *
+ * @return $this
*/
- public function setFieldOption ($param, $value) {
+ public function setFieldOption($param, $value)
+ {
//Retrieve the single existing field for alteration.
$params = $this->getParams();
if (count($params) < 1) {
- throw new InvalidException('No field has been set');
+ throw new InvalidException('No field has been set');
}
$keyArray = array_keys($params);
$params[$keyArray[0]][$param] = $value;
- return $this->setparam($keyArray[0], $params[$keyArray[0]]);
+ return $this->setParam($keyArray[0], $params[$keyArray[0]]);
}
/**
* Deprecated method of setting a field.
+ *
* @deprecated
*/
public function addField($fieldName, $args)
@@ -79,6 +81,7 @@ class Fuzzy extends AbstractQuery
foreach ($args as $param => $value) {
$this->setFieldOption($param, $value);
}
+
return $this;
}
}