repo_zf1Php7/documentation/manual/es/module_specs/Zend_Controller-Router-Route.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect3 id="zend.controller.router.routes.standard">
    <title>Zend_Controller_Router_Route</title>

    <para>
        <classname>Zend_Controller_Router_Route</classname> 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.
    </para>

    <para>
        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 
        <code>http://domain.com/author/martel</code> para ver la información 
        sobre este muchacho "martel". La ruta para esa funcionalidad podría 
        parecerse a:
    </para>

    <programlisting role="php"><![CDATA[
$route = new Zend_Controller_Router_Route(
    'author/:username',
    array(
        'controller' => 'profile',
        'action'     => 'userinfo'
    )
);

$router->addRoute('user', $route);
]]></programlisting>

    <para>
        El primer parámetro en el constructor 
        <classname>Zend_Controller_Router_Route</classname>
        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: <code>author</code>. Las partes dinámicas, llamadas variables, 
        se marcan anteponiendo dos puntos (:) al nombre de la variable  
        <code>:username</code>.
    </para>

    <note>
        <title>Uso de Caracteres</title>
        <para>
            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.
        </para>
    </note>

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

    <programlisting role="php"><![CDATA[
$values = array(
    'username'   => 'martel',
    'controller' => 'profile',
    'action'     => 'userinfo'
);
]]></programlisting>

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

    <programlisting role="php"><![CDATA[
public function userinfoAction()
{
    $request = $this->getRequest();
    $username = $request->getParam('username');

    $username = $this->_getParam('username');
}
]]></programlisting>

    <para>
        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:
    </para>

    <programlisting role="php"><![CDATA[
$route = new Zend_Controller_Router_Route(
    ':module/:controller/:action/*',
    array('module' => 'default')
);
$router->addRoute('default', $route);
]]></programlisting>

    <sect4 id="zend.controller.router.routes.standard.variable-defaults">
        <title>Variables por Defecto</title>

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

        <programlisting role="php"><![CDATA[
$route = new Zend_Controller_Router_Route(
    'archive/:year',
    array('year' => 2006)
);
$router->addRoute('archive', $route);
]]></programlisting>

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

        <para>
            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 
            <classname>Zend_Controller_Dispatcher_Abstract</classname>). 
            Para hacerlos más utilizables, tiene que proporcionar un controlador 
            válido y una acción válida como la ruta por defecto:
        </para>

        <programlisting role="php"><![CDATA[
$route = new Zend_Controller_Router_Route(
    'archive/:year',
    array(
        'year'       => 2006,
        'controller' => 'archive',
        'action'     => 'show'
    )
);
$router->addRoute('archive', $route);
]]></programlisting>

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

    </sect4>

    <sect4 id="zend.controller.router.routes.standard.variable-requirements">
        <title>Requerimientos para Variables</title>

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

        <programlisting role="php"><![CDATA[
$route = new Zend_Controller_Router_Route(
    'archive/:year',
    array(
        'year'       => 2006,
        'controller' => 'archive',
        'action'     => 'show'
    ),
    array('year' => '\d+')
);
$router->addRoute('archive', $route);
]]></programlisting>

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

    <sect4 id="zend.controller.router.routes.standard.translated-segments">
        <title>Segmentos Traducidos</title>

        <para>
            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 <classname>Zend_Translate</classname>) 
            mediante una de las siguientes formas:
        </para>

        <itemizedlist>
            <listitem>
                <para>
                    Ponerlo en el registro con la clave 
                    <classname>Zend_Translate</classname>.
                </para>
            </listitem>
            <listitem>
                <para>
                    Setearlo mediante el método estático
                    <classname>Zend_Controller_Router_Route::setDefaultTranslator()</classname>.
                </para>
            </listitem>
            <listitem>
                <para>
                    Pasarlo como cuarto parámetro al constructor.
                </para>
            </listitem>
        </itemizedlist>

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

        <itemizedlist>
            <listitem>
                <para>
                    Ponerlo en el registro con la clave <classname>Zend_Locale</classname>.
                </para>
            </listitem>
            <listitem>
                <para>
                    Setearlo mediante el método estático 
                    <classname>Zend_Controller_Router_Route::setDefaultLocale()</classname>.
                </para>
            </listitem>
            <listitem>
                <para>
                    Pasarlo como cuarto parámetro al constructor.
                </para>
            </listitem>
            <listitem>
                <para>
                    Pasarlo como parámetro <code>@locale</code> al método de 
                    ensamblaje.
                </para>
            </listitem>
        </itemizedlist>

        <para>
            Los segmentos traducidos se dividen en dos partes. 
            Los segmentos fijos están precedidos por un único signo 
            <code>@</code>, 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 <code>:@</code>.
            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.
        </para>

        <note>
            <title>IDs de Mensajes y Archivos de Lenguajes Separados</title>
            <para>
                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 URLs seguras, debe usar 
                un archivo de idioma separado para los mensajes utilizados en 
                la ruta.
            </para>
        </note>

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

        <programlisting role="php"><![CDATA[
// 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);
]]></programlisting>

        <para>
            Este ejemplo demuestra el uso de segmentos estáticos:
        </para>

        <programlisting role="php"><![CDATA[
// 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());
]]></programlisting>

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

        <programlisting role="php"><![CDATA[
// 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'));
]]></programlisting>

        <para>
            También puede mezclar segmentos estáticos y dinámicos:
        </para>

        <programlisting role="php"><![CDATA[
// 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'));
]]></programlisting>
    </sect4>
</sect3>
<!--
vim:se ts=4 sw=4 et:
-->