ISearchRequestSimpleQuery
Interface ISearchRequestSimpleQuery
Add a Query during a Search Request...
- on a specific field,
- using a specific value,
- with a specific comparison
Tags
Table of Contents
- COMPARE_TYPE_ARRAY = 9
- COMPARE_TYPE_BOOL = 8
- COMPARE_TYPE_INT_EQ = 3
- COMPARE_TYPE_INT_GT = 5
- COMPARE_TYPE_INT_GTE = 4
- COMPARE_TYPE_INT_LT = 7
- COMPARE_TYPE_INT_LTE = 6
- COMPARE_TYPE_KEYWORD = 2
- COMPARE_TYPE_REGEX = 10
- COMPARE_TYPE_TEXT = 1
- COMPARE_TYPE_WILDCARD = 11
- addValue() : ISearchRequestSimpleQuery
- Add value to compare (string)
- addValueArray() : ISearchRequestSimpleQuery
- Add value to compare (array)
- addValueBool() : ISearchRequestSimpleQuery
- Add value to compare (bool)
- addValueInt() : ISearchRequestSimpleQuery
- Add value to compare (int)
- getField() : string
- Get the field to apply query
- getType() : int
- Get the compare type of the query
- getValues() : array
- Get the all values to compare
- setField() : ISearchRequestSimpleQuery
- Set the field to apply query
Constants
COMPARE_TYPE_ARRAY
public
mixed
COMPARE_TYPE_ARRAY
= 9
COMPARE_TYPE_BOOL
public
mixed
COMPARE_TYPE_BOOL
= 8
COMPARE_TYPE_INT_EQ
public
mixed
COMPARE_TYPE_INT_EQ
= 3
COMPARE_TYPE_INT_GT
public
mixed
COMPARE_TYPE_INT_GT
= 5
COMPARE_TYPE_INT_GTE
public
mixed
COMPARE_TYPE_INT_GTE
= 4
COMPARE_TYPE_INT_LT
public
mixed
COMPARE_TYPE_INT_LT
= 7
COMPARE_TYPE_INT_LTE
public
mixed
COMPARE_TYPE_INT_LTE
= 6
COMPARE_TYPE_KEYWORD
public
mixed
COMPARE_TYPE_KEYWORD
= 2
COMPARE_TYPE_REGEX
public
mixed
COMPARE_TYPE_REGEX
= 10
COMPARE_TYPE_TEXT
public
mixed
COMPARE_TYPE_TEXT
= 1
COMPARE_TYPE_WILDCARD
public
mixed
COMPARE_TYPE_WILDCARD
= 11
Methods
addValue()
Add value to compare (string)
public
addValue(string $value) : ISearchRequestSimpleQuery
Parameters
- $value : string
Tags
Return values
ISearchRequestSimpleQuery —addValueArray()
Add value to compare (array)
public
addValueArray(array $value) : ISearchRequestSimpleQuery
Parameters
- $value : array
Tags
Return values
ISearchRequestSimpleQuery —addValueBool()
Add value to compare (bool)
public
addValueBool(bool $value) : ISearchRequestSimpleQuery
Parameters
- $value : bool
Tags
Return values
ISearchRequestSimpleQuery —addValueInt()
Add value to compare (int)
public
addValueInt(int $value) : ISearchRequestSimpleQuery
Parameters
- $value : int
Tags
Return values
ISearchRequestSimpleQuery —getField()
Get the field to apply query
public
getField() : string
Tags
Return values
string —getType()
Get the compare type of the query
public
getType() : int
Tags
Return values
int —getValues()
Get the all values to compare
public
getValues() : array
Tags
Return values
array —setField()
Set the field to apply query
public
setField(string $field) : ISearchRequestSimpleQuery
Parameters
- $field : string