Menu

## Filter
in package

Filter.php : 14

Represents an actual filter (with values) on a record.

For Example: amount > 21.4

##### Tags

internal

### Table of Contents

VALID_OPERATORS = ['>', '<', '>=', '<=', '=', '!=', 'contains', 'startswith', 'endswith']
$field : string
$operator : string
$value : string
__construct() : mixed
  Constructor.
appendToUrlParams() : mixed
  Adds a filter to an url param array.

### Constants

#### VALID_OPERATORS

Filter.php : 23
`public mixed VALID_OPERATORS = ['>', '<', '>=', '<=', '=', '!=', 'contains', 'startswith', 'endswith']`

### Properties

#### $field

Filter.php : 17
`public string $field`

The fieldname the filter is applied to

#### $operator

Filter.php : 19
`public string $operator`

['>','<','>=','<=','=','!=','contains','startswith','endswith']

#### $value

Filter.php : 21
`public string $value`

The value

### Methods

#### __construct()

Filter.php : 30

Constructor.

`public __construct(string $field, string $operator, string $value) : mixed`

##### Parameters

$field : string

  The fieldname the filter is applied to

$operator : string

  ['>','<','>=','<=','=','!=','contains','startswith','endswith']

$value : string

  The value

##### Return values

mixed —

#### appendToUrlParams()

Filter.php : 53

Adds a filter to an url param array.

`public appendToUrlParams(array<string|int, mixed> &$urlParams, int $filterNo) : mixed`

##### Parameters

$urlParams : array<string|int, mixed>
$filterNo : int

##### Return values

mixed —

## Search results