boarspring
/
repo_zf1
mirror of https://github.com/bluescreen/zf1-php7.2.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615
							<?xml version="1.0" encoding="UTF-8"?>
    <!-- EN-Revision: 17987 -->
    <!-- Reviewed: no -->
<sect2 id="zend.dojo.view.dojo">
    <title>dojo() Ayudante de Vista</title>

    <para>
        El ayudante de vista
        <methodname>dojo()</methodname>
        está destinado a simplificar el
        establecimiento del medio ambiente de Dojo, incluyendo las
        siguientes responsabilidades:
    </para>

    <itemizedlist>
        <listitem>
            <para>Especificar bien un CDN o un path local para instalar Dojo.</para>
        </listitem>
        <listitem>
            <para>Especificando paths a módulos Dojo personalizados.</para>
        </listitem>
        <listitem>
            <para>Especificando sentencias dojo.require.</para>
        </listitem>
        <listitem>
            <para>Especificando hojas de estilo dijit a usar.</para>
        </listitem>
        <listitem>
            <para>Especificando eventos dojo.addOnLoad().</para>
        </listitem>
    </itemizedlist>

    <para>
        La implementación del ayudante de vista
        <methodname>dojo()</methodname>
        es un ejemplo de
        implementación de un marcador de posición. El conjunto de datos en él,
        persiste entre los
        objetos vista y puede ser directamente activado con en "echo" de
        <acronym>PHP</acronym>
        desde su script.
    </para>

    <example id="zend.dojo.view.dojo.usage">
        <title>dojo() Ejemplo de Uso del Ayudante de Vista</title>

        <para>En este ejemplo, asumamos que el desarrollador estará usando Dojo desde un path
            local,
            se necesitarán varios dijits, y se utilizará el tema de dijit Tundra.</para>

        <para>En muchas páginas, el desarrollador no podrá utilizar Dojo para nada. Así, vamos a
            centrarnos primero en un view script donde Dojo es necesario y luego en el layout
            script, en donde vamos a configurar algo del medio ambiente de Dojo y luego lo
            mostraremos.</para>

        <para>En primer lugar, tenemos que decir nuestro objeto vista que utilice el path del
            ayudante de vista de Dojo. Esto puede hacerse en el arranque o en un plugin de ejecución
            temprana; simplemente apoderarse de su objeto vista y ejecutar lo siguiente:</para>

        <programlisting language="php"><![CDATA[
$view->addHelperPath('Zend/Dojo/View/Helper/', 'Zend_Dojo_View_Helper');
]]></programlisting>

        <para>El paso siguiente, el view script. En este caso, vamos a especificar que vamos a
            estar
            utilizando un FilteringSelect -- que consumirá un almacén personalizado basado en
            QueryReadStore, al que llamamos 'PairedStore' y almacenado en nuestro módulo 'custom'.</para>

        <programlisting language="php"><![CDATA[
<?php // establecer el data store para FilteringSelect ?>
<div dojoType="custom.PairedStore" jsId="stateStore"
    url="/data/autocomplete/type/state/format/ajax"
    requestMethod="get"></div>

<?php // Elemento de entrada: ?>
State: <input id="state" dojoType="dijit.form.FilteringSelect"
    store="stateStore" pageSize="5" />

<?php // establecer elementos requeridos por dojo:
$this->dojo()->enable()
             ->setDjConfigOption('parseOnLoad', true)
             ->registerModulePath('custom', '../custom/')
             ->requireModule('dijit.form.FilteringSelect')
             ->requireModule('custom.PairedStore'); ?>
]]></programlisting>

        <para>En nuestro script de esquema, vamos entonces a comprobar si Dojo está habilitado, y
            si
            es así, haremos algunas configuraciones más generales y lo ensamblaremos:</para>

        <programlisting language="php"><![CDATA[
<?php echo $this->doctype() ?>
<html>
<head>
    <?php echo $this->headTitle() ?>
    <?php echo $this->headMeta() ?>
    <?php echo $this->headLink() ?>
    <?php echo $this->headStyle() ?>
<?php if ($this->dojo()->isEnabled()){
    $this->dojo()->setLocalPath('/js/dojo/dojo.js')
                 ->addStyleSheetModule('dijit.themes.tundra');
    echo $this->dojo();
   }
?>
    <?php echo $this->headScript() ?>
</head>
<body class="tundra">
    <?php echo $this->layout()->content ?>
    <?php echo $this->inlineScript() ?>
</body>
</html>
]]></programlisting>

        <para>En este punto, sólo necesita asegurarse de que sus archivos están en el lugar
            correcto
            y que ha creado el punto final de acción para su FilteringSelect!</para>
    </example>

    <sect3 id="zend.dojo.view.dojo.declarative">
        <title>Uso Programático y Declarativo de Dojo</title>

        <para>
            Dojo permite usar a ambos
            <emphasis>declarative</emphasis>
            y
            <emphasis>programmatic</emphasis>
            en muchas de sus características. El uso de
            <emphasis>Declarative</emphasis>
            utiliza elementos
            <acronym>HTML</acronym>
            con atributos no estándar
            que se parsean cuando la página se está cargado. Mientras que
            ésta es una sintaxis
            poderosa y simple de utilizar, para muchos desarrolladores esto
            puede causar problemas
            con la validación de páginas.
        </para>

        <para>
            El uso de
            <emphasis>Programmatic</emphasis>
            permite al desarrollador decorar los
            elementos existentes tirando de ellos por ID o
            selectores
            <acronym>CSS</acronym>
            y
            pasarlos a los constructores apropiados de objetos en Dojo. Debido a que no se usan
            atributos
            <acronym>HTML</acronym>
            no standard, las páginas continúan con la validación.
        </para>

        <para>
            En la práctica, ambos casos de uso permiten una degradación elegante cuando
            javascript
            está desactivado o los diversos recursos de Dojo script están fuera de
            alcance. Para
            promover las normas y validación de documentos, Zend Framework hace uso de
            los usos
            programáticos por defecto; los diversos ayudantes de vista generarán javascript
            y lo
            empujan al ayudante de vista
            <methodname>dojo()</methodname>
            para su inclusión
            cuando sean presentados.
        </para>

        <para>Utilizando esta técnica los desarrolladores pueden también desear explorar la
            posibilidad de escribir sus propia decoración programática de la página. Uno de los
            beneficios sería la posibilidad de especificar handlers para eventos dijit.</para>

        <para>Para permitir esto, así como la posibilidad de usar sintaxis declarativa, hay
            disponibles una serie de métodos estáticos para establecer globamente este
            comportamiento.</para>

        <example id="zend.dojo.view.dojo.declarative.usage">
            <title>Especificando el Uso Declarativo y Programático de Dojo</title>

            <para>
                Para especificar el uso declarativo, simplemente llame al método estático
                <methodname>setUseDeclarative()</methodname>
                :
            </para>

            <programlisting language="php"><![CDATA[
Zend_Dojo_View_Helper_Dojo::setUseDeclarative();
]]></programlisting>

            <para>
                Si decide más bien utilizar el uso programático, llame al método estático
                <methodname>setUseProgrammatic()</methodname>
                :
            </para>

            <programlisting language="php"><![CDATA[
Zend_Dojo_View_Helper_Dojo::setUseProgrammatic();
]]></programlisting>

            <para>Por último, si quiere crear sus propias normas programáticas, debe especificar el
                uso programático, pero al pasarle el valor '-1'; en esta situación, no se creará
                ningún javascript para decorar cualquier dijit usado.</para>

            <programlisting language="php"><![CDATA[
Zend_Dojo_View_Helper_Dojo::setUseProgrammatic(-1);
]]></programlisting>
        </example>
    </sect3>

    <sect3 id="zend.dojo.view.dojo.themes">
        <title>Temas</title>

        <para>Dojo permite la creación de los temas de su dijits (widgets). Puede seleccionar uno
            pasándolo en un path de módulo:</para>

        <programlisting language="php"><![CDATA[
$view->dojo()->addStylesheetModule('dijit.themes.tundra');
]]></programlisting>

        <para>
            La ruta del módulo es descubierta por utilizar el carácter '.' como separador de
            directorio y utilizando el último valor en la lista como el nombre del archivo
            <acronym>CSS</acronym>
            en ese directorio del tema a usar; en el ejemplo de arriba,
            Dojo buscará el tema en
            'dijit/themes/tundra/tundra.css'.
        </para>

        <para>Cuando se utiliza un tema, es importante recordar pasar la calse del tema a, por lo
            menos un contenedor rodeando cualquier dijits que se utilice; el caso de uso más común
            es pasárselo en el body:</para>

        <programlisting language="html"><![CDATA[
<body class="tundra">
]]></programlisting>
    </sect3>

    <sect3 id="zend.dojo.view.dojo.layers">
        <title>Usando Layers (Construcciones Personalizadas)</title>

        <para>Por defecto, cuando utilice uns sentencia dojo.require, dojo hará una solicitud de
            retorno al servidor para agarrar al archivo javascript apropiado. Si hay muchos dijits
            en el lugar, esto se traduce en muchas peticiones al servidor -- lo que no es óptimo.</para>

        <para>
            La respuesta de Dojo a esto es proporcionar la capacidad de crear
            <emphasis>custom
                builds (construcciones personalizadas</emphasis>
            . Las contrucciones hacen varias
            cosas:
        </para>

        <itemizedlist>
            <listitem>
                <para>
                    Grupos de archivos necesarios en
                    <emphasis>layers</emphasis>
                    ; una capa
                    (layer) agrupa a todos archivos necesarios en un único archivo JS. (De
                    ahí el
                    nombre de esta sección.)
                </para>
            </listitem>

            <listitem>
                <para>"Interns" no son archivos javascript usados por dijits (típicamente, archivos
                    de plantilla). También están agrupados en el mismo archivo JS como la capa.
               </para>
            </listitem>

            <listitem>
                <para>Pasa el archivo a través de ShrinkSafe, que elimina espacios en blanco y
                    comentarios, así como acorta nombres de variables.</para>
            </listitem>
        </itemizedlist>

        <para>Algunos archivos pueden no ser superpuestos, pero el proceso creará una versión
            especial del directorio con la archivo capa y todos los otros archivos. Esto le permite
            tener una distribución reducida adaptada a su sitio o necesidades de aplicación.</para>

        <para>
            Para usar una capa, el ayudante de vista
            <methodname>dojo()</methodname>
            tiene el
            método
            <methodname>addLayer()</methodname>
            para añadir paths de capas requeridas:
        </para>

        <programlisting language="html"><![CDATA[
$view->dojo()->addLayer('/js/foo/foo.js');
]]></programlisting>

        <para>
            Para más información sobre la creación de construcciones personalizadas, por favor
            <ulink
                url="http://dojotoolkit.org/book/dojo-book-0-9/part-4-meta-dojo/package-system-and-custom-builds"
            > consulte la docuemntación de Build de Dojo</ulink>
            .
        </para>
    </sect3>

    <sect3 id="zend.dojo.view.dojo.methods">
        <title>Métodos Disponibles</title>

        <para>
            El ayudante de vista
            <methodname>dojo()</methodname>
            siempre devuelve una instancia
            del contenedor del marcador de posición dojo. Ese objeto
            contenedor dispone de los
            siguientes métodos:
        </para>

        <itemizedlist>
            <listitem>
                <para>
                    <methodname>setView(Zend_View_Interface $view)</methodname>
                    : establecer una
                    instancia de vista en el contenedor.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>enable()</methodname>
                    : habilitar explícitamente la integración de
                    Dojo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>disable()</methodname>
                    : deshabilitar la integración de
                    Dojo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>isEnabled()</methodname>
                    : determinar cuándo la integración de Dojo
                    está habilitada o no.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>requireModule($module)</methodname>
                    : establecer una sentencia
                    <methodname>dojo.require</methodname>
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getModules()</methodname>
                    : determinar qué módulos han sido
                    requeridos.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>registerModulePath($module, $path)</methodname>
                    : registrar un path
                    de un módulo personalizado de Dojo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getModulePaths()</methodname>
                    : obtener la lista de los paths de
                    módulos registrados.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>addLayer($path)</methodname>
                    : añadir una capa (construcción
                    personalizada) del path a utilizar.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getLayers()</methodname>
                    : conseguir una lista de todos los paths
                    de capas registrados (construcción
                    personalizada).
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>removeLayer($path)</methodname>
                    : eliminar la capa que concuerde
                    con
                    <varname>$path</varname>
                    de la lista de capas registradas
                    (construcción personalizada).
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setCdnBase($url)</methodname>
                    : establecer la URL base para un CDN;
                    típicamente, una de las
                    <constant>Zend_Dojo::CDN_BASE_AOL</constant>
                    o
                    <constant>Zend_Dojo::CDN_BASE_GOOGLE</constant>
                    , pero sólo necesita ser el
                    string del URL antes del número de versión.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getCdnBase()</methodname>
                    : recuperar el CDN de la url base a
                    utilizar.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setCdnVersion($version = null)</methodname>
                    : establecer cuál es la
                    versión de Dojo a utilizar desde el CDN.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getCdnVersion()</methodname>
                    : recuperar que versión de Dojo será
                    utilizada desde el CDN.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setCdnDojoPath($path)</methodname>
                    : establecer el path relativo a
                    un archivo dojo.js o dojo.xd.js sobre un CDN;
                    típicamente, uno de los
                    <constant>Zend_Dojo::CDN_DOJO_PATH_AOL</constant>
                    o
                    <constant>Zend_Dojo::CDN_DOJO_PATH_GOOGLE</constant>
                    , pero sólo debe ser
                    el string del path detrás del número de versión.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getCdnDojoPath()</methodname>
                    : recuperar el último segmento del
                    path del CDN de la url apuntando al archivo
                    dojo.js.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>useCdn()</methodname>
                    : decirle al contenedor que utilice el CDN;
                    implícitamente permite integración.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setLocalPath($path)</methodname>
                    : decirle al contenedor el path a
                    una instalación local de Dojo (deberá ser una
                    ruta relativa al servidor, y
                    contener el propio archivo dojo.js); implícitamente
                    permite integración.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getLocalPath()</methodname>
                    : determinar qué ruta local a Dojo está
                    siendo utilizada.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>useLocalPath()</methodname>
                    : ¿la integración está utilizando un
                    path local de Dojo?
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setDjConfig(array $config)</methodname>
                    : conjunto de valores de
                    configuración dojo/dijit (espera un array asociativo).
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>setDjConfigOption($option, $value)</methodname>
                    : establecer un
                    único valor de configuración para dojo/dijit.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getDjConfig()</methodname>
                    : obtener todos los valores de
                    configuración de dojo/dijit.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getDjConfigOption($option, $default = null)</methodname>
                    :
                    conseguir un único valor de configuración de dojo/dijit.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>addStylesheetModule($module)</methodname>
                    : agregar una hoja de
                    estilo sobre la base del tema de un módulo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getStylesheetModules()</methodname>
                    : obtener hojas de estilo
                    registradas como temas de módulos.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>addStylesheet($path)</methodname>
                    : agregar una hoja de estilo
                    local para su uso con Dojo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getStylesheets()</methodname>
                    : obtener hojas de estilo locales
                    Dojo.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>addOnLoad($spec, $function = null)</methodname>
                    : agregar un lambda
                    para dojo.onLoad para llamadas. Si se pasa un argumento, se
                    supone que que puede
                    ser tanto el nombre de una función o dar por terminado
                    javascript. Si se pasan
                    dos argumentos, el primero se supone que es el nombre de
                    la variable de la
                    instancia de un objeto y el segundo ya sea un nombre de método
                    en ese objeto o
                    un cierre a utilizar con ese objeto.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>prependOnLoad($spec, $function = null)</methodname>
                    : exactamente
                    como
                    <methodname>addOnLoad()</methodname>
                    , excluyendo agregar al principio el
                    comienzo de onLoad stack.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>getOnLoadActions()</methodname>
                    : recuperar todas las acciones
                    dojo.onLoad registradas con el contenedor. Esto
                    será un array de arrays.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>onLoadCaptureStart($obj = null)</methodname>
                    : capturar los datos
                    que se utilizarán como lambda para dojo.onLoad(). Si se
                    provee $obj, los códigos
                    JS capturados serán considerados un cierre a utilizar
                    con ese objeto
                    Javascript.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>onLoadCaptureEnd($obj = null)</methodname>
                    : finalizar la captura
                    de datos para su uso con dojo.onLoad().
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>javascriptCaptureStart()</methodname>
                    : captura javascript
                    arbitrario para ser incluido en Dojo JS (onLoad, require,
                    etc.
                    statements).
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>javascriptCaptureEnd()</methodname>
                    : finalizar la captura de
                    javascript.
                </para>
            </listitem>
            <listitem>
                <para>
                    <methodname>__toString()</methodname>
                    : emitir el contenedor a un string;
                    muestra todo el estilo
                    <acronym>HTML</acronym>
                    y elementos del script.
                </para>
            </listitem>
        </itemizedlist>
    </sect3>
</sect2>