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

    29.3. Ayudantes de Dojo View

    Zend Framework provee los siguientes ayudantes específicos de Dojo:

    • dojo(): configura el medio ambiente de Dojo para su página, incluyendo valores de configuración de Dojo, paths de módulos personalizados, sentencias de requerimientos de módulos, temas de hojas de estilo, uso de CDN, y más.

    Ejemplo 29.6. Usando los Ayudantes de Dojo View

    Para utilizar los ayudantes de vista de Dojo, necesitará decirle a un objeto vista dónde encontrarlos. Puede hacerlo llamando a addHelperPath() :

    $view->addHelperPath('Zend/Dojo/View/Helper/''Zend_Dojo_View_Helper');

    Alternativamente, puede usar el método de Zend_Dojo enableView() para que haga el trabajo por usted:

    Zend_Dojo::enableView($view);

    29.3.1. dojo() Ayudante de Vista

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

    • Especificar bien un CDN o un path local para instalar Dojo.

    • Especificando paths a módulos Dojo personalizados.

    • Especificando sentencias dojo.require.

    • Especificando hojas de estilo dijit a usar.

    • Especificando eventos dojo.addOnLoad().

    La implementación del ayudante de vista dojo() 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 PHP desde su script.

    Ejemplo 29.7. dojo() Ejemplo de Uso del Ayudante de Vista

    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.

    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.

    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:

    $view->addHelperPath('Zend/Dojo/View/Helper/''Zend_Dojo_View_Helper');

    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'.

    <?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'); ?>

    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:

    <?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>

    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!


    [Nota] UTF-8 encoding used by default

    By default, Zend Framework uses UTF-8 as its default encoding, and, specific to this case, Zend_View does as well. Character encoding can be set differently on the view object itself using the setEncoding() method (or the the encoding instantiation parameter). However, since Zend_View_Interface does not define accessors for encoding, it's possible that if you are using a custom view implementation with the Dojo view helper, you will not have a getEncoding() method, which is what the view helper uses internally for determining the character set in which to encode.

    If you do not want to utilize UTF-8 in such a situation, you will need to implement a getEncoding() method in your custom view implementation.

    29.3.1.1. Uso Programático y Declarativo de Dojo

    Dojo permite usar a ambos declarative y programmatic en muchas de sus características. El uso de Declarative utiliza elementos HTML 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.

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

    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 dojo() para su inclusión cuando sean presentados.

    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 permitir esto, así como la posibilidad de usar sintaxis declarativa, hay disponibles una serie de métodos estáticos para establecer globamente este comportamiento.

    Ejemplo 29.8. Especificando el Uso Declarativo y Programático de Dojo

    Para especificar el uso declarativo, simplemente llame al método estático setUseDeclarative() :

    Zend_Dojo_View_Helper_Dojo::setUseDeclarative();

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

    Zend_Dojo_View_Helper_Dojo::setUseProgrammatic();

    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.

    Zend_Dojo_View_Helper_Dojo::setUseProgrammatic(-1);

    29.3.1.2. Temas

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

    $view->dojo()->addStylesheetModule('dijit.themes.tundra');

    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 CSS en ese directorio del tema a usar; en el ejemplo de arriba, Dojo buscará el tema en 'dijit/themes/tundra/tundra.css'.

    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:

    <body class="tundra">

    29.3.1.3. Usando Layers (Construcciones Personalizadas)

    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.

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

    • Grupos de archivos necesarios en layers ; una capa (layer) agrupa a todos archivos necesarios en un único archivo JS. (De ahí el nombre de esta sección.)

    • "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.

    • Pasa el archivo a través de ShrinkSafe, que elimina espacios en blanco y comentarios, así como acorta nombres de variables.

    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 usar una capa, el ayudante de vista dojo() tiene el método addLayer() para añadir paths de capas requeridas:

    $view->dojo()->addLayer('/js/foo/foo.js');

    Para más información sobre la creación de construcciones personalizadas, por favor consulte la docuemntación de Build de Dojo .

    29.3.1.4. Métodos Disponibles

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

    • setView(Zend_View_Interface $view) : establecer una instancia de vista en el contenedor.

    • enable() : habilitar explícitamente la integración de Dojo.

    • disable() : deshabilitar la integración de Dojo.

    • isEnabled() : determinar cuándo la integración de Dojo está habilitada o no.

    • requireModule($module) : establecer una sentencia dojo.require

    • getModules() : determinar qué módulos han sido requeridos.

    • registerModulePath($module, $path) : registrar un path de un módulo personalizado de Dojo.

    • getModulePaths() : obtener la lista de los paths de módulos registrados.

    • addLayer($path) : añadir una capa (construcción personalizada) del path a utilizar.

    • getLayers() : conseguir una lista de todos los paths de capas registrados (construcción personalizada).

    • removeLayer($path) : eliminar la capa que concuerde con $path de la lista de capas registradas (construcción personalizada).

    • setCdnBase($url) : establecer la URL base para un CDN; típicamente, una de las Zend_Dojo::CDN_BASE_AOL o Zend_Dojo::CDN_BASE_GOOGLE , pero sólo necesita ser el string del URL antes del número de versión.

    • getCdnBase() : recuperar el CDN de la url base a utilizar.

    • setCdnVersion($version = null) : establecer cuál es la versión de Dojo a utilizar desde el CDN.

    • getCdnVersion() : recuperar que versión de Dojo será utilizada desde el CDN.

    • setCdnDojoPath($path) : establecer el path relativo a un archivo dojo.js o dojo.xd.js sobre un CDN; típicamente, uno de los Zend_Dojo::CDN_DOJO_PATH_AOL o Zend_Dojo::CDN_DOJO_PATH_GOOGLE , pero sólo debe ser el string del path detrás del número de versión.

    • getCdnDojoPath() : recuperar el último segmento del path del CDN de la url apuntando al archivo dojo.js.

    • useCdn() : decirle al contenedor que utilice el CDN; implícitamente permite integración.

    • setLocalPath($path) : 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.

    • getLocalPath() : determinar qué ruta local a Dojo está siendo utilizada.

    • useLocalPath() : ¿la integración está utilizando un path local de Dojo?

    • setDjConfig(array $config) : conjunto de valores de configuración dojo/dijit (espera un array asociativo).

    • setDjConfigOption($option, $value) : establecer un único valor de configuración para dojo/dijit.

    • getDjConfig() : obtener todos los valores de configuración de dojo/dijit.

    • getDjConfigOption($option, $default = null) : conseguir un único valor de configuración de dojo/dijit.

    • addStylesheetModule($module) : agregar una hoja de estilo sobre la base del tema de un módulo.

    • getStylesheetModules() : obtener hojas de estilo registradas como temas de módulos.

    • addStylesheet($path) : agregar una hoja de estilo local para su uso con Dojo.

    • getStylesheets() : obtener hojas de estilo locales Dojo.

    • addOnLoad($spec, $function = null) : 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.

    • prependOnLoad($spec, $function = null) : exactamente como addOnLoad() , excluyendo agregar al principio el comienzo de onLoad stack.

    • getOnLoadActions() : recuperar todas las acciones dojo.onLoad registradas con el contenedor. Esto será un array de arrays.

    • onLoadCaptureStart($obj = null) : 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.

    • onLoadCaptureEnd($obj = null) : finalizar la captura de datos para su uso con dojo.onLoad().

    • javascriptCaptureStart() : captura javascript arbitrario para ser incluido en Dojo JS (onLoad, require, etc. statements).

    • javascriptCaptureEnd() : finalizar la captura de javascript.

    • __toString() : emitir el contenedor a un string; muestra todo el estilo HTML y elementos del script.

    29.3.2. Ayudantes de Vistas Específicos de Dijit

    Del manual de Dojo: "Dijit es un sistema de widgets estratificados encima de dojo". Dijit incluye una variedad de diseños y forms de widgets diseñados para proporcionar características de accesibilidad, localización, y un look-and-feel estandarizado (y temable).

    Zend Framework viene con una variedad de ayudantes de vista que le permiten suministrar y utilizar dijits dentro de sus scripts de vista. Hay tres tipos básicos:

    • Layout Containers : estos están diseñados para ser utilizados dentro de sus scripts de vista o consumidos por los decoradores de forms, para forms, sub forms, y mostrar grupos. Envuelven las distintas clases ofrecidas en dijit.layout. Cada ayudante de vista dijit layout espera los siguientes argumentos:

      • $id : el nombre del contenedor o el DOM ID.

      • $content : el contenido a envolver en el contenedor esquematizado.

      • $params (opcional): parámetros específicos de dijit. Básicamente, cualquier atributo no HTML que pueda utilizarse para configurar el esquema del contenedor dijit.

      • $attribs (optional): cualquier de los otros atributos HTML que deberían utilizarse para mostrar el contenedor div. Si se pasa la clave 'id' en este array, será utilizada para el elemento DOM id del form, y $id será utilizado por su nombre.

      Si no pasa argumentos a un ayudante de vista de esquemas dijit, el ayudante mismo será devuelto. Esto le permite capturar contenido, que a menudo es una manera más fácil para pasar contenido al esquema del contenedor. Ejemplos de esta funcionalidad se mostrarán más tarde en esta sección.

    • Form Dijit : el dijit dijit.form.Form, aunque no es completamente necesario para su uso con elementos de dijit forms, se asegurará de que si hay un intento de enviar un form que no valide contra las validaciones del lado del cliente, se detendrá el envío y se emitirán mensajes de error de validación. El ayudante de vista dijit espera los siguientes argumentos:

      • $id : el nombre del contenedor o el DOM ID.

      • $attribs (opcional): cualquier otro de los atributos HTML que deberían ser utilizados para mostrar el div del contenedor.

      • $content (opcional): el contenido a envolver en el form. Si no se pasa ninguno, se utilizará un string vacío.

      El orden de los argumentos varía de los demás dijits a fin de mantener la compatibilidad con el standard form() del ayudante de vista.

    • Elementos del Form : éstos están diseñados para ser consumidos con Zend_Form , pero pueden ser utilizados standalone también en sus scripts de vista. Cada elemento de ayudante de vista dijit espera los siguientes argumentos:

      • $id : el nombre del elemento o el DOM ID.

      • $value (opcional): el valor actual de ese elemento.

      • $params (opcional): parámetros específicos de dijit. Básicamente, cualquier atributo no HTML que pueda utilizarse para configurar un dijit.

      • $attribs (opcional): cualquiera de los otros atributos adicionales HTML que deberían ser utilizados para mostrar el dijit. Si se pasa la clave 'id' en este array, será utilizado por el elemento DOM id del form, y $id será utilizado por su nombre.

      Algunos de los elementos requieren más argumentos; esto se observó con el elemento individual ayudante de descripciones.

    Con el fin de utilizar estos ayudantes de vista, necesita registrar el path a los ayudantes de vista dojo con su objeto vista.

    Ejemplo 29.9. Registrando el Prefijo del Path al Ayudante de Vista de Dojo

    $view->addHelperPath('Zend/Dojo/View/Helper''Zend_Dojo_View_Helper');

    29.3.2.1. Elementos del Esquema Dijit

    La familia de elementos dijit.layout son para crear esquemas personalizados y previsibles para su sitio. Para cualquier pregunta sobre el uso general, lea más sobre ellos en el manual de Dojo .

    Todos los elementos de los esquemas dijit tienen la firma string ($id = null, $content = '', array $params = array(), array $attribs = array()) . En todos los casos, si no pasa argumentos, será devuelto el mismo objeto ayudante. Esto le da acceso a los métodos captureStart() y captureEnd() , que permiten capturar contenido en lugar de pasarlo al esquema del contenedor.

    • AccordionContainer : dijit.layout.AccordionContainer. Apilará todos los cuadros juntos verticalmente; con un click en la barra del título de un cuadro, se expandirá y mostrará ese cuadro en particular.

      <?php echo $view->accordionContainer(
          
      'foo',
          
      $content,
          array(
              
      'duration' => 200,
          ),
          array(
              
      'style' => 'width: 200px; height: 300px;',
          ),
      ); 
      ?>
    • AccordionPane : dijit.layout.AccordionPane. Para su uso en AccordionContainer.

      <?php echo $view->accordionPane(
          
      'foo',
          
      $content,
          array(
              
      'title' => 'Pane Title',
          ),
          array(
              
      'style' => 'background-color: lightgray;',
          ),
      ); 
      ?>
    • BorderContainer : dijit.layout.BorderContainer. Logra diseños con cuadros opcionalmente redimensionables como se puede ver en una aplicación tradicional.

      <?php echo $view->borderContainer(
          
      'foo',
          
      $content,
          array(
              
      'design' => 'headline',
          ),
          array(
              
      'style' => 'width: 100%; height: 100%',
          ),
      ); 
      ?>
    • ContentPane : dijit.layout.ContentPane. Usarlo dentro de cualquier contenedor excepto AccordionContainer.

      <?php echo $view->contentPane(
          
      'foo',
          
      $content,
          array(
              
      'title'  => 'Pane Title',
              
      'region' => 'left',
          ),
          array(
              
      'style' => 'width: 120px; background-color: lightgray;',
          ),
      ); 
      ?>
    • SplitContainer : dijit.layout.SplitContainer. Permite cuadros de contenido redimensionables, discontinuado en Dojo en favor de BorderContainer.

      <?php echo $view->splitContainer(
          
      'foo',
          
      $content,
          array(
              
      'orientation'  => 'horizontal',
              
      'sizerWidth'   => 7,
              
      'activeSizing' => true,
          ),
          array(
              
      'style' => 'width: 400px; height: 500px;',
          ),
      ); 
      ?>
    • StackContainer : dijit.layout.StackContainer. Todos los cuadros dentro de un StackContainer se colocan en una pila; crea botones o funcionalidades a ser revelados uno a uno.

      <?php echo $view->stackContainer(
          
      'foo',
          
      $content,
          array(),
          array(
              
      'style' => 'width: 400px; height: 500px; border: 1px;',
          ),
      ); 
      ?>
    • TabContainer : dijit.layout.TabContainer. Todos los cuadros dentro de un TabContainer se colocan en una pila, con pestañas colocadas a un lado para cambiar entre ellos.

      <?php echo $view->tabContainer(
          
      'foo',
          
      $content,
          array(),
          array(
              
      'style' => 'width: 400px; height: 500px; border: 1px;',
          ),
      ); 
      ?>

    Los siguientes métodos de captura están disponibles para todos los esquemas de contenedores:

    • captureStart($id, array $params = array(), array $attribs = array()) : inicia la captura del contenido a incluir en un contenedor. $params hace referencia a dijit params para utilizar con el contenedor, mientras que $attribs se refiere a cualquier atributo general HTML a utilizar.

      Los contenedores pueden estar anidados durante la captura, mientras no hayan IDs duplicados .

    • captureEnd($id) : finalizar la captura del contenido a incluir en un contenedor. $id debe referirse a un id anteriormente utilizado con la llamada captureStart() . Regresa el string representando al contenedor y su contenido, como si simplemente pasara el contenido al ayudante mismo.

    Ejemplo 29.10. Ejemplo de esquema de BorderContainer dijit

    Los BorderContainers, particularmente cuando junto a la capacidad de capturar contenido, son útiles especialmente para lograr efectos complejos de diseño.

    $view->borderContainer()->captureStart('masterLayout',
                                           array(
    'design' => 'headline'));

    echo 
    $view->contentPane(
        
    'menuPane',
        
    'This is the menu pane',
        array(
    'region' => 'top'),
        array(
    'style' => 'background-color: darkblue;')
    );

    echo  
    $view->contentPane(
        
    'navPane',
        
    'This is the navigation pane',
        array(
    'region' => 'left'),
        array(
    'style' => 'width: 200px; background-color: lightblue;')
    );

    echo 
    $view->contentPane(
        
    'mainPane',
        
    'This is the main content pane area',
        array(
    'region' => 'center'),
        array(
    'style' => 'background-color: white;')
    );

    echo 
    $view->contentPane(
        
    'statusPane',
        
    'Status area',
        array(
    'region' => 'bottom'),
        array(
    'style' => 'background-color: lightgray;')
    );

    echo 
    $view->borderContainer()->captureEnd('masterLayout');

    29.3.2.2. Elementos de Dijit Form

    la validación de forms en Dojo y los dijits de entrada están en dijit.form.tree. Para más información sobre la utilización de estos elementos, así como los parámetros aceptados, por favor vea la docuemntación de dijit.form .

    Los siguientes elementos de dijit form están disponibles en Zend Framework. Excepto cuando se señaló que todos tienen la firma string ($id,$value = '', array $params = array(), array $attribs = array()) .

    • Button : dijit.form.Button. Muestra un botón de form.

      <?php echo $view->button(
          
      'foo',
          
      'Show Me!',
          array(
      'iconClass' => 'myButtons'),
      ); 
      ?>
    • CheckBox : dijit.form.CheckBox. Muestra un checkbox. Acepta opcionalmente un quinto argumento, el array $checkedOptions , que puede contener:

      • un array indexado con dos valores, un valor verificado y otro no, en ese orden; o

      • un array asociativo con las claves 'checkedValue' y 'unCheckedValue'.

      Si $checkedOptions no fueron suministradas, se asume 1 y 0.

      <?php echo $view->checkBox(
          
      'foo',
          
      'bar',
          array(),
          array(),
          array(
      'checkedValue' => 'foo''unCheckedValue' => 'bar')
      ); 
      ?>
    • ComboBox : dijit.layout.ComboBox. Los ComboBoxes son un híbrido entre un cuadro de selección y uno de texto con autocompletado. La diferencia fundamental es que puede escribir una opción que no está en la lista de las opciones disponibles, y que todavía considera válido el input. Opcionalmente acepta un quinto argumento, un array asociativo $options ; si lo hay, ComboBox será presentado como un select . Note también que la label values del array $options será devuelto al form -- y no los valores en si mismos.

      Alternativamente, puede pasar información sobre un datastrore dojo.data para utilizar con el elemento. Si la hay, el ComboBox será presentado como un texto input , y traerá sus opciones vía ese datastore.

      Para especificar un datastore, proporcionar una de las siguientes $params combinaciones de claves:

      • La clave 'store', con un valor de array; el array debe contener las claves:

        • store : el nombre de la variable javascript representando el datastore (este podría ser el nombre que desea para su uso).

        • type : el tipo de datastore a usar; e.g., 'dojo.data.ItemFileReadStore'.

        • params (opcional): un array asociativo de pares clave/valor a utilizar para configurar el datastore. El 'url' param es un ejemplo típico.

      • Las claves:

        • store : un string indicando el nombre del datastore a usar.

        • storeType : un string indicando el tipo de datastore dojo.data a usar (e.g., 'dojo.data.ItemFileReadStore').

        • storeParams : un array asociativo de pares clave/valor con los cuales configurar el datastore.

      // Como un elemento select:
      echo $view->comboBox(
          
      'foo',
          
      'bar',
          array(
              
      'autocomplete' => false,
          ),
          array(),
          array(
              
      'foo' => 'Foo',
              
      'bar' => 'Bar',
              
      'baz' => 'Baz',
          )
      );

      // Como en elemento habilitado de dojo.data:
      echo $view->comboBox(
          
      'foo',
          
      'bar',
          array(
              
      'autocomplete' => false,
              
      'store'        => 'stateStore',
              
      'storeType'    => 'dojo.data.ItemFileReadStore',
              
      'storeParams'  => array('url' => '/js/states.json'),
          ),
      );
    • CurrencyTextBox : dijit.form.CurrencyTextBox. Se hereda de ValidationTextBox, y proporciona validación de moneda del lado del cliente. Se espera que el parámetro dijit 'currency' será siempre proporcionado con el código adecuado de 3 caracteres de la moneda. También puede especificar cualquiera de los parámetros dijit válidos para ValidationTextBox y TextBox.

      echo $view->currencyTextBox(
          
      'foo',
          
      '$25.00',
          array(
      'currency' => 'USD'),
          array(
      'maxlength' => 20)
      );
      [Nota] Cuestiones con la Construcción

      Actualmente hay problemas conocidos con el uso de CurrencyTextBox en la construcción de capas . Una conocida solución alternativa es garantizar que el meta tag Content-Type de http-equiv en su documento esté establecido al conjunto de caracteres utf-8, que puede hacerlo llamando a:

      $view->headMeta()->appendHttpEquiv('Content-Type',
                                         
      'text/html; charset=utf-8');

      Por supuesto, esto significa que necesitará para garantizar que el marcador de posición headMeta() esté dentro de una sentencia "echo" de PHP en su script.

    • DateTextBox : dijit.form.DateTextBox. Es heredada de ValidationTextBox, y ofrece tanto validación de fechas de lado del cliente, así como un calendario desplegable desde el cual elegir una fecha. Puede especificar cualquiera de los parámetros dijit disponibles para ValidationTextBox o TextBox.

      echo $view->dateTextBox(
          
      'foo',
          
      '2008-07-11',
          array(
      'required' => true)
      );
    • Editor : dijit.Editor. Proporciona un editor WYSIWYG mediante el cual los usuarios pueden crear o editar el contenido. dijit.Editor es un editor pluggable y extensible, con una variedad de parámetros que puede utilizar para personalización; para más detalles vea la documentación de dijit.Editor .

      echo $view->editor('foo');
      [Nota] Editor Dijit uses div by default

      The Editor dijit uses an HTML DIV by default. The dijit._editor.RichText documentation indicates that having it built on an HTML TEXTAREA can potentially have security implications.

      In order to allow graceful degradation in environments where Javascript is unavailable, Zend_Dojo_View_Helper_Editor also wraps a textarea within a noscript tag; the content of this textarea will be properly escaped to avoid security vulnerability vectors.

    • FilteringSelect : dijit.form.FilteringSelect. Similar a ComboBox, este es un híbrido de select/text que puede hacer una lista de opciones o aquellos retornados vía un dojo.data datastore. A diferencia de ComboBox, sin embargo, FilteringSelect no permite escribir una opción ni siquieraen en su lista. Además, opera como un select standard en que los valores de opción, no las etiquetas, son devueltos cuando el form se envía.

      Por favor vea la información anterior sobre ComboBox para ejemplos y las opciones disponibles para definir datastores.

    • HorizontalSlider y VerticalSlider : dijit.form.HorizontalSlider y dijit.form.VerticalSlider. Los sliders permiten a los widgets de UI seleccionar números en un rango dado; las variantes son horizontales y verticales.

      En lo más elemental, exigen los parámetros dijit 'minimum', 'maximum', y 'discreteValues'. Estos definen el rango de valores. Otras opciones comunes son las siguientes:

      • 'intermediateChanges' se puede ajustar para indicar cuando disparar o no eventos onChange mientras el handler está siendo arrastrado.

      • 'clickSelect' se establece para permitir hacer click en un lugar del deslizador para ajustar el valor.

      • 'pageIncrement' puede especificar el valor de aumento/decremento cuando se utilizan pageUp y pageDown.

      • 'showButtons' se puede ajustar para permitir ver los botones de ambos extremos del deslizador para manipular el valor.

      La implementación de Zend Framework crea un elemento oculto para guardar el valor del deslizador.

      Opcionalmente puede desear mostrar una regla o etiquetas para el deslizador. Para hacerlo, se asignará uno o más de los parámetros dijit 'topDecoration' y/o 'bottomDecoration' (HorizontalSlider) o 'leftDecoration' y/o 'rightDecoration' (VerticalSlider). Cada uno de éstos espera las siguientes opciones:

      • container : nombre del contenedor.

      • labels (opcional): un array de etiquetas a utilizar. Use strings vacíos en cualquiera de los extremos para dotar de etiquetas solamente a los valores internos. Es necesario cuando se especifica uno de las variantes dijit 'Labels'.

      • dijit (opcional): uno de los siguientes será por defecto la dijits Rule (regla) HorizontalRule, HorizontalRuleLabels, VerticalRule, o VerticalRuleLabels.

      • params (opcional): los dijit params son para configurar la Regla dijit en uso. Los parámetros específicos de estos dijits incluyen:

        • container (opcional): array de parámetros y atributos para el contenedor de la regla.

        • labels (opcional): array de parámetros y atributos para el contenedor de la lista de etiquetas.

      • attribs (opcional): atributos HTML para utilizar con las reglas/etiquetas. Esto debería seguir el formato de opción params y ser un array asociativo con las claves 'container' y 'labels'.

      echo $view->horizontalSlider(
          
      'foo',
          
      1,
          array(
              
      'minimum'             => -10,
              
      'maximum'             => 10,
              
      'discreteValues'      => 11,
              
      'intermediateChanges' => true,
              
      'showButtons'         => true,
              
      'topDecoration'       => array(
                  
      'container' => 'topContainer'
                  'dijit'     
      => 'HorizontalRuleLabels',
                  
      'labels'    => array(
                      
      ' ',
                      
      '20%',
                      
      '40%',
                      
      '60%',
                      
      '80%',
                      
      ' ',
                  ),
                  
      'params' => array(
                      
      'container' => array(
                          
      'style' => 'height:1.2em; font-size=75%;color:gray;',
                      ),
                      
      'labels' => array(
                          
      'style' => 'height:1em; font-size=75%;color:gray;',
                      ),
                  ),
              ),
              
      'bottomDecoration'    => array(
                  
      'container' => 'bottomContainer'
                  'labels'    
      => array(
                      
      '0%',
                      
      '50%',
                      
      '100%',
                  ),
                  
      'params' => array(
                      
      'container' => array(
                          
      'style' => 'height:1.2em; font-size=75%;color:gray;',
                      ),
                      
      'labels' => array(
                          
      'style' => 'height:1em; font-size=75%;color:gray;',
                      ),
                  ),
              ),
          )
      );
    • NumberSpinner : dijit.form.NumberSpinner. Text box numérico para entrada, con botones para incremento y decremento.

      Espera bien un array asociativo del parámetro dijit 'constraints' o simplemente las claves 'min', 'max', y 'places' (estas serían también las entradas esperadas del parámetro de restricciones). 'places' puede ser utilizada para indicar en cuánto se incrementará y decrementará el número giratorio.

      echo $view->numberSpinner(
          
      'foo',
          
      5,
          array(
              
      'min'    => -10,
              
      'max'    => 10,
              
      'places' => 2,
          ),
          array(
              
      'maxlenth' => 3,
          )
      );
    • NumberTextBox : dijit.form.NumberTextBox. NumberTextBox ofrece la capacidad de dar formato y mostrar entradas numéricas de una manera localizada, así como validar entradas numéricas, opcionalmente en contra de las restricciones dadas.

      echo $view->numberTextBox(
          
      'foo',
          
      5,
          array(
              
      'places' => 4,
              
      'type'   => 'percent',
          ),
          array(
              
      'maxlength' => 20,
          )
      );
    • PasswordTextBox : dijit.form.ValidationTextBox está atada a una contraseña. PasswordTextBox ofrece la posibilidad de crear una entrada para contraseña que adhiere al actual tema dijit, así como permitir la validación del lado del cliente.

      echo $view->passwordTextBox(
          
      'foo',
          
      '',
          array(
              
      'required' => true,
          ),
          array(
              
      'maxlength' => 20,
          )
      );
    • RadioButton : dijit.form.RadioButton. Una serie de opciones entre las que sólo una puede ser seleccionada. Esta se comporta en todos los sentidos como una de radio normal, pero tiene un look-and-feel consistente con otros dijits.

      RadioButton acepta un cuarto argumento como opción, $options , un array asociativo de pares valor/etiqueta utilizado como opciones de radio. También puede pasar estos como la clave options de $attribs .

      echo $view->radioButton(
          
      'foo',
          
      'bar',
          array(),
          array(),
          array(
              
      'foo' => 'Foo',
              
      'bar' => 'Bar',
              
      'baz' => 'Baz',
          )
      );
    • SimpleTextarea : dijit.form.SimpleTextarea. Estos actuarán como textareas normales, pero se estilizan usando el tema actual de dijit. No necesita especificar los atributos ya sea de las filas o de las columnas; use ems o porcentajes del ancho y del alto en su lugar.

      echo $view->simpleTextarea(
          
      'foo',
          
      'Start writing here...',
          array(),
          array(
      'style' => 'width: 90%; height: 5ems;')
      );
    • SubmitButton : un dijit.form.Button está atado a un elemento de entrada a enviar. Vea el ayudante de vista de Button para más detalles; la diferencia fundamental es que este botón puede enviar un form.

    • Textarea : dijit.form.Textarea. Éstas actuarán como textareas normales, salvo que en lugar de un determinado número de filas, se expanden a medida que el usuario tipea. El ancho debe especificarse mediante una regla de estilo.

      echo $view->textarea(
          
      'foo',
          
      'Start writing here...',
          array(),
          array(
      'style' => 'width: 300px;')
      );
    • TextBox : dijit.form.TextBox. Este elemento está presente principalmente para proporcionar un look-and-feel común entre los diversos elementos dijit, y a ofrecer funcionalidades de base para otras clases derivadas de TextBox (ValidationTextBox, NumberTextBox, CurrencyTextBox, DateTextBox, y TimeTextBox).

      El parámetro común de dijit para los flags incluyen 'lowercase' (emitido a minúsculas), 'uppercase' (emitido a mayúsculas), 'propercase' (emitido a Proper Case), y trim (elimina los espacios en blanco iniciales y finales); todos aceptan valores booleanos. Además, puede especificar los parámetros 'size' y 'maxLength'.

      echo $view->textBox(
          
      'foo',
          
      'some text',
          array(
              
      'trim'       => true,
              
      'propercase' => true,
              
      'maxLength'  => 20,
          ),
          array(
              
      'size' => 20,
          )
      );
    • TimeTextBox : dijit.form.TimeTextBox. También de la familia TextBox, TimeTextBox proporciona una selección desplazable drop down de la cantidad de veces que un usuario podrá seleccionar. Los parámetros Dijit le permiten especificar el tiempo disponible para incrementos en el select así como un rango visible de veces en disponibilidad.

      echo $view->timeTextBox(
          
      'foo',
          
      '',
          array(
              
      'am.pm'            => true,
              
      'visibleIncrement' => 'T00:05:00'// 5-minute increments
              
      'visibleRange'     => 'T02:00:00'// show 2 hours of increments
          
      ),
          array(
              
      'size' => 20,
          )
      );
    • ValidationTextBox : dijit.form.ValidateTextBox. Proporciona validaciones del lado del cliente para un elemento de texto. Se hereda desde TextBox.

      Los parámetros comunes de dijit incluyen:

      • invalidMessage : un mensaje para mostrar cuando se ha detectado una entrada inválida.

      • promptMessage : un mensaje tooltip de ayuda a utilizar.

      • regExp : una expresión regular a utilizar para validar el texto. La Expresión Regular no requiere de marcadores de límites.

      • required : si el elemento es necesario o no. Si fuera necesario, y el elemento está incrustado en un dijit.form.Form, será marcado como inválido y no se enviará.

      echo $view->validationTextBox(
          
      'foo',
          
      '',
          array(
              
      'required' => true,
              
      'regExp'   => '[\w]+',
              
      'invalidMessage' => 'No se permiten espacios o caracteres especiales',
              
      'promptMessage'  => 'Una palabra consiste de caracteres  ' .
                                  
      'alfanuméricos y underscores solamente',
          ),
          array(
              
      'maxlength' => 20,
          )
      );

    29.3.2.3. Dijits Personalizados

    Si ahonda mucho en Dojo, se encontrará escribiendo bastantes dijits personalizados, o utilizando dijits experimentales de Dojox. Si bien Zend Framework no puede apoyar a todos los dijit directamente, si proporciona algún apoyo rudimentario para tipos dijit arbitrarios vía el ayudante de vista CustomDijit .

    La API del ayudante de vista CustomDijit es exactamente lo que cualquier otro dijit es, con una diferencia importante: el tercer argumento de "params" debe contener el atributo "dojotype". El valor de este atributo debe ser la clase Dijit que planea usar.

    CustomDijit extiende la base del ayudante de vista DijitContainer , que también le permite capturar el contenido (utilizando el par de métodos captureStart() / captureEnd() ). captureStart() también espera que pase el atributo "dojoType" a su argumento "params".

    Ejemplo 29.11. Usando CustomDijit para mostrar un dojox.layout.ContentPane

    dojox.layout.ContentPane es la siguiente generación de iteración de dijit.layout.ContentPane , y proporciona un superconjunto de capacidades de esa clase. Hasta que la funcionalidad se estabilice, seguirá viviendo en Dojox. Sin embargo, si quiere utilizarlo hoy en Zend Framework, puede hacerlo, utilizando el ayudante de vista CustomDijit .

    Para lo más básico, puede hacer lo siguiente:

    <?php echo $this->customDijit(
        
    'foo',
        
    $content,
        array(
            
    'dojoType' => 'dojox.layout.ContentPane',
            
    'title'    => 'Custom pane',
            
    'region'   => 'center'
        
    )
    ); 
    ?>

    Si quiere capturar el contenido en su lugar, simplemente use el método captureStart() , y pase el "DojoType" al argumento de "params":

    <?php $this->customDijit()->captureStart(
        
    'foo',
        array(
            
    'dojoType' => 'dojox.layout.ContentPane',
            
    'title'    => 'Custom pane',
            
    'region'   => 'center'
        
    )
    ); 
    ?>
    This is the content of the pane
    <?php echo $this->customDijit()->captureEnd('foo'); ?>

    Fácilmente puede extender también CustomDijit para crear apoyo para sus propios dijits personalizados. Como ejemplo, si extiende dijit.layout.ContentPane para crear su propia clase foo.ContentPane , puede crear el siguiente ayudante de apoyo:

    class My_View_Helper_FooContentPane
        
    extends Zend_Dojo_View_Helper_CustomDijit
    {
        protected 
    $_defaultDojoType 'foo.ContentPane';

        public function 
    fooContentPane(
            
    $id null$value null,
            array 
    $params = array(), array $attribs = array()
        ) {
            return 
    $this->customDijit($id$value$params$attribs);
        }
    }

    Mientras que su dijit personalizado siga la misma base API que los dijits oficiales, utilizar o extender CustomDijit debería funcionar correctamente.


    digg delicious meneame google twitter technorati facebook

    Comentarios

    Loading...