Class to checkbox field (multiselect) More...

Inheritance diagram for CheckboxField:

Collaboration diagram for CheckboxField:

Public Member Functions
	printInputSearchField ($fieldInfos, $key, $value, $keyPrefix='', $keySuffix='', $moreCss='', $moreAttrib='')
	Return HTML string to put an input search field into a page.

	printInputField ($fieldInfos, $key, $value, $keyPrefix='', $keySuffix='', $moreCss='', $moreAttrib='')
	Return HTML string to put an input field into a page.

	printOutputField ($fieldInfos, $key, $value, $keyPrefix='', $keySuffix='', $moreCss='', $moreAttrib='')
	Return HTML string to show a field into a page.

	getInputCss ($fieldInfos, $moreCss='', $defaultCss='')
	Get input CSS.

	verifyFieldValue ($fieldInfos, $key, $value)
	Verify if the field value is valid.

	verifyPostFieldValue ($fieldInfos, $key, $keyPrefix='', $keySuffix='')
	Verify if the field value from GET/POST is valid.

	getPostFieldValue ($fieldInfos, $key, $defaultValue=null, $keyPrefix='', $keySuffix='')
	Get field value from GET/POST.

	getPostSearchFieldValue ($fieldInfos, $key, $defaultValue=null, $keyPrefix='', $keySuffix='')
	Get search field value from GET/POST.

	sqlFilterSearchField ($fieldInfos, $key, $value)
	Get sql filter for search field.

	getOptions ($fieldInfos, $key, $addEmptyValue=false, $reload=false)
	Get list of options.

Public Member Functions inherited from CommonField
	__construct ($db)
	Constructor.

	clearErrors ()
	clear errors

	errorsToString ($separator=', ')
	Method to output saved errors.

	isEmptyValue ($fieldInfos, $value, $emptyValues=null)
	Check if the value is deemed as empty.

Additional Inherited Members
Static Public Member Functions inherited from CommonField
static	setForm (&$form)
	Set form used for print the field.

static	setValidator (&$validator)
	Set validator used for check the field value.

Detailed Description

Class to checkbox field (multiselect)

Definition at line 31 of file checkboxfield.class.php.

Member Function Documentation

◆ getInputCss()

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

Get input CSS.

Parameters

FieldInfos	$fieldInfos	Properties of the field
string	$moreCss	Value for css to define style/length of field.
string	$defaultCss	Default value for css to define style/length of field.

Returns: string

See also: self\printInputSearchField(), self\printInputField()

Reimplemented from CommonField.

Definition at line 136 of file checkboxfield.class.php.

Referenced by printInputField().

◆ getOptions()

CheckboxField::getOptions	(	$fieldInfos,
		$key,
		$addEmptyValue = false,
		$reload = false )

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

Returns: array<string,array{label:string,parent:string}>

Reimplemented from CommonSelectField.

Definition at line 273 of file checkboxfield.class.php.

Referenced by printInputField(), printOutputField(), and verifyFieldValue().

◆ getPostFieldValue()

CheckboxField::getPostFieldValue	(	$fieldInfos,
		$key,
		$defaultValue = null,
		$keyPrefix = '',
		$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)

Returns: mixed

See also: self\printInputField()

Reimplemented from CommonField.

Definition at line 201 of file checkboxfield.class.php.

References GETPOST().

◆ getPostSearchFieldValue()

CheckboxField::getPostSearchFieldValue	(	$fieldInfos,
		$key,
		$defaultValue = null,
		$keyPrefix = '',
		$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)

Returns: mixed

See also: self\printInputSearchField()

Reimplemented from CommonField.

Definition at line 228 of file checkboxfield.class.php.

References GETPOST().

◆ printInputField()

CheckboxField::printInputField	(	$fieldInfos,
		$key,
		$value,
		$keyPrefix = '',
		$keySuffix = '',
		$moreCss = '',
		$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

Returns: string

Reimplemented from CommonField.

Definition at line 68 of file checkboxfield.class.php.

References $conf, getDolGlobalString(), getInputCss(), getOptions(), and CommonField\isEmptyValue().

Referenced by printInputSearchField().

◆ printInputSearchField()

CheckboxField::printInputSearchField	(	$fieldInfos,
		$key,
		$value,
		$keyPrefix = '',
		$keySuffix = '',
		$moreCss = '',
		$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

Returns: string

Reimplemented from CommonField.

Definition at line 51 of file checkboxfield.class.php.

References printInputField().

◆ printOutputField()

CheckboxField::printOutputField	(	$fieldInfos,
		$key,
		$value,
		$keyPrefix = '',
		$keySuffix = '',
		$moreCss = '',
		$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

Returns: string

Reimplemented from CommonField.

Definition at line 98 of file checkboxfield.class.php.

References getOptions(), and CommonField\isEmptyValue().

◆ sqlFilterSearchField()

CheckboxField::sqlFilterSearchField	(	$fieldInfos,
		$key,
		$value )

Get sql filter for search field.

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)

Returns: string

See also: self\printInputSearchField(), self\getPostSearchFieldValue()

Reimplemented from CommonField.

Definition at line 250 of file checkboxfield.class.php.

References CommonField\isEmptyValue().

◆ verifyFieldValue()

CheckboxField::verifyFieldValue	(	$fieldInfos,
		$key,
		$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)

Returns: bool

See also: self\printInputField()

Reimplemented from CommonField.

Definition at line 150 of file checkboxfield.class.php.

References getOptions(), and CommonField\isEmptyValue().

Referenced by verifyPostFieldValue().

◆ verifyPostFieldValue()

CheckboxField::verifyPostFieldValue	(	$fieldInfos,
		$key,
		$keyPrefix = '',
		$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)

Returns: bool

See also: self\printInputField()

Reimplemented from CommonField.

Definition at line 182 of file checkboxfield.class.php.

References GETPOST(), and verifyFieldValue().

The documentation for this class was generated from the following file:

dolibarr_dev/htdocs/core/class/fields/checkboxfield.class.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getInputCss()

◆ getOptions()

◆ getPostFieldValue()

◆ getPostSearchFieldValue()

◆ printInputField()

◆ printInputSearchField()

◆ printOutputField()

◆ sqlFilterSearchField()

◆ verifyFieldValue()

◆ verifyPostFieldValue()