ClientFilters extends Filter
Client Filters
Table of Contents
Methods
| getFilters() | Gets a list of input fields for filtering clients |
Methods
getFilters()
Gets a list of input fields for filtering clients
public
getFilters(array<string|int, mixed> $options[, array<string|int, mixed> $vars = [] ]) : InputFields
Parameters
- $options : array<string|int, mixed>
-
A list of options for building the filters including:
- language The language for filter labels and tooltips
- company_id The company ID to filter client groups on
- $vars : array<string|int, mixed> = []
-
A list of submitted inputs that act as defaults for filter fields including:
- contact_name The (partial) name of the contact for which to fetch clients
- contact_email The (partial) email address of the contact for which to fetch clients
- contact_company The (partial) company name of the contact for which to fetch clients
- contact_country The contact country on which to filter clients
- client_group_id The client group ID on which to filter clients
- invoice_method The invoice delivery method on which to filter clients
- last_seen_start_date The start date of the "last seen" date range on which to filter clients
- last_seen_end_date The end date of the "last seen" date range on which to filter clients
Return values
InputFields —An object representing the list of filter input field