Afficher les erreurs de validation en entête de formulaire

Sur un formulaire comportant de nombreux champs, il peut être utile de regrouper l’ensemble des messages d’erreur en entête, l’utilisateur ayant ainsi accès d’un coup d’oeil à l’ensemble des erreurs. Cela peut également être utile lorsque certains champs sont trop petits pour y afficher un message d’erreur, l’utilisateur voyant alors que le champ est mal rempli mais ne sachant pas pourquoi. Voyons comment récupérer l’ensemble des messages d’erreur de validation d’un Modèle, et comment les afficher sur un formulaire.

Récupérer les messages de validation d’un Modèle

Les différents messages d’erreur sont stockés dans la variable validationErrors du Modèle. Dans le cas d’un enregistrement unique, le contenu de validationErrors est :

$this->validationErrors = array(
	'champ1' => 'message1',
	'champ2' => 'message2');

Dans le cas d’enregistrements multiples, les clés sont les id des enregistrements et les valeurs les paires champ / message :

$this->validationErrors = array(
	'1' => array(
		'champ1' => 'message1',
		'champ2' => 'message2'),
	'2' => array(
		'champ1' => 'message1',
		'champ2' => 'message2'));

Nous allons ajouter dans le AppModel une fonction error_messages qui renvoie un tableau contenant la liste de l’ensemble des messages d’erreur, en s’assurant qu’un même message présent plusieurs fois dans validationErrors ne soit présent qu’une fois dans le tableau final.

// {app}/app_model.php
function error_messages()
{
	if (empty($this->validationErrors)) return array();
 
	$messages = array();
	foreach ($this->validationErrors as $key => $val)
	{
		if (is_numeric($key))
		{
			foreach ($val as $k => $v)
			{
				$messages[] = $v;
			}
		}
		else
		{
			$messages[] = $val;
		}
	}
 
	return array_unique($messages);
}

Afficher les erreurs dans un formulaire

Nous allons créer un MyFormHelper héritant du FormHelper de CakePHP. Celui-ci nous permettra de bénéficier de toutes les méthodes du FormHelper, tout en rajoutant notre méthode d’affichage d’erreurs.

// {app}/views/helpers/my_form_helper.php
App::import('Helper', 'Form');
 
class MyFormHelper extends FormHelper
{
	function errors($model)
	{
		$model = Inflector::camelize($model);
		$this->setEntity($model);
		$errors = array();
		if (ClassRegistry::isKeySet($model))
		{
			$object =& ClassRegistry::getObject($model);
			$errors = $object->error_messages();
		}
		if (empty($errors))
		{
			return false;
		}
		$out = '<div class="error-messages">' . "\n";
		$out .= '<h2>Veuillez corriger les erreurs mentionnées ci-dessous</h2>' . "\n";
		$out .= '<ul>' . "\n";
		foreach ($errors as $error)
		{
			$out .= "<li>$error</li>\n";
		}
		$out .= '</ul>' . "\n";
		$out .= '</div>' . "\n";
		return $out;
	}
}

La méthode errors récupère les messages d’erreur du modèle demandé et les renvoie sous forme de liste dans une div. Il faut ensuite inclure notre Helper depuis le AppController :

// {app}/app_controller.php
class AppController extends Controller {
	var $helpers = array('MyForm');
}

Enfin, nous allons utiliser dans la vue non plus la variable $form d’origine mais $myForm :

// {app}/views/posts/add.ctp
<h1>Nouveau post</h1>
<?php echo $myForm->errors('Post') ?>
<?php echo $myForm->create('Post') ?>
<?php echo $myForm->inputs() ?>
<?php echo $myForm->end('Ajouter') ?>

Voici le résultat d’un formulaire comportant des erreurs de validation :

Matthieu Sadouni