Monthly Archives: June 2009

Introducción.

• Son objetos escritos basados en una especificación.
• Heredan de la clase CComponent.
• Es posible acceder y modificar sus propiedades así como lanzar y manejar sus eventos.

Propiedades.

• Son atributos públicos de lectura y escritura.
• Pueden definirse de dos maneras.
  • Declarando un atributo público en el componente.
    • En este caso el nombre de la propiedad es sensible a mayúsculas.
  • Definiendo los métodos setter y getter correspondientes.
    • En este caso el nombre de la propiedad no es sensible a mayúsculas.
    • Para implementar la propiedad imageType es necesario implementar los siguientes métodos.

      public function getImageType()
      {
          return $this -> _imageType;
      }
      public function setImageType($value)
      {
          $this -> _imageType = $value;
      }

    • Este método es mas flexible ya que permite definir una lógica del negocio que condicione el acceso a las propiedades.
    • De igual manera es posible implementar propiedades de sólo lectura (sin setter) o de sólo escritura (sin getter).

Eventos.

• Los eventos del componente son propiedades que toman referencias a métodos (event handlers) como valores.
• Estos métodos son invocados automáticamente cuando sucede el evento asociado.
• Un evento del componente es definido por la implementación de un método cuyo nombre empieza por on y termina con el nombre del evento asociado (no es sensible a mayúsculas).
  • Para el evento click -> el método deberá ser entonces: onClicked.

    public function onClicked($event)
    {
        // ...
    }

• Los eventos ($event) son instancias de la clase CEvent.
• Los manejadores de evento se asginan de la siguiente manera.

  $component -> onClicked = $callback;

  • $callback deberá ser una referencia válida en PHP según las siguientes opciones.
    • El nombre de una función global.
    • Un método de una clase, para este caso deberá ser de la forma array($objeto, 'nombreMétodo').
• Varios manejadores de evento pueden asociarse a un mismo evento, estos se ejecutarán en el orden en que fueron creados.
• Un manejador de eventos puede evitar que se invoquen los demás manejadores de eventos al realizar la siguiente modificación.

  $event -> handled = true;

Comportamientos.

• Un comportamiento es un objeto cuyos métodos pueden ser transferidos a los componentes que se le agreguen.
• Es decir, reune funcionalidades en lugar de realizar una especialización como lo hace la herencia convencional.
• Es posible agregar múltiples comportamientos lo que se asemeja a la herencia múltiple.
• Son análogos a los mixins que incluyen otros lenguajes orientados a objetos (como Ruby) o que implementan otros frameworks (como Symfony).
• Existen varias maneras de implementar un comportamiento.
  • Como una clase que implementa a la interfaz IBehavior.
  • Como una clase que hereda de CBehavior.
  • Si va a ser agregado a un modelo puede ser una clase que herede de CModelBehavior o CActiveRecordBehavior según corresponda.
• Para utilizar un comportamiento primero debe ser agregado a un componente.

  $comportamiento -> attach($nombre, $componente);
  $componente -> métodoDelComportamiento();

• Los comportamientos pueden ser activados y desactivados según se desee en cada componente.

  $componente -> enableBehavior($nombre);
  $componente -> disableBehavior($nombre);

• Si dos o mas comportamientos agregados a un componente entran en conflicto porque tienen métodos con igual nombre, la precedencia la tendrá el comportamiento que haya sido agregado primero.

Enlaces.

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

Introducción.

• Son unidades autocontenidas de software.
• Tienen sus propios modelos, vistas, controladores y demás componentes de soporte.
• Se asemejan a una aplicación pero no pueden ser desplegados individualmente, deben residir como parte de  una aplicación.
• Los usuarios acceeden a los controladores de los módulos de la misma forma como se acceden los controladores convencionales.
• Son útiles para dividir el desarrollo y mantenimiento de aplicaciones muy grandes en módulos independientes.
• Facilitan la reutilización de código a alto nivel.
• Se utilizan para implementar funcionalidades como autenticación, manejo de usuarios, manejo de comentarios, etc.

Estructura.

• Cada módulo tiene una clase principal que hereda de CWebModule.
• El nombre de la clase se determina de la siguiente manera: ucfirst(IdentificadorMódulo) . 'Module'.
  • Ejemplo, la clase del módulo gallery debe llamarse GalleryModule.
• Esta clase se utiliza para almacenar información y características que son comúnes a todo el módulo.
  • CWebModule::params almacena los parámetros del módulo.
  • CWebModule:: components comparte componentes de aplicación a nivel del módulo.

Creación.

Utilizando yiic.

yiic permite crear fácilmente un esqueleto básico del módulo para empezar a trabajar sobre él.

$ cd WebRoot/MiAplicacion
$ protected/yiic shell

Yii Interactive Tool v1.0
Please type 'help' for help.  Type 'exito' to quit.

>> module gallery

Uso.

• Copie el directorio del módulo en el directorio modules de la aplicación.
• Declare el módulo (con su identificador) en la propiedad modules de la configuración de la aplicación de la siguiente manera.

  return array (
      // ...
      'modules' => array('gallery', /* ... */),
      // ...
  );

• Es posible especificar valores iniciales para las propiedades del módulo de la siguiente manera.

  return array (
      // ...
      'modules' => array(
          'gallery' => array(
              'fileType' => 'png',
              'rows' => 10,
              'cols' => 3
          ),
          /* ... */
       ),
      // ...
  );

• La instancia del módulo puede ser accedida a través de la propiedad module del controlador acrivo.

  $rows = Yii::app() -> controller -> module -> rows;

• Los módulos se acceden con la ruta módulo/controlador/acción.
  • Para el ejemplo, gallery/image/add corresponderá entonces con el URL http://www.servidor.com/index.php?r=gallery/image/add.
• Un módulo puede contener a su vez a otros módulos los cuales pueden ser accedidos de manera similar: móduloPadre/móduloHijo/controlador/acción.

Enlaces.

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

Introducción.

• Son archivos PHP convencionales.
• Pueden incluír elementos de interfaz de usuario basados en Yii.
• Se recomienda que las vistas accedan a la información de los modelos pero que no los modifiquen.
• Deben permanecer lo mas simples posibles, lógicas complejas deberían llevarse hasta el controlador.
• El nombre del archivo donde se almacena la vista corresponde con el identificador junto con la extensión .php.
  • La vista edit se almacenará en el archivo edit.php.
• Los archivos de las vistas se almacenan bajo la ruta protected/views/<Identificador del controlador>.
• Desde la vista es posible acceder a los atributos del controlador a través del objeto $this.
• Para procesar una vista se debe invocar el método CController::render(<Identificador de vista>).
• Es posible pasar explícitamente información desde el controlador a la vista en el momento de su generación.

  $this -> render('edit', array (
      'variable1' => $valor1,
      'variable2' => $valor2
  ));

  • En la vista edit se podrá acceder a $variable1 y $variable2 como variables convencionales.

Layouts (diseños).

• El layout permite especificar el diseño común y constante de la interfaz de usuario.
• Evita la necesidad de agregar elementos comúnes (archivos javascript y css, título, subtítulo, menú izquierdo, pies, etc) a todas las páginas en cada una de ellas.
• El layout aplica a todo el sitio web y se aplica automáticamente al invocar el método render.
• Para generar una vista sin el layout es necesario utilizar el método renderPartial.
• El layout utilizado por defecto se encuentra en views/layouts/main.php.
  • Es posible modificar esto alterando CWebApplication::layout para toda la aplicación o CController::layout para todas las acciones del controlador.
• En el layout se debe incluír la variable $content para especificar la ubicación en la que se agregará el contenido de la vista específica al controlador/acción ejecutado (parte no constante de la interfaz de usuario).

Widgets.

• Los widgets son componentes predefinidos para la presentación de la interfaz de usuario.
• Generalmente agregan una funcionalidad gráfica compleja, específica y autocontenida.
• Heredan de CWidget.
• Su forma de invocarlos depende de si tienen o no contenido en su cuerpo.
  • Sin contenido en su cuerpo.

    <? php $this -> widget('ruta.a.la.ClaseWidget'); ?>

  • Con contenido en su cuerpo.

    <? php $this -> beginWidget('ruta.a.la.ClaseWidget'); ?>
    ... contenido del cuerpo del Widget ...
    <? php $this -> endWidget(); ?>

• Es posible definir valores iniciales para los atributos del Widget durante su invocación con widget o beginWidget.

  $this -> widget('CMaskedTextField', array (
      'mask' => '99/99/9999'
  ));

Creación de nuevos Widgets.

• El nuevo widget debe heredar de CWidget e implementar los métodos init y run.

  class NuevoWidget extends CWidget
  {
      public function init()
      {
          // Invocado por CController::beginWidget().
      }
      public function run()
      {
          // Invocado por CController::endWidget().
      }
  }

• Tienen sus propias vistas y se ubican por defecto en el directorio views bajo el directorio que contiene la clase del widget.
• Estas vistas se generan invocando CWidget::render().

Vistas del sistema.

• Estas vistas se utilizan para mostrar errores del sistema o información de registro.
• Las excepciones de HTTP (CHTTPException) se despliegan con las vistas errorXXX donde XXX es el código del error HTTP generado.
• Las vistas por defecto provistas por Yii se ubican en framework/views y pueden personalizarse definiéndolas en protected/views/system.

Enlaces.

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

Introducción.

Estructura de una aplicación Yii.

• El Modelo/Vista/Controlador es un patrón de diseño.
• Su utilidad radica en separar la lógica del negocio de la interfaz de usuario.
• El modelo representa la información y las reglas del negocio asociadas a ella.
• La vista representa a los componentes de la interfaz de usuario y todo lo relacionado con su presentación.
• El controlador recibe la solicitud del usuario (controlador, acción e información) e intermedia entre la vista y los modelos para elaborar la respuesta.
• El controlador frontal (index.php) recibe directamente la solicitud del usuario, es el único que interactúa directamente con él, y se encarga de enrrutar la solicitud al controlador y acción apropiados.
• Consultar secuencia de procesamiento de un requerimiento.

El controlador.

• Hereda de CController.
• Su identificador es de la forma ruta/a/xyz (ejemplo: user).
• Corresponde con el archivo protected/controllers/ruta/a/XyzController.php (ejemplo: protected/controllers/UserController.php).
• Si la aplicación utiliza módulos, su identificador se incluye en la ruta del identificador del controlador.
• Incluye una o mas acciones.
• Incluye cero o mas filtros para sus acciones.
• La instanciación de un controlador puede realizarse de la siguientes maneras según el contexto.
  • Si se define CWebApplication::catchAllRequest, todas las solicitudes serán redireccionadas al controlador indicado ignorándose el solicitado.  Es útil para poner el sitio fuera de línea.
  • Si el identificador del controlador solicitado se encuentra en CWebApplication::controllerMap se utilizará el controlador asociado en la conversión.
  • Se busca el controlador en la ubicación específica según su ruta.
  • Si el controlador no existe se lanza una CHttpException 404.

Las acciones.

• Definen (implementan) que hacer ante el requerimiento específico de un usuario.
• Si no se especifica una acción se utiliza la acción por defecto (index) que puede configurarse con CController::defaultAction.
• Pueden implementarse de dos maneras.
  • Como un método del controlador cuyo nombre deberá ser actionIdentificador.
    • La acción add corresponderá con el método actionAdd.
  • Como una nueva clase que hereda de CAction cuyo nombre deberá ser IdentificadorAction e implementa el método run.
    • La acción add en este caso corresponderá con una instancia de la clase AddAction.
    • Para que este caso funcione se debe sobreescribir el método actions del controlador estableciendo la relación entre identificador de la acción y clase que la implementa.

      ...
      public function actions()
      {
          return array(
              'add' => 'application.controllers.post.AddAction'
          );
      }
      ...

    • Se recomienda almacenar las acciones bajo el alias de application.controllers.<identificador del controlador> que hace referencia a la ruta física protected/controllers/<identificador del controlador>.

Los filtros.

• Permiten manipular el flujo de ejecución de la acción solicitada.
• Se ejecutan antes y después de la acción solicitada permitiendo filtrar si esta es efectivamente invocada o no.
• Útiles para realizar procesos previos de preparación (estadísticas, verificación de autenticación/autorización, etc.) y de limpieza (liberación de recursos, verificaciones finales, etc.).
• Una acción puede tener cero o mas filtros.
• Los filtros se ejecutan en el mismo orden en que fueron definidos.
• Un filtro puede decidir si los demás filtros o la acción no deben ser ejecutados.
• Al igual que las acciones, los filtros pueden implementarse de dos maneras.
  • Como un método del controlador cuyo nombre deberá ser filterIdentificador.
    • El filtro editPassword corresponderá con el método filterEditPassword.

      public function filterEditPassword($filterChain)
      {
          // $filterChain -> run() continúa la ejecución de los filtros.
      }

  • Como una nueva clase que hereda de CFilter cuyo nombre deberá ser IdentificadorFilter.
    • Se deben implementar los métodos preFilter y postFilter que se ejecutarán antes y después de invocarse la acción.

      class CheckAuthFilter extends CFilter
      {
          protected function preFilter($filterChain)
          {
              // Ejecutado antes de invocar la acción.
              return true;   // false si se debe abortar la ejecución de la acción.
          }
          protected function postFilter($filterChain)
          {
              // Ejecutado después de terminar la invocación de la acción.
          }
      }

• Es necesario sobreescribir el método CController::filters() para asociar los filtros a las acciones.

  ...
  public function filters()
  {
      return array(
          'editPassword + edit, create',                               // filtro basado en un método
          array (
               'application.filters.CheckAuthFilter - logout, index',  // filtro basado en una clase
               'tipo' => 'usuario'
          )
      );
  }
  ...

  • El filtro editPassword está implementado por un método del controlador mientras que el filtro checkAuth está basado en una clase que hereda de CFilter.
  • El alias application.filters hace referencia a la ruta física protected/filters.
  • Es posible especificar valores para los atributos del filtro utilizando un arreglo en la definición de los filters tal y como se le asigna un valor al atributo tipo del filtro checkAuth.
  • Los operadores + y – modifican el alcance de la relación entre filtros y acciones.
    • +: el filtro se aplica a las acciones especificadas.  (incluye).
      • El filtro editPassword se aplica a las acciones edit y create únicamente.
    • -: el filtro se aplica a todas las acciones exceptuando las especificadas.  (excluye).
      • El filtro checkAuth se aplica a todas las acciones menos a logout e index.

Enlaces.

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

    protected function preFilter($filterChain)
    {
        // Ejecutado antes de invocar la acción.
        return true;   // false si se debe abortar la ejecución de la acción.
    }