DurationField Class Reference

Class to duration field. More...

Inheritance diagram for DurationField:

Collaboration diagram for DurationField:

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.
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 duration field.

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

Member Function Documentation

getInputCss()

DurationField::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 103 of file durationfield.class.php.

getPostFieldValue()

DurationField::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 157 of file durationfield.class.php.

References GETPOSTINT().

Referenced by getPostSearchFieldValue().

getPostSearchFieldValue()

DurationField::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 183 of file durationfield.class.php.

References getPostFieldValue().

printInputField()

DurationField::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 69 of file durationfield.class.php.

Referenced by printInputSearchField().

printInputSearchField()

DurationField::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 durationfield.class.php.

References printInputField().

printOutputField()

DurationField::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 89 of file durationfield.class.php.

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

sqlFilterSearchField()

DurationField::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 197 of file durationfield.class.php.

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

verifyFieldValue()

DurationField::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 117 of file durationfield.class.php.

References CommonField\isEmptyValue().

verifyPostFieldValue()

DurationField::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 141 of file durationfield.class.php.

---

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

• dolibarr_dev/htdocs/core/class/fields/durationfield.class.php