Fonctions utiles Développeur Dolibarr: Difference between revisions

Latest revision as of 11:54, 5 September 2024

La page suivante décrit quelques fonctions importantes utilisées par les développeurs de dolibarr.

GETPOST, GETPOSTINT, GETPOSTFLOAT

GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisées. Le retour est une chaine même si cette chaine peut représenter un numérique. GETPOSTINT() : est similaire mais le retour sera forcé au typage "int". GETPOSTFLOAT() : est similaire mais le retour sera forcé au typage "float".

Utilisation possible :

Exemple en php :

$monChamp= $_POST["monChamp"];

devient si l'élément passé en paramètre est un nombre :

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

Paramètres possibles du deuxième argument : 'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.

'none' pour pas de vérification du type de paramètre,
'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
'alpha'=vérifie que c'est du texte et des signes
'aZ'=vérifie que c'est a-z seulement
'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
'array'=vérifie que c'est un tableau
'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
'nohtml'=verifie qu'il n'y a pas de code html
'alphanohtml'=verifie qu'il n'y a pas de code html
'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

GETPOSTISSET()

GETPOSTISSET(nomDeLaVariable) permet de savoir si la variable GET ou POST passée en paramètre est définie.

Exemple en php :

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

devient :

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

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

img_picto

img_picto() fonction permettant d'insérer une image.

print img_picto(titreDelimage,nomDeLimage);

Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php

@@ Line 1: / Line 1: @@
-Lorsque j'ai commencé le développement sous Dolibarr, je me suis retrouvé confronter face à tout un tas de fonctions importantes utilisées par dolibarr que je ne connaissais pas.
+{{TemplateDocDev}}
-N'ayant trouvé que le fichier code source en documentation, j'ai décidé de récapituler ces fonctions dans cette page.
+La page suivante décrit quelques fonctions importantes utilisées par les développeurs de dolibarr.
+==GETPOST, GETPOSTINT, GETPOSTFLOAT==
-GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé.
+GETPOST() : fonction permettant de récupérer le contenu des variables GET ou POST de manière plus sécurisé. Les méthodes PHP $_GET et $_POST ne doivent donc pas être utilisées. Le retour est une chaine même si cette chaine peut représenter un numérique.
+GETPOSTINT() : est similaire mais le retour sera forcé au typage "int".
+GETPOSTFLOAT() : est similaire mais le retour sera forcé au typage "float".
 Utilisation possible :
@@ Line 10: / Line 12: @@
 Exemple en php : <syntaxhighlight lang="PHP">
 $monChamp= $_POST["monChamp"];
-</syntaxhighlight>devient<syntaxhighlight lang="PHP">
+</syntaxhighlight>devient si l'élément passé en paramètre est un nombre :<syntaxhighlight lang="PHP">
-$monChamp= GETPOST("monChamp");
-</syntaxhighlight>Si nous souhaitons être sûr que l'élément passé en paramètre est un entier, nous pouvons préciser :<syntaxhighlight lang="PHP">
 $monChamp= GETPOST("monChamp",'int');
 </syntaxhighlight>
+Paramètres possibles du deuxième argument :  'none','int','intcomma','alpha','aZ','aZ09','array','san_alpha','nohtml', 'alphanohtml','custom'.
+*'none' pour pas de vérification du type de paramètre,
+*'int'= vérifie que c'est un numérique(entier ou nombre à virgule)
+*'intcomma'=vérifie que c'est un entier avec des virgules ('1,2,3,4...')
+*'alpha'=vérifie que c'est du texte et des signes
+*'aZ'=vérifie que c'est a-z seulement
+*'aZ09'=vérifie que c'est des caractères non spéciaux et des nombres
+*'array'=vérifie que c'est un tableau
+*'san_alpha'=chaîne de caractères purgée (ne pas utiliser pour du texte libre)
+*'nohtml'=verifie qu'il n'y a pas de code html
+*'alphanohtml'=verifie qu'il n'y a pas de code html
+*'custom'= défini par les filtres et les options qui suivent avec les paramètres $filter et $options
+Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php
+==GETPOSTISSET()==
+GETPOSTISSET(nomDeLaVariable) permet de savoir si la variable GET ou POST passée en paramètre est définie.
+Exemple en php : <syntaxhighlight lang="PHP">
+if (isset($_POST['monChamp'])){...}
+</syntaxhighlight>devient : <syntaxhighlight lang="PHP">
+if (GETPOSTISSET('monChamp')){...}
+</syntaxhighlight>Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php
+==img_picto==
+img_picto() fonction permettant d'insérer une image.<syntaxhighlight lang="PHP">
+print img_picto(titreDelimage,nomDeLimage);
+</syntaxhighlight>
+Pour plus d'information voir les commentaires de la fonction dans le fichier htdocs/core/lib/functions.lib.php<br />