A conventient wrapper for building the filter string used in queries.
For details, see the API documentation on querying.
All the magic methods can also be called statically, e.g.
Filter::equals("NAME", "Joe")->greaterThan("HEIGHT", 0)
For most operators (all except ll, rl, fl and their aliases), DateTime objects can be
used as value.
Magic methods summary
public
PipelinerSales\ApiClient\Query\Filter
|
#
eq( string $fieldName, mixed $value )
field equals value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
equals( string $fieldName, mixed $value )
alias for eq
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
ne( string $fieldName, mixed $value )
field does not equal value
field does not equal value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
doesNotEqual( string $fieldName, mixed $value )
alias for ne
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
gt( string $fieldName, mixed $value )
field is greater than value
field is greater than value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
greaterThan( string $fieldName, mixed $value )
alias for gt
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
lt( string $fieldName, mixed $value )
field is less than value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
lessThan( string $fieldName, mixed $value )
alias for lt
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
ge( string $fieldName, mixed $value )
field is greater or equal to value
field is greater or equal to value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
gte( string $fieldName, mixed $value )
alias for ge
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
greaterOrEqual( string $fieldName, mixed $value )
alias for ge
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
le( string $fieldName, mixed $value )
field is less or equal to value
field is less or equal to value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
lte( string $fieldName, mixed $value )
alias for le
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
lessOrEqual( string $fieldName, mixed $value )
alias for le
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
ll( string $fieldName, string $value )
field starts with value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
startsWith( string $fieldName, string $value )
alias for ll
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
rl( string $fieldName, string $value )
field ends with value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
endsWith( string $fieldName, string $value )
alias for rl
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
fl( string $fieldName, string $value )
field contains value
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
contains( string $fieldName, string $value )
alias for fl
Parameters
Returns
|
public
PipelinerSales\ApiClient\Query\Filter
|
#
raw( string $filterString )
appends a separator (|) followed by the raw filter string to the current filter string
appends a separator (|) followed by the raw filter string to the current filter string
Parameters
Returns
|