dolibarr 23.0.3
PasswordField Class Reference

Class to password field. More...

Inheritance diagram for PasswordField:
Collaboration diagram for PasswordField:

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

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

Member Function Documentation

◆ getInputCss()

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

Get input CSS.

Parameters
FieldInfos$fieldInfosProperties of the field
string$moreCssValue for css to define style/length of field.
string$defaultCssDefault value for css to define style/length of field.
Returns
string
See also
self\printInputSearchField(), self\printInputField()

Reimplemented from CommonField.

Definition at line 117 of file passwordfield.class.php.

Referenced by printInputField(), and printInputSearchField().

◆ getPostFieldValue()

PasswordField::getPostFieldValue ( $fieldInfos,
$key,
$defaultValue = null,
$keyPrefix = '',
$keySuffix = '' )

Get field value from GET/POST.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$defaultValuePreselected 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$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix 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 191 of file passwordfield.class.php.

References GETPOST().

◆ getPostSearchFieldValue()

PasswordField::getPostSearchFieldValue ( $fieldInfos,
$key,
$defaultValue = null,
$keyPrefix = '',
$keySuffix = '' )

Get search field value from GET/POST.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$defaultValuePreselected 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$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix 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 passwordfield.class.php.

References GETPOST().

◆ printInputField()

PasswordField::printInputField ( $fieldInfos,
$key,
$value,
$keyPrefix = '',
$keySuffix = '',
$moreCss = '',
$moreAttrib = '' )

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

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$valuePreselected 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$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix string to add into name and id of field (can be used to avoid duplicate names)
string$moreCssValue for css to define style/length of field.
string$moreAttribTo add more attributes on html input tag
Returns
string

Reimplemented from CommonField.

Definition at line 70 of file passwordfield.class.php.

References getInputCss().

◆ printInputSearchField()

PasswordField::printInputSearchField ( $fieldInfos,
$key,
$value,
$keyPrefix = '',
$keySuffix = '',
$moreCss = '',
$moreAttrib = '' )

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

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$valuePreselected 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$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix string to add into name and id of field (can be used to avoid duplicate names)
string$moreCssValue for css to define style/length of field.
string$moreAttribTo add more attributes on html input tag
Returns
string

Reimplemented from CommonField.

Definition at line 50 of file passwordfield.class.php.

References getInputCss().

◆ printOutputField()

PasswordField::printOutputField ( $fieldInfos,
$key,
$value,
$keyPrefix = '',
$keySuffix = '',
$moreCss = '',
$moreAttrib = '' )

Return HTML string to show a field into a page.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$valuePreselected 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$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix string to add into name and id of field (can be used to avoid duplicate names)
string$moreCssValue for css to define style/length of field.
string$moreAttribTo add more attributes on html input tag
Returns
string

Reimplemented from CommonField.

Definition at line 101 of file passwordfield.class.php.

References CommonField\isEmptyValue().

◆ sqlFilterSearchField()

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

Get sql filter for search field.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$valuePreselected 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 238 of file passwordfield.class.php.

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

◆ verifyFieldValue()

PasswordField::verifyFieldValue ( $fieldInfos,
$key,
$value )

Verify if the field value is valid.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
mixed$valueValue 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 131 of file passwordfield.class.php.

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

◆ verifyPostFieldValue()

PasswordField::verifyPostFieldValue ( $fieldInfos,
$key,
$keyPrefix = '',
$keySuffix = '' )

Verify if the field value from GET/POST is valid.

Parameters
FieldInfos$fieldInfosProperties of the field
string$keyKey of field
string$keyPrefixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keySuffixSuffix 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 175 of file passwordfield.class.php.


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