DocumentationDeveloppeur

De EPNadmin
Aller à : navigation, rechercher

Base de données

Convention de code

Nom de table

1 ou plusieurs mots, en minuscule, séparé par _ . Par exemple : groups_users

Nom de champs

Toujours en 2 parties, et en minuscule.

  • 1ère partie 2 lettres représentant le nom de la table.
Par exemple : les champs de la table groups_users commenceront par gu_ 
  • 2ème partie le nom du champs.
Par exemple : pour le champs name dans la table groups_users ce sera gu_name. 

Si un champs fait référence a une clef d'une autre table alors on spécifie le champs comme défini dans la table d'origine.

Par exemple : le champs facilitator id  dans la table groups_users sera : gu_fc_id

Librairie

Validator

La classe Validator, qui se trouve dans le fichier includes/class.Validator.inc.php, permet de valider des variables.

Un série de test est également disponible dans le fichier tests/unitTest/class.Validator.inc.php.

Utilisation

<?php

$variable_a_valider = array('nom_variable' => );

$validator = new Validator();

$validator->addRule('nom_variable', 'notEmpty', ' ', 'Veuillez remplir la variable');

if( $validator->executeRules( $variable_a_valider ) {

 echo implode(, $validator->getMessages() ); // Veuillez remplir la variable

}

?>

Règles disponibles

notEmpty

Critère : aucun

Vérifie que la longueur de la variable est supérieur à zéro.

maxLength

Critère : (int) longueur max

Vérifie que la longueur de la variable ne dépasse pas la longueur max.

isLocalDateValid

Critère : aucun

Vérifie que la variable est une date correctement formatée, basé sur la locale utilisée.

isPatternValid

Critère : (string) chaîne perl regexp

Vérifie que la variable valide la regexp.

Ajout de règle

Pour ajouter une nouvelle règle il suffit de rajouter une nouvelle méthode à la classe Validator.

Si nous voulons rajouter la règle isModuloOf, la méthode devra s'appeller : _ruleIsModuloOf .

La méthode sera appelé avec 2 arguments, la valeur de la variable a tester et le critère associé.

Le résultat de la méthode devra être de type booléen :

  • true pour le succès de la règle
  • false pour l'échec de la règle et ajouter le message d'erreur dans la pile
<?php
Class Validator {
...
function _ruleIsModuloOf($value, $criteria) {
 return ! $value % $criteria;
}
...
}
?>
<?
 $validator->addRule('nom_variable', 'isModuloOf', 2, "La variable n'est pas un modulo de 2");
?>