Functions Dev: Difference between revisions

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 21: Line 21:
Possible parameters of the second argument :
Possible parameters of the second argument :


*'none' =
*'aZ' =
*'int' =
*'aZ09' =  
*'intcomma' =
*'array' =  
*'alpha' =
*'san_alpha' =
*'aZ' =  
*'aZ09' = verifies that it is non-special characters and numbers
*'array' = verifies that it is an array
*'san_alpha' = purged string (do not use for free text)
*'nohtml' = verifies that there is no html code
*'nohtml' = verifies that there is no html code
*'alphanohtml' = checks that there is no html code
*'alphanohtml' = checks that there is no html code
Line 54: Line 50:
|-
|-
|'aZ09'
|'aZ09'
|
|verifies that it is non-special characters and numbers
|-
|-
|'array'
|'array'
|
|verifies that it is an array
|-
|-
|'san_alpha'
|'san_alpha'
|
|purged string (do not use for free text)
|-
|-
|'nohtml'
|'nohtml'

Revision as of 12:20, 31 March 2021

The following page describes some important functions used by dolibarr.

GETPOST

GETPOST() : function to retrieve the content of GET or POST variables in a more secure way. The PHP methods $_GET and $_POST should not be used.


Possible use :

Example in php:

$myField= $_POST["myField"];

becomes if the element passed in parameter is a number :

$myField= GETPOST("myField", 'int');


Possible parameters of the second argument :

  • 'aZ' =
  • 'aZ09' =
  • 'array' =
  • 'san_alpha' =
  • 'nohtml' = verifies that there is no html code
  • 'alphanohtml' = checks that there is no html code
  • 'custom' = defined by the following filters and options with the parameters $filter and $options
Parameters
'none' for no parameter type check
'int' check that it's a numeric (integer or decimal)
'intcomma' checks that it is an integer with commas ('1,2,3,4...')
'alpha' verifies that it is text and signs
'aZ' verifies that it is a-z only
'aZ09' verifies that it is non-special characters and numbers
'array' verifies that it is an array
'san_alpha' purged string (do not use for free text)
'nohtml'
'alphanohtml'
'custom'


For more information see the comments of the function in the file htdocs/core/lib/functions.lib.php

GETPOSTISSET()

GETPOSTISSET(variableName) allows to know if the GET or POST variable passed in parameter is defined.

Example in php:

if (isset($_POST['myField'])){...}

becomes :

if (GETPOSTISSET('myField')){...}

For more information see the comments of the function in the file htdocs/core/lib/functions.lib.php

img_picto

img_picto() function to insert an image.

print img_picto(imagetitle,imagename);

For more information see the comments of the function in the file htdocs/core/lib/functions.lib.php