ChkbxlstField

class ChkbxlstField extends CommonSellistField (View source)

Class to chkbxlst field (multiselect)

Constants

MAP_ID_TO_CODE

Properties

DoliDB $db from  CommonField
string $error from  CommonField
string[] $errors from  CommonField
string $type from  CommonField
string $label from  CommonField
static Form|null $form from  CommonField
static Validate|null $validator from  CommonField
array<int, mixed> $emptyValues
static string $ajaxUrl from  CommonSellistField
static array<string, array<string, array{label: string, parent: string}>> $options from  CommonSellistField

Methods

__construct(DoliDB $db)

Constructor

from  CommonField
static void
setForm(Form $form)

Set form used for print the field

from  CommonField
static void
setValidator(Validate $validator)

Set validator used for check the field value

from  CommonField
void
clearErrors()

clear errors

from  CommonField
string
errorsToString(string $separator = ', ')

Method to output saved errors

from  CommonField
bool
isEmptyValue(FieldInfos $fieldInfos, mixed $value, array<int, mixed> $emptyValues = null)

Check if the value is deemed as empty

from  CommonField
string
printInputSearchField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to put an input search field into a page

string
printInputField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to put an input field into a page

string
printOutputField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to show a field into a page

getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')

Get input CSS

bool
verifyFieldValue(FieldInfos $fieldInfos, string $key, mixed $value)

Verify if the field value is valid

bool
verifyPostFieldValue(FieldInfos $fieldInfos, string $key, string $keyPrefix = '', string $keySuffix = '')

Verify if the field value from GET/POST is valid

mixed
getPostFieldValue(FieldInfos $fieldInfos, string $key, mixed $defaultValue = null, string $keyPrefix = '', string $keySuffix = '')

Get field value from GET/POST

mixed
getPostSearchFieldValue(FieldInfos $fieldInfos, string $key, mixed $defaultValue = null, string $keyPrefix = '', string $keySuffix = '')

Get search field value from GET/POST

sqlFilterSearchField($fieldInfos, $key, $value)

Get sql filter for search field

array{all: string, tableName: string, labelFullFields: string[], labelFields: string[], labelAlias: string[], keyField: string, parentName: string, parentFullField: string, parentField: string, parentAlias: string, filter: string, categoryType: string, categoryRoots: string, sortField: string}
getOptionsParams(array<string, mixed> $options)

Get all parameters in the options

from  CommonSellistField
array{field: string, alias: string}
getSqlFieldInfo(string $fullField)

Get sql info of the full field

from  CommonSellistField
array<string, array{label: string, parent: string}>|null
getOptions(FieldInfos $fieldInfos, string $key, bool $addEmptyValue = false, bool $reload = false, string|array<int, string> $selectedValues = array())

Get list of options

Details

in CommonField at line 79
__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

in CommonField at line 111
static void setForm(Form $form)

Set form used for print the field

Parameters

Form $form

Form handler

Return Value

void

in CommonField at line 122
static void setValidator(Validate $validator)

Set validator used for check the field value

Parameters

Validate $validator

Validate handler

Return Value

void

in CommonField at line 132
void clearErrors()

clear errors

Return Value

void

in CommonField at line 144
string errorsToString(string $separator = ', ')

Method to output saved errors

Parameters

string $separator

Separator between each error

Return Value

string

String with errors

in CommonField at line 157
bool isEmptyValue(FieldInfos $fieldInfos, mixed $value, array<int, mixed> $emptyValues = null)

Check if the value is deemed as empty

Parameters

FieldInfos $fieldInfos

Properties of the field
mixed $value

Value to check (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
array<int, mixed> $emptyValues

List of value deemed as empty

Return Value

bool

at line 50
string printInputSearchField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to put an input search field into a page

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $value

Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)
string $moreCss

Value for css to define style/length of field.
string $moreAttrib

To add more attributes on html input tag

Return Value

string

at line 81
string printInputField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to put an input field into a page

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $value

Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)
string $moreCss

Value for css to define style/length of field.
string $moreAttrib

To add more attributes on html input tag

Return Value

string

at line 108
string printOutputField(FieldInfos $fieldInfos, string $key, mixed $value, string $keyPrefix = '', string $keySuffix = '', string $moreCss = '', string $moreAttrib = '')

Return HTML string to show a field into a page

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $value

Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)
string $moreCss

Value for css to define style/length of field.
string $moreAttrib

To add more attributes on html input tag

Return Value

string

at line 154
getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')

Get input CSS

Parameters

$fieldInfos
$moreCss
$defaultCss

at line 168
bool verifyFieldValue(FieldInfos $fieldInfos, string $key, mixed $value)

Verify if the field value is valid

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $value

Value to check (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)

Return Value

bool

See also

\self::printInputField()

at line 195
bool verifyPostFieldValue(FieldInfos $fieldInfos, string $key, string $keyPrefix = '', string $keySuffix = '')

Verify if the field value from GET/POST is valid

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)

Return Value

bool

See also

\self::printInputField()

at line 214
mixed getPostFieldValue(FieldInfos $fieldInfos, string $key, mixed $defaultValue = null, string $keyPrefix = '', string $keySuffix = '')

Get field value from GET/POST

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $defaultValue

Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)

Return Value

mixed

See also

\self::printInputField()

at line 239
mixed getPostSearchFieldValue(FieldInfos $fieldInfos, string $key, mixed $defaultValue = null, string $keyPrefix = '', string $keySuffix = '')

Get search field value from GET/POST

Parameters

FieldInfos $fieldInfos

Properties of the field
string $key

Key of field
mixed $defaultValue

Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string $keyPrefix

Prefix string to add into name and id of field (can be used to avoid duplicate names)
string $keySuffix

Suffix string to add into name and id of field (can be used to avoid duplicate names)

Return Value

mixed

See also

\self::printInputSearchField()

at line 261
sqlFilterSearchField($fieldInfos, $key, $value)

Get sql filter for search field

Parameters

$fieldInfos
$key
$value

in CommonSellistField at line 73
array{all: string, tableName: string, labelFullFields: string[], labelFields: string[], labelAlias: string[], keyField: string, parentName: string, parentFullField: string, parentField: string, parentAlias: string, filter: string, categoryType: string, categoryRoots: string, sortField: string} getOptionsParams(array<string, mixed> $options)

Get all parameters in the options

Parameters

array<string, mixed> $options

Options of the field

Return Value

array{all: string, tableName: string, labelFullFields: string[], labelFields: string[], labelAlias: string[], keyField: string, parentName: string, parentFullField: string, parentField: string, parentAlias: string, filter: string, categoryType: string, categoryRoots: string, sortField: string}

in CommonSellistField at line 172
array{field: string, alias: string} getSqlFieldInfo(string $fullField)

Get sql info of the full field

Parameters

string $fullField

Full field (ex: p.test AS label or f(a,b,c) AS label)

Return Value

array{field: string, alias: string}

at line 284
array<string, array{label: string, parent: string}>|null getOptions(FieldInfos $fieldInfos, string $key, bool $addEmptyValue = false, bool $reload = false, string|array<int, string> $selectedValues = array())

Get list of options

Parameters

FieldInfos $fieldInfos

Array of properties for field to show
string $key

Key of field
bool $addEmptyValue

Add also empty value if needed
bool $reload

Force reload options
string|array<int, string> $selectedValues

Only selected values

Return Value

array<string, array{label: string, parent: string}>|null

Return null if error