AjaxOptions
in package
Provides parameters for the behavoir of ajax powered columns. (Custom ajax columns or many to one ajax columns)
Table of Contents
- $fullSearch : bool
- $imageFieldname : string
- $inputTimeout : int
- $maxImageWidth : int
- $maxResults : int
- $minInputLength : int
- $searchFieldnames : array<string|int, string>
- __construct() : mixed
Properties
$fullSearch
public
bool
$fullSearch
= false
true = %term% (contains), false = term% (starts with)
$imageFieldname
public
string
$imageFieldname
= ''
The name of a table field that is used to display an image in the result list
$inputTimeout
public
int
$inputTimeout
= 0
The amount of time without user input, before the ajax call is fired [milliseconds]
$maxImageWidth
public
int
$maxImageWidth
= 0
The max. with of the images in the result list (will be croped down to this)
$maxResults
public
int
$maxResults
= 0
The max. number of results to return, 0 = unlimited
$minInputLength
public
int
$minInputLength
= 1
The min. amount of characters to type before the ajax call is fired
$searchFieldnames
public
array<string|int, string>
$searchFieldnames
= []
The names of the table fields that are used for the searching records
Methods
__construct()
public
__construct([string $imageFieldname = '' ][, array<string|int, string> $searchFieldnames = [] ][, int $minInputLength = 1 ][, int $maxResults = 50 ][, bool $fullSearch = false ][, int $maxImageWidth = 100 ][, int $inputTimeout = 300 ]) : mixed
Parameters
- $imageFieldname : string = ''
-
The name of a table field that is used to display an image in the result list
- $searchFieldnames : array<string|int, string> = []
-
The names of the table fields that are used for the searching records
- $minInputLength : int = 1
-
The min. amount of characters to type before the ajax call is fired
- $maxResults : int = 50
-
The max. number of results to return, 0 = unlimited
- $fullSearch : bool = false
-
true = %term% (contains), false = term% (starts with)
- $maxImageWidth : int = 100
-
The max. with of the images in the result list (will be croped down to this)
- $inputTimeout : int = 300
-
The amount of time without user input, before the ajax call is fired [milliseconds]