PricecyField Class Reference

Class to pricecy field (price with currency) More...

Inheritance diagram for PricecyField:

Collaboration diagram for PricecyField:

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.
	getPriceAndCurrencyFromValue ($fieldInfos, $value)
	Get price and currency from value.
	getPriceAndCurrencyAliasAndField ($fieldInfos, $key)
	Get alias and field name in table for price and currency.
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 pricecy field (price with currency)

Definition at line 30 of file pricecyfield.class.php.

Member Function Documentation

getInputCss()

PricecyField::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 131 of file pricecyfield.class.php.

Referenced by printInputField(), and printInputSearchField().

getPostFieldValue()

PricecyField::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 192 of file pricecyfield.class.php.

References GETPOST(), and price2num().

getPostSearchFieldValue()

PricecyField::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 216 of file pricecyfield.class.php.

References GETPOST().

getPriceAndCurrencyAliasAndField()

PricecyField::getPriceAndCurrencyAliasAndField	(		$fieldInfos,
			$key )

Get alias and field name in table for price and currency.

Parameters

FieldInfos	$fieldInfos	Properties of the field
string	$key	Key of field

Returns

array{aliasPrice:string,aliasCurrency:string,fieldPrice:string,fieldCurrency:string}

Definition at line 297 of file pricecyfield.class.php.

Referenced by printInputSearchField(), and sqlFilterSearchField().

getPriceAndCurrencyFromValue()

PricecyField::getPriceAndCurrencyFromValue	(		$fieldInfos,
			$value )

Get price and currency from value.

Parameters

FieldInfos	$fieldInfos	Properties of the field
string	$value	Value in memory is a php string like '0.01:EUR'

Returns

array{price:double,currency:string}

Definition at line 270 of file pricecyfield.class.php.

References CommonField\isEmptyValue().

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

printInputField()

PricecyField::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 84 of file pricecyfield.class.php.

References getInputCss(), getPriceAndCurrencyFromValue(), CommonField\isEmptyValue(), and price().

printInputSearchField()

PricecyField::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 50 of file pricecyfield.class.php.

References getInputCss(), getPriceAndCurrencyAliasAndField(), and getPriceAndCurrencyFromValue().

printOutputField()

PricecyField::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 112 of file pricecyfield.class.php.

References getDolGlobalInt(), getPriceAndCurrencyFromValue(), CommonField\isEmptyValue(), and price().

sqlFilterSearchField()

PricecyField::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 241 of file pricecyfield.class.php.

References getPriceAndCurrencyAliasAndField(), and natural_search().

verifyFieldValue()

PricecyField::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 145 of file pricecyfield.class.php.

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

Referenced by verifyPostFieldValue().

verifyPostFieldValue()

PricecyField::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 172 of file pricecyfield.class.php.

References GETPOST(), and verifyFieldValue().

---

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

• dolibarr_23.0/htdocs/core/class/fields/pricecyfield.class.php