Comprobar el valor de los campos del formulario de registro

En la entrada de hoy vamos a ver la lógica para comprobar el valor de los campos del formulario de registro. Esto aplicará tanto el en formulario de registro como en el formulario de edición de nuestros datos personales.

Antes de entrar en detalle, recordemos esta entrada en la cual hablábamos acerca de cómo crear nuevos campos en el formulario de registro en modo visual bajo la plataforma de Prestashop 1.7.2. Una vez hayamos realizado la anterior, vamos a continuar…

¿Creando override para trabajar sobre el script CustomerForm?

Empezamos localizando dónde van estos datos cada vez que pulsamos sobre el botón submit del formulario de registro. Como podemos ver, estamos llamando a la clase classes/form/CustomerForm.php por lo tanto, como siempre queremos mantener las buenas prácticas en el desarrollo, vamos a crear este mismo script en nuestro override bajo la ruta override/classes/form/CustomerForm.php

¿Qué métodos llamamos al pulsar el botón submit del formulario de registro?

El script CustomerForm.php lo primero que hace tras pulsar el botón submit, es validar una serie de campos definidos.

public function submit()
{     
    if ($this->validate()) {
...

Buscando la función de validación validate(), vemos que por defecto realiza las siguientes acciones: – Validación de email. – Validación de fecha de nacimiento. Pero claro, nosotros ahora queremos validar un nuevo campo, justo el campo DNI que es el que insertamos como nuevo en nuestra entrada anterior. (Ver entrada de cómo crear nuevos campos en el formulario de registro).

Añadiendo nueva validación de longitud para campo DNI en formulario de registro.

Vamos a indicar la longitud correcta que tiene que tener nuestro nuevo campo. En el método validateFieldsLengths() añadimos 2 nuevos valores quedando de este modo:

protected function validateFieldsLengths()
{
    $this->validateFieldLength('email', 128, $this->getEmailMaxLengthViolationMessage());
    $this->validateFieldLength('firstname', 255, $this->getFirstNameMaxLengthViolationMessage());
    $this->validateFieldLength('lastname', 255, $this->getLastNameMaxLengthViolationMessage());

    // Añadimos validación para comprobar que la longitud del campo dni es correcta.
    $this->validateFieldLength('dni', 9, $this->getDniMaxLengthViolationMessage());
    $this->validateFieldMinimunLength('dni', 9, $this->getDniMaxLengthViolationMessage());
}

Con la primera línea, comprobamos que el campo DNI no tenga una longitud superior a 9 caracteres. Esto ya lo tenemos restringido con un maxlenght en el input, pero nunca está de más volver a realizar las comprobaciones en el lado servidor. $this->validateFieldLength(‘dni’, 9, $this->getDniMaxLengthViolationMessage()); La segunda línea es una función que he creado yo mismo, nada del otro mundo. Comprueba que el campo DNI no tiene una longitud inferior a 9. Esto podía haberse realizado con un único método, pero viendo que prestashop tenía definida la función de máximo de longitud, pues yo he creado también la que controla el mínimo 🙂 y en caso de no llegar al mínimo, lanzaremos un error. $this->validateFieldMinimunLength(‘dni’, 9, $this->getDniMaxLengthViolationMessage()); Paso a continuación las 2 funciones.

protected function validateFieldMinimunLength($fieldName, $minimunLength, $violationMessage)
{
    $field = $this->getField($fieldName);
    if (strlen($field->getValue()) < $minimunLength) {
        $field->addError($violationMessage);
    }
}

protected function getDniMaxLengthViolationMessage()
{
    return $this->translator->trans(
       'El campo %1$s debe ser 8 números y una letra (Ejemplo: 00000000A).',
        array('dni', 9),
        'Shop.Notifications.Error'
    );
}

Desde este instante, si salvamos los cambios realizados y ponemos por ejemplo en el campo DNI el valor 123123A podemos ver que ya nos está mostrando el error el formulario.

Aquí podríamos haber cerrado la entrada, pero estoy seguro de que muchos de los que desarrollamos en Prestashop tenemos la necesidad de añadir el campo DNI en el formulario de registro, y claro… deberíamos realizar una correcta validación para que no inserten nada similar a 2A3b66FEO (¿Tiene 9 caracteres?, sí. ¿Es correcto?, desde luego que no).

Validando el campo DNI en el formulario de registro de Prestashop 1.7.

Dentro de la función validate() vamos a crear una nueva validación de campo.

// dni is from input type text..., so we need to convert to a valid dni type
$dniField = $this->getField('dni');
if (!empty($dniField)) {
    $dniValue = $dniField->getValue();

    if (!empty($dniValue)) {
        $dni = Customer::checkDni($dniValue);

        if($dni === 'error-formato'){
            $dniField->addError(sprintf(
                $this->translator->trans(
                    'El campo dni no tiene un formato correcto (Ejemplo: 00000000A).', array(), 'Shop.Notifications.Error'
                ),
                $dniField->getValue()
            ));
        }
    }
}

Aquí lo que estamos haciendo es recuperar el valor del campo dni del formulario, comprobamos con un método de validación que este campo es correcto. El método lo crearemos a continuación en la clase Customer, no os preocupéis. Y por último, si todo está OK, procesa el alta, si no, lanza un mensaje de error en pantalla.

Creando validación de campos en la clase Customer.

Ahora vamos a copiar otro script de clase para poder crear la función de validación en su sitio correspondiente, por lo tanto, vamos a classes/Customer.php y copiamos este script en override/classes/Customer.php. Paso un pantallazo de los 3 scripts de los cuales hemos hecho override en estos 2 últimos artículos donde estamos trabajando la creación de nuevos campos en el formulario de registro.

Vamos entonces a override/classes/Customer.php y creamos el siguiente método. NOTA: Recordemos ir limpiando caché para poder trabajar correctamente con el override.

// Comprueba si un DNI es correcto.
public static function checkDni($nif)
{
    $letras = explode(',','T,R,W,A,G,M,Y,F,P,D,X,B,N,J,Z,S,Q,V,H,L,C,K,E');

    if (  (strlen($nif)!=9) ||
          (!is_long($entero=intval(substr($nif,0,8)))) ||
          (!in_array($letra=strtoupper(substr($nif,8,1)),$letras))
    ){
       return 'error-formato';
    }else{
       return true;
    }
}

En este método poco tenemos que explicar, si el DNI tiene un formato correcto continua con la ejecución, en caso contrario devuelve un error. Y si hemos realizado todos los pasos correctamente, al poner un dni que no es válido deberíamos ver algo como esto.

Lo mismo ocurrirá en el formulario de información del usuario. Acabamos de añadir el campo nuevo y su validación tanto en un formulario como en el otro.

Y por supuesto que si ponemos un dni correcto, procesará el formulario de alta sin problema. Y esto es todo, recordemos que en una próxima entrada veremos como insertar el valor de este nuevo campo dni en la base de datos. Versiones utilizadas, tiempo y dificultad de desarrollo: Plataforma: Prestashop 1.7.2 Tiempo de desarrollo: 20 minutos Dificultad: Intermedio.