Introducción a Zend Framework

 Aprendiendo Zend Framework

Apéndice

 Referencia de Zend Framework


  • Zend_Gdata
  • Zend_Http
  • Zend_InfoCard
  • Zend_Json
  • Zend_Layout
  • Zend_Ldap
  • Zend_Loader
  • Zend_Locale
  • Zend_Log
  • Zend_Mail
  • Zend_Markup
  • Zend_Measure
  • Zend_Memory
  • Zend_Mime
  • Zend_Navigation
  • Zend_Oauth
  • Zend_OpenId
  • Zend_Paginator
  • Zend_Pdf
  • Zend_ProgressBar
  • Zend_Queue
  • Zend_Reflection
  • Zend_Registry
  • Zend_Rest

  • Zend_Search_Lucene
  • Zend_Serializer
  • Zend_Server
  • Zend_Service
  • Zend_Session
  • Zend_Soap
  • Zend_Tag
  • Zend_Test
  • Zend_Text
  • Zend_TimeSync
  • Zend_Tool
  • Zend_Tool_Framework
  • Zend_Tool_Project
  • Zend_Translate
  • Zend_Uri
  • Zend_Validate
  • Zend_Version
  • Zend_View
  • Zend_Wildfire
  • Zend_XmlRpc
  • ZendX_Console_Process_Unix
  • ZendX_JQuery
  • Traducción al 26.9% - Actualizado el 2011-11-16 - Revisión 24249 - Versión ZF 1.11.x

    24.5. El Router Standard

    24.5.1. Introducción

    Zend_Controller_Router_Rewrite Es el router standard del Framework. Routing es el proceso de tomar la parte final de una URI (la parte de la URI que viene después de la URL base) y la descomposición en parámetros para determinar qué módulo, qué controlador y acción de ese controlador debe recibir la solicitud. Estos valores del módulo, controlador, acción y otros parámetros están enpaquetados en un objeto Zend_Controller_Request_Http el cual es procesado luego por Zend_Controller_Dispatcher_Standard . El routing ocurre sólo una vez: cuando se recibió inicialmente la solicitud y antes del dispatch del primer controlador.

    Zend_Controller_Router_Rewrite está diseñado para permitir que una funcionalidad tipo mod_rewrite se pueda usar en estructuras PHP puras. Se basa muy vagamente en el routing de Ruby on Rails (RoR) y no requiere ningún conocimiento previo de reescritura de la URL del webserver. Está diseñado para trabajar con solo una regla mod_rewrite de Apache (one of):

    RewriteEngine on
    RewriteRule 
    !\.(js|ico|gif|jpg|png|css|html)$ index.php

    o (preferido):

    RewriteEngine On
    RewriteCond 
    %{REQUEST_FILENAME} -[OR]
    RewriteCond %{REQUEST_FILENAME} -[OR]
    RewriteCond %{REQUEST_FILENAME} -d
    RewriteRule 
    ^.*$ - [NC,L]
    RewriteRule ^.*$ index.php [NC,L]

    El router rewrite también puede utilizarse con el IIS webserver (versions <= 7.0) si Isapi_Rewrite se ha instalado como una extensión Isapi con la siguiente regla de reescribir:

    RewriteRule ^[\w/\%]*(?:\.(?!(?:js|ico|gif|jpg|png|css|html)$)[\w\%]*$)? /index.php [I]
    [Nota] IIS Isapi_Rewrite

    Cuando se usa IIS , $_SERVER['REQUEST_URI'] puede no existir, o establecerlo como un string vacío. En este caso, Zend_Controller_Request_Http intentará usar el valor de $_SERVER['HTTP_X_REWRITE_URL'] establecido por la extensión Isapi_Rewrite.

    IIS 7.0 introduce un módulo nativo de reescribir la URL, y puede ser configurado como sigue:

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
         <system.webServer>
             <rewrite>
                 <rules>
                     <rule name="Imported Rule 1" stopProcessing="true">
                         <match url="^.*$" />
                         <conditions logicalGrouping="MatchAny">
                             <add input="{REQUEST_FILENAME}"
                                 matchType="IsFile" pattern=""
                                 ignoreCase="false" />
                             <add input="{REQUEST_FILENAME}"
                                 matchType="IsDirectory"
                                 pattern="" ignoreCase="false" />
                         </conditions>
                         <action type="None" />
                     </rule>
                     <rule name="Imported Rule 2" stopProcessing="true">
                         <match url="^.*$" />
                         <action type="Rewrite" url="index.php" />
                     </rule>
                 </rules>
             </rewrite>
         </system.webServer>
    </configuration>]></programlisting>

           <para>
                Si está usando Lighttpd, la siguiente regla de reescritura es válida:
           </para>

            <programlisting language="lighttpd"><![CDATA[
    url.rewrite-once = (
        ".*\?(.*)$" => "/index.php?$1",
        ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0",
        "" => "/index.php"
    )

    24.5.2. Usando un Router

    Para utilizar adecuadamente el router de reescritura debe instanciarlo, agregar algunas rutas definidas por el usuario y luego inyectarlo en el controlador. El siguiente código ilustra el procedimiento:

    // Crear un router

    $router $ctrl->getRouter(); // returns a rewrite router by default
    $router->addRoute(
        
    'user',
        new 
    Zend_Controller_Router_Route('user/:username',
                                         array(
    'controller' => 'user',
                                               
    'action' => 'info'))
    );

    24.5.3. Operación Básica del Rewrite Router

    El corazón del RewriteRouter es la definición de la rutas definidas por el usuario. Las rutas se agregan llamando al método addRoute de RewriteRouter y pasándole una nueva instancia de una clase que implementó a Zend_Controller_Router_Route_Interface . Eg.:

    $router->addRoute('user',
                      new 
    Zend_Controller_Router_Route('user/:username'));

    El Rewrite Router viene con seis tipos básicos de rutas (uno de los cuales es especial):

    Las rutas pueden ser utilizadas numerosas veces para crear una cadena o un esquema de aplicación de ruteo definido por el usuario. Puede usar cualquier número de rutas en cualquier configuración, con la excepción de la ruta del Módulo, la cual debe ser utilizada una vez y probablemente como la ruta más genérica (es decir, por defecto). Cada ruta se describe en mayor detalle más adelante.

    El primer parámetro a addRoute es el nombre de la ruta. Se utiliza como un manejador para sacar las rutas del router (por ejemplo, con fines de generación de URL ). El segundo parámetro es la ruta misma.

    [Nota] Nota

    El uso más común del nombre de ruta es por medio del ayudante de URL Zend_View :

    <a href=
    "<?php echo $this->url(array('username' => 'martel'), 'user') ?>">Martel</a>

    Que resultaría en la href: user/martel .

    El routing es un simple proceso de iteración a través de todas las rutas provistas y la equiparación de sus definiciones con la petición actual de URI . Cuando se encuentra una concordancia, se devuelven valores de variables desde la instancia Route y se inyecta en el objeto Zend_Controller_Request para su posterior utilización en el dispatcher así también como en los controladores creados por el usuario. En caso de no encontrar ninguna concordancia, se comprobará la siguiente ruta en la cadena.

    Si necesita determinar en qué ruta se encontró una concordancia, puede usar el método getCurrentRouteName() , que devolverá el identificador usado cuando registró la ruta con el router. Si quiere el objeto de la ruta actual, puede usar getCurrentRoute() .

    [Nota] Matching Inverso

    Las rutas están equiparadas en orden inverso para asegurarse que las rutas más genéricas se definan primero.

    [Nota] Valores Retornados

    Los valores retornados del routing provienen de parámetros URL o de rutas definidas por defecto por el usuario. Estas variables son accesibles posteriormente a través de los métodos Zend_Controller_Request::getParam() o Zend_Controller_Action::_getParam() .

    Hay tres variables que pueden utilizarse en las rutas - 'module', 'controller' y 'action'. Estas variables especiales son utilizados por Zend_Controller_Dispatcher para encontrar un controlador y una acción para hacer el dispatch.

    [Nota] Variables Especiales

    Los nombres de estas variables especiales pueden ser diferentes si elige alterar los valores por defecto en Zend_Controller_Request_Http mediante los métodos setControllerKey() y setActionKey() .

    24.5.4. Routes por Defecto

    Zend_Controller_Router_Rewrite viene preconfigurado con una ruta por defecto, que se comparará con URI s en la forma de controller/action . Además, se puede especificar un nombre de módulo como primer elemento del path, permitiendo URI s de la forma module/controller/action . Por último, también coincidrá con cualquier parámetro adicional agregado a la URI por defecto - controller/action/var1/value1/var2/value2 .

    Algunos ejemplos de cómo están equiparadas las rutas:

    // Asumiendo lo siguiente:
    $ctrl->setControllerDirectory(
        array(
            
    'default' => '/path/to/default/controllers',
            
    'news'    => '/path/to/news/controllers',
            
    'blog'    => '/path/to/blog/controllers'
        
    )
    );

    Módulo únicamente:
    http://example/news
        
    module == news

    Modulo inválido mapea al nombre del controlador
    :
    http://example/foo
        
    controller == foo

    Módulo 
    controlador:
    http://example/blog/archive
        
    module     == blog
        controller 
    == archive

    Módulo 
    controlador accción:
    http://example/blog/archive/list
        
    module     == blog
        controller 
    == archive
        action     
    == list

    Módulo controlador accción parámetros:
    http://example/blog/archive/list/sort/alpha/date/desc
        
    module     == blog
        controller 
    == archive
        action     
    == list
        
    sort       == alpha
        date       
    == desc

    La ruta por defecto es simplemente un objeto Zend_Controller_Router_Route_Module almacenado bajo el nombre de (index) por 'default' en RewriteRouter. Está generado más o menos así:

    $compat = new Zend_Controller_Router_Route_Module(array(),
                                                      
    $dispatcher,
                                                      
    $request);
    $this->addRoute('default'$compat);

    Si no quiere esta ruta en particular en su esquema por defecto de routing, podrá anularla creando su propia ruta por 'defecto' (es decir, almacenar bajo el nombre de 'default') o eliminarla por completo usando removeDefaultRoutes() :

    // Eliminar cualquier ruta por defecto
    $router->removeDefaultRoutes();

    24.5.5. URL Base y Subdirectorios

    El router rewrite puede ser utilizado en subdirectorios (por ejemplo http://domain.com/~user/application-root/ ) en cuyo caso la URL base de la aplicación ( /user/application-root ) debe ser detectada automáticamente por Zend_Controller_Request_Http y usada en consecuencia.

    Si la URL base se detecta incorrectamente se la puede anular con su propio path de base usando Zend_Controller_Request_Http y llamando al método setBaseUrl() (ver Sección 24.4.2.2, “Base Url and Subdirectories” ):

    $request->setBaseUrl('/~user/application-root/');

    24.5.6. Parámetros Globales

    Puede establecer los parámetros globales en un router que se proporcionan automáticamente a una ruta cuando se ensamblasn mediante setGlobalParam() . Si se establece un parámetro global pero también se lo entrega directamente al método de ensamblaje, el parámetro del usuario sobreescribe al parámetro global. Puede establecer un parámetro global esta forma:

    $router->setGlobalParam('lang''en');

    24.5.7. Tipos de Route

    24.5.7.1. Zend_Controller_Router_Route

    Zend_Controller_Router_Route es la ruta standard del framework. Combina la facilidad de uso con la flexibilidad para la definición de rutas. Cada ruta consiste fundamentalmente en el mapeo de la URL (de partes estáticas y dinámicas (variables)) y puede ser iniciada con valores predeterminados así como con requisitos variables.

    Imaginemos que nuestra aplicación ficticia necesitará algunas páginas informativas sobre los autores del contenido. Queremos ser capaces de apuntar nuestro navegador web a http://domain.com/author/martel para ver la información sobre este muchacho "martel". La ruta para esa funcionalidad podría parecerse a:

    $route = new Zend_Controller_Router_Route(
        
    'author/:username',
        array(
            
    'controller' => 'profile',
            
    'action'     => 'userinfo'
        
    )
    );

    $router->addRoute('user'$route);

    El primer parámetro en el constructor Zend_Controller_Router_Route es una definición de ruta que será acompañada de una URL . Las definiciones de ruta consisten en partes estáticas y dinámicas separadas por el caracter barra ('/'). Las partes estáticas son simples textos: author . Las partes dinámicas, llamadas variables, se marcan anteponiendo dos puntos (:) al nombre de la variable :username .

    [Nota] Uso de Caracteres

    La implementación actual le permite utilizar cualquier carácter (salvo una barra) como un identificador de variable, pero se recomienda encarecidamente que se utilicen sólo caracteres que sean válidos para identificadores de variables PHP . En implementaciones futuras se podría alterar este comportamiento, resultando en probables fallos escondidos en su código.

    Este ejemplo de ruta debería ser coincidente cuando apunta su navegador a http://domain.com/author/martel , en cuyo caso todas sus variables se inyectan al objeto Zend_Controller_Request y quedando accesibles en ProfileController . Las variables devueltas por este ejemplo pueden ser representadas como el siguiente array de pares clave/valor:

    $values = array(
        
    'username'   => 'martel',
        
    'controller' => 'profile',
        
    'action'     => 'userinfo'
    );

    Después, Zend_Controller_Dispatcher_Standard debe invocar al método userinfoAction() de su clase ProfileController (en el módulo por defecto) basado en estos valores. Allí se podrán acceder a todas las variables mediante los métodos Zend_Controller_Action::_getParam() o Zend_Controller_Request::getParam() :

    public function userinfoAction()
    {
        
    $request $this->getRequest();
        
    $username $request->getParam('username');

        
    $username $this->_getParam('username');
    }

    La definición de ruta puede contener uno o más caracteres especiales - un comodín - representado por el símbolo '*'. Se utiliza para reunir parámetros al igual que el valor de ruta por defecto del Módulo (var => pares de valores definidos en la URI ). La siguiente ruta imita más o menos el comportamiento de la ruta del Módulo:

    $route = new Zend_Controller_Router_Route(
        
    ':module/:controller/:action/*',
        array(
    'module' => 'default')
    );
    $router->addRoute('default'$route);
    24.5.7.1.1. Variables por Defecto

    Cada variable en la ruta puede tener una valor por defecto y para esto es que se usa el segundo parámetro del constructor Zend_Controller_Router_Route . Este parámetro es un array con claves representando los nombres de variables y con valores como los deseados por defecto:

    $route = new Zend_Controller_Router_Route(
        
    'archive/:year',
        array(
    'year' => 2006)
    );
    $router->addRoute('archive'$route);

    La ruta de arriba comparará URL s como http://domain.com/archive/2005 y http://example.com/archive . En este último caso la variable year(año) tendrá un valor inicial predeterminado de 2006.

    Este ejemplo resultará en inyectar una variable año al objeto solicitud. Ya que no hay información de enrutamiento presente (no se define ningún controlador ni parámetros de acción), la solicitud será enviada al controlador y al método de acción por defecto (que a la vez ambos están definidos en Zend_Controller_Dispatcher_Abstract ). Para hacerlos más utilizables, tiene que proporcionar un controlador válido y una acción válida como la ruta por defecto:

    $route = new Zend_Controller_Router_Route(
        
    'archive/:year',
        array(
            
    'year'       => 2006,
            
    'controller' => 'archive',
            
    'action'     => 'show'
        
    )
    );
    $router->addRoute('archive'$route);

    Entonces, esta ruta resultará en el dispatch al método showAction() de la clase ArchiveController .

    24.5.7.1.2. Requerimientos para Variables

    Podemos agregar un tercer parámetro al constructor Zend_Controller_Router_Route donde podemos establecer los requisitos para las variables. Estas son definidas como partes de una expresión regular:

    $route = new Zend_Controller_Router_Route(
        
    'archive/:year',
        array(
            
    'year'       => 2006,
            
    'controller' => 'archive',
            
    'action'     => 'show'
        
    ),
        array(
    'year' => '\d+')
    );
    $router->addRoute('archive'$route);

    Con una ruta definida como la de arriba, el router comparará solo cuando la variable año contenga datos numéricos, eg. http://domain.com/archive/2345 . Una URL como http://example.com/archive/test no se comparará y en su lugar el control se pasará a la próxima ruta en la cadena.

    24.5.7.1.3. Segmentos Traducidos

    El standard de ruta brinda apoyo a la traducción de segmentos. Para utilizar esta característica, tiene que definir por lo menos un traductor (una instancia de Zend_Translate ) mediante una de las siguientes formas:

    • Ponerlo en el registro con la clave Zend_Translate .

    • Setearlo mediante el método estático Zend_Controller_Router_Route::setDefaultTranslator() .

    • Pasarlo como cuarto parámetro al constructor.

    Por defecto, se utilizará el "locale" especificado en la instancia Zend_Translate . Para anularlo, debe setearlo (como una instancia de Zend_Locale o un string local) de una de las siguientes maneras:

    • Ponerlo en el registro con la clave Zend_Locale .

    • Setearlo mediante el método estático Zend_Controller_Router_Route::setDefaultLocale() .

    • Pasarlo como cuarto parámetro al constructor.

    • Pasarlo como parámetro @locale al método de ensamblaje.

    Los segmentos traducidos se dividen en dos partes. Los segmentos fijos están precedidos por un único signo @ , y serán traducidos al "locale" actual para el ensamblaje y se revierten al ID del mensaje cuando se acepte nuevamente. Los segmentos dinámicos tienen el prefijo :@ . Para el ensamblaje, el parámetro dado será traducido y se insertará en la posición del parámetro. Cuando se acepte, el parámetro traducido de la URL volverá al ID del mensaje nuevamente.

    [Nota] IDs de Mensajes y Archivos de Lenguajes Separados

    Ocasionalmente un ID de mensaje que quiere usar en una de sus rutas ya se utiliza en un view script o en otro lugar. Para tener pleno control sobre URL s seguras, debe usar un archivo de idioma separado para los mensajes utilizados en la ruta.

    La siguiente es la forma más sencilla para preparar el itinerario normal para el uso de la traducción del segmento:

    // Prepare el traductor
    $translator = new Zend_Translate('array', array(), 'en');
    $translator->addTranslation(array('archive' => 'archiv',
                                      
    'year'    => 'jahr',
                                      
    'month'   => 'monat',
                                      
    'index'   => 'uebersicht'),
                                
    'de');

    // Establecer el "locale" actual para el traductor
    $translator->setLocale('en');

    // Establecerlo como traductor por defecto para las rutas
    Zend_Controller_Router_Route::setDefaultTranslator($translator);

    Este ejemplo demuestra el uso de segmentos estáticos:

    // Crear la ruta
    $route = new Zend_Controller_Router_Route(
        
    '@archive',
        array(
            
    'controller' => 'archive',
            
    'action'     => 'index'
        
    )
    );
    $router->addRoute('archive'$route);

    // Ensamblar la URL en el locale actual por defecto: archive
    $route->assemble(array());

    // Ensamblar la URL en alemán: archiv
    $route->assemble(array());

    Puede usar segmentos dinámicos para crear veriones traducidas como del tipo módulo-ruta:

    // Crear la ruta
    $route = new Zend_Controller_Router_Route(
        
    ':@controller/:@action/*',
        array(
            
    'controller' => 'index',
            
    'action'     => 'index'
        
    )
    );
    $router->addRoute('archive'$route);

    // Ensamblar la URL en el "locale" por defecto: archive/index/foo/bar
    $route->assemble(array('controller' => 'archive''foo' => 'bar'));

    // Ensamblar la URL en alemán: archiv/uebersicht/foo/bar
    $route->assemble(array('controller' => 'archive''foo' => 'bar'));

    También puede mezclar segmentos estáticos y dinámicos:

    // Crear la ruta
    $route = new Zend_Controller_Router_Route(
        
    '@archive/:@mode/:value',
        array(
            
    'mode'       => 'year'
            'value'      
    => 2005,
            
    'controller' => 'archive',
            
    'action'     => 'show'
        
    ),
        array(
    'mode'  => '(month|year)'
              'value' 
    => '\d+')
    );
    $router->addRoute('archive'$route);

    // Ensamblar la URL en el "locale" por defecto: archive/month/5
    $route->assemble(array('mode' => 'month''value' => '5'));

    // Ensamblar la URL en alemán: archiv/monat/5
    $route->assemble(array('mode' => 'month''value' => '5''@locale' => 'de'));

    24.5.7.2. Zend_Controller_Router_Route_Static

    Los ejemplos sobre todo usan rutas dinámicas -- rutas que contienen patrones contra los cuales comparar. A veces, sin embargo, una ruta en particular pareciera estar seteada en piedra, y ejecutar el motor de expresiones regulares sería excesivo. La respuesta a esta situación es utilizar rutas estáticas:

    $route = new Zend_Controller_Router_Route_Static(
        
    'login',
        array(
    'controller' => 'auth''action' => 'login')
    );
    $router->addRoute('login'$route);

    La ruta anterior se comparará con una URL de http://domain.com/login , y hará un dispatch a AuthController::loginAction() .

    [Nota] Advertencia: Las Rutas Estáticas Deben Contener Defaults Sanos

    Dado que una ruta estática no pasa ninguna parte de la URL del objeto solicitud, como ser los parámetros, usted debe pasar todos los parámetros necesarios para enviar una solicitud a la ruta como si fuera por defecto. Omitiendo los valores por defecto de "controller" o "action" tendrá resultados inesperados, y probablemente el resultado de la solicitud no sea ejecutable.

    Como regla general, siempre proporcione cada uno de los siguientes valores por defecto:

    • controller

    • action

    • module (si ya no está por defecto)

    Opcionalmente, también puede pasar el parámetro "useDefaultControllerAlways" al front controller durante el bootstrapping:

    $front->setParam('useDefaultControllerAlways'true);

    Sin embargo, esto es considerado un rodeo; siempre es mejor definir explícitamente valores correctos o sanos por defecto.

    24.5.7.3. Zend_Controller_Router_Route_Regex

    Además de los tipos de ruta estáticos y por defecto, también está disponible el tipo de ruta Expresión Regular. Esta ruta ofrece más potencia y flexibilidad que los otros, pero a costa de un ligero aumento en la complejidad. Al mismo tiempo, debería ser más rápido que la standard Route.

    Al igual que la standard Route, esta ruta tiene que ser inicializada con una definición de ruta y algunos valores predeterminados. Vamos a crear un archivo ruta como un ejemplo, similar al previamente definido, sólo que esta vez usaremos la ruta Regex:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)',
        array(
            
    'controller' => 'archive',
            
    'action'     => 'show'
        
    )
    );
    $router->addRoute('archive'$route);

    Cada sub-patrón regex definido será inyectado al objeto solicitud. Con nuestro ejemplo anterior, después de un matching exitoso http://domain.com/archive/2006 , el valor resultante del array puede verse como:

    $values = array(
        
    1            => '2006',
        
    'controller' => 'archive',
        
    'action'     => 'show'
    );
    [Nota] Nota

    Las barras de comienzo y final están recortadas de la URL en el Router antes de una concordancia. Como resultado, coincidendo con la URL http://domain.com/foo/bar/ , involucraría al regex de foo/bar , y no a /foo/bar .

    [Nota] Nota

    Las anclas de comienzo y fin de línea ('^' y '$', respectivamente) son automáticamente antepuestas y pospuestas a todas las expresiones. Así, no debe usar éstas en sus expresiones regulares, y debe coincidir con el string completo.

    [Nota] Nota

    Esta clase de ruta usa el carácter # como un delimitador. Esto significa que necesitará caracteres hash ('#') para escapar pero no barras ('/') en sus definiciones de ruta. Dado que el carácter '#' (llamado ancla) es raramente pasado al webserver, será muy rara la necesidad de utilizar ese carácter en su regex.

    Puede obtener el contenido de los sub-patrones definidos por la forma habitual:

    public function showAction()
    {
        
    $request $this->getRequest();
        
    $year    $request->getParam(1); // $year = '2006';
    }
    [Nota] Nota

    Tenga en cuenta que la clave es un entero (1) en lugar de un string ('1').

    Sin embargo, esta ruta no funciona exactamente igual que su contraparte standard route dado que el valor por defecto para 'year' todavía no se ha establecido. Y lo que puede ser no tan evidente es que tendremos un problema con una barra final incluso si declaramos por defecto el año y hacemos opcional al sub-patrón. La solución es hacer que toda la parte del año sea opcional junto con la barra pero capturar solo la parte numérica:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive(?:/(\d+))?',
        array(
            
    1            => '2006',
            
    'controller' => 'archive',
            
    'action'     => 'show'
        
    )
    );
    $router->addRoute('archive'$route);

    Ahora, ocupemósnos del problema que probablemente haya notado. Utilizar claves basadas en enteros para los parámetros no es una solución fácilmente manejable y puede ser potencialmente problemática a largo plazo. Y aquí es donde entra el tercer parámetro. Este parámetro es un array asociativo que representa un mapa de sub-patrones regex a nombres de clave de parámetros. Trabajemos en nuestro ejemplo más fácil:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)',
        array(
            
    'controller' => 'archive',
            
    'action' => 'show'
        
    ),
        array(
            
    => 'year'
        
    )
    );
    $router->addRoute('archive'$route);

    Esto resultaraá en los siguientes valores inyectados a la solicitud:

    $values = array(
        
    'year'       => '2006',
        
    'controller' => 'archive',
        
    'action'     => 'show'
    );

    El mapa puede ser definido en cualquier dirección para hacer que funcione en cualquier ambiente. Las claves pueden contener nombres de variables o índices de sub-patrones:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)',
        array( ... ),
        array(
    => 'year')
    );

    // O

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)',
        array( ... ),
        array(
    'year' => 1)
    );
    [Nota] Nota

    Las claves de los sub-patrones deben respresentarse por enteros.

    Observe que el índice numérico en los valores del Request ahora han desaparecido y en su lugar se muestra una variable nombrada. Por supuesto que puede mezclar variables nombradas y numéricas si lo desea:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)/page/(\d+)',
        array( ... ),
        array(
    'year' => 1)
    );

    Lo que resultará en una mezcla de valores disponibles en la solicitud. Como ejemplo, la URL http://domain.com/archive/2006/page/10 resultará con los siguientes valores:

    $values = array(
        
    'year'       => '2006',
        
    2            => 10,
        
    'controller' => 'archive',
        
    'action'     => 'show'
    );

    Dado que los patrones regex no pueden invertirse fácilmente, tendrá que preparar una URL inversa si desea usar un ayudante de URL o incluso un método de ensamble de esta clase. Este path inverso está representado por un string parseable por sprintf() y se define como el cuarto parámetro del constructor:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'archive/(\d+)',
        array( ... ),
        array(
    'year' => 1),
        
    'archive/%s'
    );

    Todo esto es algo que ya fue posible de hacer por medio de un objeto de ruta estandard, por lo tanto podría preguntarese: ¿cuál es la ventaja de utilizar la ruta Regex?. Principalmente, le permite describir cualquier tipo de URL sin restricción alguna. Imagínese que tiene un blog y desea crear URLs como: http://domain.com/blog/archive/01-Using_the_Regex_Router.html , y que tiene que descomponer el último elemento del path 01-Using_the_Regex_Router.html , en un ID de artículo y en el título o descripción del artículo; esto no es posible con el standard route. Con la ruta Regex, puede hacer algo como la siguiente solución:

    $route = new Zend_Controller_Router_Route_Regex(
        
    'blog/archive/(\d+)-(.+)\.html',
        array(
            
    'controller' => 'blog',
            
    'action'     => 'view'
        
    ),
        array(
            
    => 'id',
            
    => 'description'
        
    ),
        
    'blog/archive/%d-%s.html'
    );
    $router->addRoute('blogArchive'$route);

    Como puede ver, esto añade una enorme cantidad de flexibilidad por encima del standard route.

    24.5.7.4. Zend_Controller_Router_Route_Hostname

    Zend_Controller_Router_Route_Hostname es la ruta del framework en el servidor. Funciona similarmente a la standard route, pero funciona con el nombre del host de la URL llamada, en lugar del path.

    Vamos a usar el ejemplo de la standard route y ver cómo se vería con un nombre basado en host. En lugar de llamar al usuario mediante un path, quisiéramos que un usuario pueda llamar a http://martel.users.example.com para ver la información acerca del usuario "martel".

    $hostnameRoute = new Zend_Controller_Router_Route_Hostname(
        
    ':username.users.example.com',
        array(
            
    'controller' => 'profile',
            
    'action'     => 'userinfo'
        
    )
    );

    $plainPathRoute = new Zend_Controller_Router_Route_Static('');

    $router->addRoute('user'$hostnameRoute->chain($plainPathRoute);

    El primer parámetro del constructor en Zend_Controller_Router_Route_Hostname es una definición de ruta que será comparada con el nombre del host. Las definiciones de ruta consisten en partes estáticas y dinámicas separadas por el carácter punto ('.'). Las partes dinámicas, llamadas variables, se marcan anteponiendo dos puntos (':') al nombre de la variable: :username . Las partes estáticas son simplemente texto: user .

    Las rutas del nombre del host pueden, pero nunca deben ser utilizadas así. La razón detrás de esto es que la ruta del nombre del host solamente, concordaría con cualquier path. Entonces, lo que tiene que hacer es encadenar una ruta del path a la ruta del nombre del host. Esto se hace como en el ejemplo llamando a $hostnameRoute->chain($pathRoute); . Haciendo esto, $hostnameRoute no se modifica, pero devuelve una nueva ruta ( Zend_Controller_Router_Route_Chain ), que luego puede ser entregada al router.

    24.5.7.5. Zend_Controller_Router_Route_Chain

    Zend_Controller_Router_Route_Chain es una ruta que permite encadenar juntas a múltiples rutas. Esto le permite encadenar hostname/rutas y rutas de paths, o múltiples paths de rutas por ejemplo. El encadenamiento puede hacerse programáticamente o dentro de un archivo de configuración.

    [Nota] Prioridad de Parámetros

    Cuando se encadenan en conjunto varias rutas, los parámetros de la ruta exterior tienen mayor prioridad que los parámetros de la ruta interior. Así, si define un controlador en el exterior y otro en la ruta interior, será seleccionado el controlador de la ruta exterior.

    Cuando el encadenamiento se realiza prográmaticamente, hay dos maneras de archivarlo. La primera consiste en crear una nueva instancia Zend_Controller_Router_Route_Chain y entones llamar al método chain() varias veces con todas las rutas que deberían encadenarse juntas. La otra forma es tomar la primera ruta, por ejemplo, la ruta del nombre del host, y llamar al método chain() con la ruta que debería ser anexada a ella. Esto no modificará la ruta del nombre del host, pero devolverá una nueva instancia de Zend_Controller_Router_Route_Chain , teniendo entonces a ambas rutas encadenadas juntas:

    // Crear dos rutas
    $hostnameRoute = new Zend_Controller_Router_Route_Hostname(...);
    $pathRoute     = new Zend_Controller_Router_Route(...);

    // Primera manera, encadenarlas con chain route
    $chainedRoute = new Zend_Controller_Router_Route_Chain();
    $chainedRoute->chain($hostnameRoute)
                 ->
    chain($pathRoute);

    // Segunda manera, encadenarlas directamente
    $chainedRoute $hostnameRoute->chain($pathRoute);

    Cuando las rutas se encadenan juntas, su separador es una barra ('/'). Pueden haber casos cuando quiera tener un separador diferente:

    // Crear dos rutas
    $firstRoute  = new Zend_Controller_Router_Route('foo');
    $secondRoute = new Zend_Controller_Router_Route('bar');

    // Encadenarlas juntas con un separador diferente
    $chainedRoute $firstRoute->chain($secondRoute'-');

    // Ensamblar la ruta: "foo-bar"
    echo $chainedRoute->assemble();
    24.5.7.5.1. Encadenar Rutas via Zend_Config

    Para encadenar juntas a las rutas en un archivo de configuración, hay parámetros adicionales para la configuración de aquellos. El enfoque más sencillo es utilizar los parámetros chains . Este es simplemente una lista de las rutas, que será encadenada con la ruta padre. Ni la ruta padre ni la ruta hijo serán añadidos directamente al router sino que sólo lo hará la ruta del encadenamiento resultante. El nombre de la ruta encadenada en el router será el nombre de la ruta padre concatenada con un guión ('-') con el nombre de la ruta hijo. Un simple config en XML se vería así:

    <routes>
        <
    www type="Zend_Controller_Router_Route_Hostname">
            <
    route>www.example.com</route>
            <
    chains>
                <
    language type="Zend_Controller_Router_Route">
                    <
    route>:language</route>
                    <
    reqs language="[a-z]{2}">
                    <
    chains>
                        <
    index type="Zend_Controller_Router_Route_Static">
                            <
    route></route>
                            <
    defaults module="default" controller="index"
                                      
    action="index" />
                        </
    index>
                        <
    imprint type="Zend_Controller_Router_Route_Static">
                            <
    route>imprint</route>
                            <
    defaults module="default" controller="index"
                                      
    action="index" />
                        </
    imprint>
                    </
    chains>
                </
    language>
            </
    chains>
        </
    www>
        <
    users type="Zend_Controller_Router_Route_Hostname">
            <
    route>users.example.com</route>
            <
    chains>
                <
    profile type="Zend_Controller_Router_Route">
                    <
    route>:username</route>
                    <
    defaults module="users" controller="profile" action="index" />
                </
    profile>
            </
    chains>
        </
    users>
        <
    misc type="Zend_Controller_Router_Route_Static">
            <
    route>misc</route>
        </
    misc>
    </
    routes>

    Esto se traducirá en las tres rutas www-language-index , www-language-imprint y users-language-profile que sólo concordarán basados en el nombre y la ruta misc , que se comparará con cualquier nombre de host.

    La manera alternativa de crear una ruta encadenada es a través del parámetro chain , que sólo puede utilizarse directamente con el tipo cadena-ruta, y también trabaja en el nivel raíz:

    <routes>
        <
    www type="Zend_Controller_Router_Route_Chain">
            <
    route>www.example.com</route>
        </
    www>
        <
    language type="Zend_Controller_Router_Route">
            <
    route>:language</route>
            <
    reqs language="[a-z]{2}">
        </
    language>
        <
    index type="Zend_Controller_Router_Route_Static">
            <
    route></route>
            <
    defaults module="default" controller="index" action="index" />
        </
    index>
        <
    imprint type="Zend_Controller_Router_Route_Static">
            <
    route>imprint</route>
            <
    defaults module="default" controller="index" action="index" />
        </
    imprint>

        <
    www-index type="Zend_Controller_Router_Route_Chain">
            <
    chain>wwwlanguageindex</chain>
        </
    www-index>
        <
    www-imprint type="Zend_Controller_Router_Route_Chain">
            <
    chain>wwwlanguageimprint</chain>
        </
    www-imprint>
    </
    routes>

    También puede darle el parámetro a chain como un array en vez de separ las rutas con comas:

    <routes>
        <
    www-index type="Zend_Controller_Router_Route_Chain">
            <
    chain>www</chain>
            <
    chain>language</chain>
            <
    chain>index</chain>
        </
    www-index>
        <
    www-imprint type="Zend_Controller_Router_Route_Chain">
            <
    chain>www</chain>
            <
    chain>language</chain>
            <
    chain>imprint</chain>
        </
    www-imprint>
    </
    routes>

    When you configure chain routes with Zend_Config and want the chain name separator to be different from a dash, you need to specify this separator separately:

    $config = new Zend_Config(array(
        
    'chainName' => array(
            
    'type'   => 'Zend_Controller_Router_Route_Static',
            
    'route'  => 'foo',
            
    'chains' => array(
                
    'subRouteName' => array(
                    
    'type'     => 'Zend_Controller_Router_Route_Static',
                    
    'route'    => 'bar',
                    
    'defaults' => array(
                        
    'module'      => 'module',
                         
    'controller' => 'controller',
                         
    'action'     => 'action'
                    
    )
                )
            )
        )
    ));

    // Set separator before adding config
    $router->setChainNameSeparator('_separator_')

    // Add config
    $router->addConfig($config);

    // The name of our route now is: chainName_separator_subRouteName
    echo $this->_router->assemble(array(), 'chainName_separator_subRouteName');

    // The proof: it echoes /foo/bar

    24.5.8. Usando Zend_Config con RewriteRouter

    A veces es más conveniente para actualizar un archivo de configuración con nuevas rutas que modificar el código. Esto es posible a través del método addConfig() . Básicamente, se crea una configuración compatible con Zend_Config . Y en su código lo lee y lo pasa a RewriteRouter.

    Como ejemplo, considere el siguiente archivo INI :

    [production]
    routes.archive.route "archive/:year/*"
    routes.archive.defaults.controller archive
    routes
    .archive.defaults.action show
    routes
    .archive.defaults.year 2000
    routes
    .archive.reqs.year "\d+"

    routes.news.type "Zend_Controller_Router_Route_Static"
    routes.news.route "news"
    routes.news.defaults.controller "news"
    routes.news.defaults.action "list"

    routes.archive.type "Zend_Controller_Router_Route_Regex"
    routes.archive.route "archive/(\d+)"
    routes.archive.defaults.controller "archive"
    routes.archive.defaults.action "show"
    routes.archive.map.1 "year"
    Oroutes.archive.map.year 1

    Entonces el archivo INI puede ser leído por un objeto Zend_Config como sigue:

    $config = new Zend_Config_Ini('/path/to/config.ini''production');
    $router = new Zend_Controller_Router_Rewrite();
    $router->addConfig($config'routes');

    En el ejemplo de arriba, le decimos el router que utilice la sección 'routes' del archivo INI para utilizarlo en sus rutas. Cada clave de primer nivel en esa sección será utilizada para definir un nombre de ruta; el ejemplo anterior define las rutas 'archive' y 'news'. Entonces cada ruta requiere, como mínimo, una entrada a la 'ruta' y una o más entradas por 'default'; opcionalmente puede proporcionarse una o más 'reqs' (abreviación de 'required'). Dicho todo esto, estos corresponden a los tres argumentos que se le suministran al objeto Zend_Controller_Router_Route_Interface . Puede utilizarse una clave opcional 'type' para especificar el tipo de clase de ruta a utilizar en esa ruta en particular; por defecto, usa Zend_Controller_Router_Route . En el ejemplo de arriba, la ruta 'news' está definida para usar Zend_Controller_Router_Route_Static .

    24.5.9. Subclassing del Router

    El standard rewrite router debería proporcionarle más funcionalidad si la necesita; más a menudo, sólo necesitará crear un nuevo tipo de ruta a fin de ofrecer funcionalidades nuevas o modificadas sobre las tutas provistas.

    Dicho esto, en algún momento puede encontrarse a si mismo deseando usar un paradigma diferente de routing. La intefaz Zend_Controller_Router_Interface proporciona la información mínima necesaria para crear un router, y consiste en un único método.

    interface Zend_Controller_Router_Interface
    {
      
    /**
       * @param  Zend_Controller_Request_Abstract $request
       * @throws Zend_Controller_Router_Exception
       * @return Zend_Controller_Request_Abstract
       */
      
    public function route(Zend_Controller_Request_Abstract $request);
    }

    El routing sólo ocurre una vez: cuando la petición es recibida por primera vez en el sistema. El propósito del router es determinar el controlador, la acción, y los parámetros opcionales sobre la base del medio ambiente de la solicitud, y luego ajustarlos en la solicitud. El objeto solicitud se pasa entonces al dispatcher. Si no es posible trazar una ruta hacia un dispatch token, el router no debe hacer nada con el objeto solicitud.

    digg delicious meneame google twitter technorati facebook

    Comentarios

    Loading...