Monthly Archives: July 2009

Introducción.

Después de poblado el modelo con la información proporcionada por el usuario a través del formulario, la validación verifica que la información del modelo sea correcta mediante la aplicación de un conjunto de reglas definidas específicamente para cada modelo.

Especificación de reglas.

• Para especificar las reglas de validación de un modelo es necesario sobreescribir el método rules().

  public function rules()
  {
      return array(
          array('value1, value2, operator', 'required'),
          array('value1, value2', 'numerical')
      );
  }

• El método rules() retorna un arreglo cuyos elementos corresponden con la siguiente especificación.

  array('<lista de atributos>', '<validador>', 'on' => '<lista de escenarios>', ... <opciones adicionales>)

  • El listado de atributos corresponde con los nombres separados por comas de los atributos a los cuales se les aplica la regla de valildación.
  • El nombre del validador determina el tipo de verificación que se debe realizar sobre los atributos.
  • El parámetro on (opcional) permite especificar en cuales escenarios (lista separada por comas) aplica la regla.
  • Las opciones adicionales son parejas nombre/valor que permiten asignar valores iniciales a las propiedades del validador.

Tipos de validadores.

Existen tres tipos de formas como es posible especificar las reglas de validación.

1. Como un método del modelo.

• La firma del método deberá corresponder con la siguiente.

  /**
   * @param string El nombre del atributo que será validado.
   * @param array Opciones adicionales especificadas en la regla de validación.
   */
  public function NombreValidador($atributo, $parametros)

1. Como una clase que hereda de CValidator.
2. Como un alias de un validador predefinido.

Validadores predefinidos.

Corresponden a alias mas cortos y sencillos de los validadores mas utilizados sobre los atributos.

A continuación se muestras algunos ejemplos de estos validadores.

/* Se requiere un valor Username, no puede dejarse vacío */
array('username', 'required'),
/* Username deberá tener entre 3 y 12 carácteres */
array('username', 'length', 'min' => 3, 'max' => 12),
/* En el escenario 'registro', password deberá coincidir con password2 */
array('password', 'compare', 'compareAttribute' => 'password2', 'on' => 'registro'),
/* En el escenario 'login', password deberá ser autenticado (validador de método [1] o de clase [2]) */
array('password', 'authenticate', 'on' => 'login')

Ejecución de la validación.

• Es posible forzar a la validación manualmente mediante el llamado al método CModel::validate().  El llamado a métodos como CActiveRecord::save() lanzan automáticamente la validación.
• El retorno del método CModel::validate() se utiliza para verificar si la validación fue exitosa o si falló alguna de las reglas.
• Es posible (opcional) definir un escenario para la ejecución de la validación.  En caso de especificarse se tomarán en cuenta las reglas que NO tienen definido un escenario (parámetro on) y aquellas cuyo escenario coincida con el definido para la ejecución de la validación.  En caso de no especificarse un escenario, se tomarán en cuenta únicamente las primeras reglas, las que NO tienen definido un escenario.

$modelo -> scenario = 'registro';
if($modelo -> validate())
{
    // Éxito en la validación
}
else
{
    // Fracaso en la validación
}

• Es posible obtener mayor información del validador mediante los siguientes métodos que pueden ser aplicados globalmente para todos los atributos o a uno en específico.
  • CModel::hasErrors().  Verifica si hubo o no errores en la validación.
  • CModel::getErrors().  Obtiene los mensajes de error generados durante la validación.

Enlaces.

• Yii Web Programming Framework.
  http://www.yiiframework.com/
• Yii Documentation.
  http://www.yiiframework.com/doc/

Introducción.

En Yii existen dos tipos de modelos: los basados en información que proviene de un formulario (form model) la cual se va obtener, manipular y desechar, y la proveniente de una base de datos (active record model) la cual provee las operaciones de CRUD sobre los datos.  En este artículo estaré haciendo referencia al primero de los modelos, el relacionado con la manipulación de información proveniente del usuario a través de un formulario.

El procedimiento típico para el desarrollo de las aplicaciones basadas en formularios es el siguiente.

1. Crear un modelo que represente en sus campos a los datos que van a ser manipulados.
2. Crear un controlador con sus respectivas acciones que respondan a los requerimientos del usuario.
3. Crear una vista con el/los formulario/s asociados a las acciones.

Las acciones generales que es posible definir en un modelo basado en formularios son siguientes.

• Definición.
• Asignación de atributos (datos).
• Validación.
• Implementación de la acción.
• Creación del formulario.

Definición.

• Los modelos basados en formularios heredan de CFormModel.
• Sus atributos definen los datos que van a ser almacenados del formulario.
• Si se especifican valores por defecto para los atributos su estado se reflejará en las vistas correspondientes a los formularios.

class CalculatorForm extends CFormModel
{
    public $value1;
    public $value2;
    public $operator = '+';    // Default value.
}

Asignación de datos.

Es posible especificar valores para los atributos del modelo de dos maneras.

1. Asignación individual.
2. Asignación general.

Asignación individual.

• Hace referencia al acceso directo de los atributos.
• Se debe utilizar cuando es necesario realizar algún tipo de verificación o cálculo de la información proveniente del formulario.

$model = new CalculatorForm();
$model -> operator = '*';

Asignación general.

• Asigna todos los atributos del modelo cuyos nombres coincidan con la información proporcionada, habitualmente en $_POST.
• Se incluye un escenario que permite diferenciar cuales atributos si se deberán modificar durante la asignación general.

$model = new CalculatorForm();
$model -> scenario = 'calculate';
if(isset($_POST['CalcForm']))
    $model -> attributes = $_POST['CalcForm'];

• Es posible filtrar/asegurar cuales son los valores seguros para asignar masivamente por cada uno de los escenarios posibles.
• Para hacer esto es necesario sobreescribir el método safeAttributes() del modelo.

public function safeAttributes()
{
    return array(
        parent::safeAttributes(),
        /* Atributos que pueden ser asignados en todos los scenarios */
        'atrib1, atrib2, ...',
        /* Atributos que sólo pueden ser asignados en el escenario X */
        'escenarioX' => 'atribA, atribB, ...'
    );
}

• Si ninguno de los atributos del modelo será dependiente de un escenario es posible simplificar el retorno de safeAttributes() en una cadena conteniendo el listado de los nombres de los atributos seguros para asignación general.

public function safeAttributes()
{
    /* Asignación general sin dependencia de escenarios */
    return 'atrib1, atrib2, ...';
}

Enlaces.

• Yii Web Programming Framework.
  http://www.yiiframework.com/
• Yii Documentation.
  http://www.yiiframework.com/doc/