\Elastica\FilterRegexp

Regexp filter.

This function can be used to handle params for queries, filter

Summary

Methods
Properties
Constants
setCached()
setCacheKey()
setName()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setField()
setRegexp()
setOptions()
No public properties found
No constants found
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
$_field
$_regexp
$_options
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_field

$_field : string

Holds the name of the field for the regular expression.

Type

string

$_regexp

$_regexp : string

Holds the regexp string.

Type

string

$_options

$_options : array

Holds the regexp options.

Type

array

Methods

setCached()

setCached(boolean  $cached = true) : $this

Sets the filter cache.

Parameters

boolean $cached

Cached

Returns

$this

setCacheKey()

setCacheKey(string  $cacheKey) : $this

Sets the filter cache key.

Parameters

string $cacheKey

Cache key

Throws

\Elastica\Exception\InvalidException

If given key is empty

Returns

$this

setName()

setName(string  $name) : $this

Sets the filter name.

Parameters

string $name

Name

Returns

$this

toArray()

toArray() : array

Converts object to an array.

Returns

array —

data array

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

string $key

Key to set

mixed $value

Key Value

Returns

$this

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

array $params

Parameter list

Returns

$this

addParam()

addParam(string  $key, mixed  $value) : $this

Adds a param to the list.

This function can be used to add an array of params

Parameters

string $key

Param key

mixed $value

Value to set

Returns

$this

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

string $key

Key to return

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

mixed —

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

string $key

Key to test

Returns

boolean —

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

array —

Params

__construct()

__construct(string  $field = '', string  $regexp = '', array  $options = array()) 

Create Regexp object.

Parameters

string $field

Field name

string $regexp

Regular expression

array $options

Regular expression options

Throws

\Elastica\Exception\InvalidException

setField()

setField(string  $field) : $this

Sets the name of the regexp field.

Parameters

string $field

Field name

Returns

$this

setRegexp()

setRegexp(string  $regexp) : $this

Sets the regular expression query string.

Parameters

string $regexp

Regular expression

Returns

$this

setOptions()

setOptions(array  $options) : $this

Sets the regular expression query options.

Parameters

array $options

Regular expression options

Returns

$this

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

array $array

Returns

array

_getBaseName()

_getBaseName() : string

Param's name Picks the last part of the class name and makes it snake_case You can override this method if you want to change the name.

Returns

string —

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

string $key
mixed $value

Returns

$this