Annotation de classe @before_build_array
-
Événement déclenché avant la construction d’un objet à partir d’un tableau.
/** * @before_build_array [callable] */ class A_Class
Appelle la méthode nommée de la classe avant de débuter la construction d’un objet de cette classe via Object_Builder_Array. Cette méthode doit être statique et publique, l’objet n’étant pas encore créé.
Cet appel a notamment lieu lorsque l’utilisateur enregistre un formulaire du logiciel. Vous pouvez ainsi personnaliser pour votre classe les données du tableau qui contient les données.
Liste de paramètres
- callable
static function beforeBuildArrayMethod(array $source_array) : boolean
Une méthode à appeler à chaque fois que l’événement est déclenché pour un objet de cette classe.
La méthode appelée à défaut de déclaration serastatic::beforeBuildArrayMethod
.
—$source_array
: le tableau source pour la construction de l’objet. Si le tableau doit être modifié, l’argument doit être déclaré par référence.
— Valeur de retour : Aucune valeur de retour n’est attendu.Valeurs de retour
Exemple
namespace Nickname\Project; /** * @before_build_array beforeBuildArray */ class A_Class { use Has_Name; /** * @param $array array */ public static function beforeBuildArray(array &$array) { if (isset($array['name']) && ($array['name'] === '')) { $array['name'] = 'Default name'; } } }
Dans cet exemple, le nom sera initialisé à
'Default name'
si dans un formulaire permettant de saisir le nom l’utilisateur laisse la zone vide.Voir aussi
- Annotations
- Annotation de classe @after_build_array – Événement déclenché après la construction d’un objet à partir d’un tableau