Agrupan los archivos requeridos en capas; una capa junta todos los archivos requeridos en un único archivo JS. (De ahí el nombre de esta sección.)

"Internaliza" archivos no javascript usados por dijits (típicamente, archivos de plantilla). Estos también se agrupan en el mismo archivo JS que la capa.

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

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

enable(): habilita explícitamente la integración con Dojo.

disable(): deshabilita la integración con Dojo.

isEnabled(): determina si la integración con Dojo está habilitada o no.

requireModule($module): configura una sentencia dojo.require.

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

registerModulePath($module, $path): registra una ruta de módulo Dojo personalizada.

getModulePaths(): obtiene la lista de rutas de módulos registradas.

addLayer($path): agrega una ruta de capa (build personalizado) a usar.

getLayers(): obtiene una lista de todas las rutas de capa registradas (builds personalizados).

removeLayer($path): elimina la capa que coincide con $path de la lista de capas registradas (builds personalizados).

setCdnBase($url): establece la URL base para un CDN; típicamente, una de Zend_Dojo::CDN_BASE_AOL o Zend_Dojo::CDN_BASE_GOOGLE, pero solo necesita ser la cadena URL anterior al número de versión.

getCdnBase(): recupera la CDN url base a utilizar.

setCdnVersion($version = null): establece qué versión de Dojo utilizar desde el CDN.

getCdnVersion(): recupera qué versión de Dojo desde el CDN se utilizará.

setCdnDojoPath($path): establece la ruta relativa al archivo dojo.js o dojo.xd.js en un CDN; típicamente, una de Zend_Dojo::CDN_DOJO_PATH_AOL o Zend_Dojo::CDN_DOJO_PATH_GOOGLE, pero solo necesita ser la cadena de ruta que sigue al número de versión.

getCdnDojoPath(): recupera el último segmento de ruta de la url del CDN que apunta al archivo dojo.js.

useCdn(): indica al contenedor que utilice el CDN; habilita implícitamente la integración.

setLocalPath($path): indica al contenedor la ruta a una instalación local de Dojo (debería ser una ruta relativa al servidor, y contener el propio archivo dojo.js); habilita implícitamente la integración.

getLocalPath(): determina qué ruta local de Dojo se está utilizando.

useLocalPath(): ¿está la integración utilizando una ruta local de Dojo?

setDjConfig(array $config): establece valores de configuración de dojo o dijit (espera un array asociativo).

setDjConfigOption($option, $value): establece un único valor de configuración de dojo o dijit.

getDjConfig(): obtiene todos los valores de configuración de dojo o dijit.

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

addStylesheetModule($module): agrega una hoja de estilo basada en un tema de módulo.

getStylesheetModules(): obtiene las hojas de estilo registradas como temas de módulo.

addStylesheet($path): agrega una hoja de estilo local para usar con Dojo.

getStylesheets(): obtiene las hojas de estilo locales de Dojo.

addOnLoad($spec, $function = null): agrega una lambda para que dojo.onLoad la llame. Si se pasa un argumento, se asume que es o bien el nombre de una función o un closure de javascript. Si se pasan dos argumentos, se asume que el primero es el nombre de una variable de instancia de objeto y el segundo o bien un nombre de método en ese objeto o un closure a utilizar con ese objeto.

prependOnLoad($spec, $function = null): exactamente igual que addOnLoad(), excepto que antepone al inicio de la pila de onLoad.

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

onLoadCaptureStart($obj = null): captura datos para usar como una lambda para dojo.onLoad(). Si se proporciona $obj, el código JS capturado se considerará un closure para usar con ese objeto Javascript.

onLoadCaptureEnd($obj = null): finaliza la captura de datos para usar con dojo.onLoad().

javascriptCaptureStart(): captura javascript arbitrario para incluir con el JS de Dojo (sentencias onLoad, require, etc.).

javascriptCaptureEnd(): finaliza la captura de javascript.

__toString(): convierte el contenedor a una cadena; renderiza todos los elementos HTML de estilo y script.

AccordionContainer: dijit.layout.AccordionContainer. Apila todos los paneles juntos verticalmente; hacer clic en el título de un panel expandirá y mostrará ese panel en particular.

<?php echo $view->accordionContainer(
    'foo',
    $content,
    array(
        'duration' => 200,
    ),
    array(
        'style' => 'width: 200px; height: 300px;',
    ),
); ?>

AccordionPane: dijit.layout.AccordionPane. Para usar dentro de AccordionContainer.

<?php echo $view->accordionPane(
    'foo',
    $content,
    array(
        'title' => 'Pane Title',
    ),
    array(
        'style' => 'background-color: lightgray;',
    ),
); ?>

BorderContainer: dijit.layout.BorderContainer. Logre layouts con paneles opcionalmente redimensionables como los que podría 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. Úselo 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 paneles de contenido redimensionables; obsoleto en Dojo a 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 paneles dentro de un StackContainer se colocan en una pila; construya botones o funcionalidad para mostrar uno a la vez.

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

TabContainer: dijit.layout.TabContainer. Todos los paneles dentro de un TabContainer se colocan en una pila, con pestañas posicionadas en un lado para cambiar entre ellos.

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

captureStart($id, array $params = array(), array $attribs = array());: comienza a capturar contenido para incluir en un contenedor. $params se refiere a los parámetros dijit a usar con el contenedor, mientras que $attribs se refiere a cualquier atributo HTML general a usar.

Los contenedores pueden anidarse al capturar, siempre que no se dupliquen ids.

captureEnd($id): finaliza la captura de contenido para incluir en un contenedor. $id debería referirse a un id usado previamente con una llamada a captureStart(). Devuelve una cadena que representa el contenedor y su contenido, tal como si simplemente hubiera pasado contenido al ayudante mismo.

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

<?php echo $view->button(
    'foo',
    'Show Me!',
    array('iconClass' => 'myButtons'),
); ?>

CheckBox: dijit.form.CheckBox. Muestra una casilla de verificación. Acepta un quinto argumento opcional, el array $checkedOptions, que puede contener ya sea:

Si no se proporciona $checkedOptions, se asumen 1 y 0.

<?php echo $view->checkBox(
    'foo',
    'bar',
    array(),
    array(),
    array('checkedValue' => 'foo', 'unCheckedValue' => 'bar')
); ?>

ComboBox: dijit.layout.ComboBox. Los ComboBox son un híbrido entre un select y un cuadro de texto con autocompletado. La diferencia clave es que puede escribir una opción que no esté en la lista de opciones disponibles, y aun así se considerará una entrada válida. Acepta un quinto argumento opcional, un array asociativo $options; si se proporciona, ComboBox se renderizará como un select. Note también que los valores de etiqueta del array $options se devolverán en el formulario -- no los valores mismos.

Alternativamente, puede pasar información sobre un almacén de datos dojo.data para usar con el elemento. Si se proporciona, el ComboBox se renderizará como un input de texto, y obtendrá sus opciones a través de ese almacén de datos.

Para especificar un almacén de datos, proporcione una de las siguientes combinaciones de claves de $params:

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

// As a dojo.data-enabled element:
echo $view->comboBox(
    'foo',
    'bar',
    array(
        'autocomplete' => false,
        'store'        => 'stateStore',
        'storeType'    => 'dojo.data.ItemFileReadStore',
        'storeParams'  => array('url' => '/js/states.json'),
    ),
);

CurrencyTextBox: dijit.form.CurrencyTextBox. Hereda de ValidationTextBox, y proporciona validación del lado del cliente de moneda. Espera que se proporcione el parámetro dijit 'currency' con un código de moneda apropiado de 3 caracteres. También puede especificar cualquier parámetro dijit válido para ValidationTextBox y TextBox.

echo $view->currencyTextBox(
    'foo',
    '$25.00',
    array('currency' => 'USD'),
    array('maxlength' => 20)
);

Problemas con los builds

Actualmente hay problemas conocidos con el uso de CurrencyTextBox con capas de build. Una solución alternativa conocida es asegurarse de que la meta etiqueta http-equiv Content-Type de su documento establezca el conjunto de caracteres a utf-8, lo que puede hacer llamando a: $view->headMeta()->appendHttpEquiv('Content-Type', 'text/html; charset=utf-8'); Esto significará, por supuesto, que necesitará asegurarse de que el placeholder headMeta() se muestre en su script de layout.

DateTextBox: dijit.form.DateTextBox. Hereda de ValidationTextBox, y proporciona tanto validación del lado del cliente de fechas, como un calendario desplegable desde el cual seleccionar una fecha. Puede especificar cualquier parámetro dijit disponible 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 contenido. dijit.Editor es un editor conectable y extensible con una variedad de parámetros que puede utilizar para personalización; vea la documentación de dijit.Editor para más detalles.

echo $view->editor('foo');

El dijit Editor usa div por defecto

El dijit Editor usa un DIV HTML por defecto. La documentación de dijit._editor.RichText indica que construirlo sobre un TEXTAREA HTML puede potencialmente tener implicaciones de seguridad. Para permitir una degradación elegante en entornos donde Javascript no está disponible, Zend_Dojo_View_Helper_Editor también envuelve un TEXTAREA dentro de una etiqueta NOSCRIPT; el contenido de este TEXTAREA será escapado correctamente para evitar vectores de vulnerabilidad de seguridad.

FilteringSelect: dijit.form.FilteringSelect. Similar a ComboBox, este es un híbrido de select y texto que puede renderizar ya sea una lista proporcionada de opciones o las obtenidas a través de un almacén de datos dojo.data. A diferencia de ComboBox, sin embargo, FilteringSelect no permite escribir una opción que no esté en su lista. Además, opera como un select estándar en el sentido de que se devuelven los valores de las opciones, no las etiquetas, cuando se envía el formulario.

Por favor vea la información anterior sobre ComboBox para ejemplos y opciones disponibles para definir almacenes de datos.

HorizontalSlider y VerticalSlider: dijit.form.HorizontalSlider y dijit.form.VerticalSlider. Los sliders son widgets de interfaz para seleccionar números en un rango dado; estas son las variantes horizontal y vertical.

En su forma más básica, requieren los parámetros dijit 'minimum', 'maximum', y 'discreteValues'. Estos definen el rango de valores. Otras opciones comunes son:

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

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

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. Cuadro de texto para entrada numérica, con botones para incrementar y decrementar.

Espera ya sea un array asociativo para el parámetro dijit 'constraints', o simplemente las claves 'min', 'max', y 'places' (estas serían las entradas esperadas del parámetro constraints también). 'places' se puede usar para indicar cuánto incrementará y decrementará el number spinner.

echo $view->numberSpinner(
    'foo',
    5,
    array(
        'min'    => -10,
        'max'    => 10,
        'places' => 2,
    ),
    array(
        'maxlenth' => 3,
    )
);

NumberTextBox: dijit.form.NumberTextBox. NumberTextBox proporciona la capacidad de formatear y mostrar entradas numéricas de forma localizada, así como validar entradas numéricas, opcionalmente contra restricciones dadas.

echo $view->numberTextBox(
    'foo',
    5,
    array(
        'places' => 4,
        'type'   => 'percent',
    ),
    array(
        'maxlength' => 20,
    )
);

PasswordTextBox: dijit.form.ValidationTextBox vinculado a una entrada de contraseña. PasswordTextBox proporciona la capacidad de crear una entrada de contraseña que se adhiere al tema dijit actual, así como permitir validación del lado del cliente.

echo $view->passwordTextBox(
    'foo',
    '',
    array(
        'required' => true,
    ),
    array(
        'maxlength' => 20,
    )
);

RadioButton: dijit.form.RadioButton. Un conjunto de opciones del cual solo una puede seleccionarse. Esto se comporta en todo como un radio normal, pero tiene una apariencia consistente con otros dijits.

RadioButton acepta un quinto argumento opcional, $options, un array asociativo de pares de valor y etiqueta usados como opciones del 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 actúan como textareas normales, pero se estilizan usando el tema dijit actual. No necesita especificar ni los atributos rows ni columns; use ems o porcentajes para el ancho y alto, en su lugar.

echo $view->simpleTextarea(
    'foo',
    'Start writing here...',
    array(),
    array('style' => 'width: 90%; height: 5ems;')
);

SubmitButton: un dijit.form.Button vinculado a un elemento de entrada submit. Vea el ayudante de vista Button para más detalles; la diferencia clave es que este botón puede enviar un formulario.

Textarea: dijit.form.Textarea. Estos actúan como textareas normales, excepto que en lugar de tener un número fijo de filas, se expanden a medida que el usuario escribe. El ancho debe especificarse mediante un ajuste 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 una apariencia común entre varios elementos dijit, y para proporcionar funcionalidad base para las demás clases derivadas de TextBox (ValidationTextBox, NumberTextBox, CurrencyTextBox, DateTextBox, y TimeTextBox).

Las banderas de parámetro dijit comunes incluyen 'lowercase' (convertir a minúsculas), 'uppercase' (convertir a MAYÚSCULAS), 'propercase' (convertir a Case Apropiado), y trim (recortar 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 en la familia TextBox, TimeTextBox proporciona una selección desplegable desplazable de horas de la que un usuario puede seleccionar. Los parámetros dijit le permiten especificar los incrementos de tiempo disponibles en el select así como el rango visible de horas disponibles.

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. Hereda de TextBox.

Los parámetros dijit comunes incluyen:

echo $view->validationTextBox(
    'foo',
    '',
    array(
        'required' => true,
        'regExp'   => '[\w]+',
        'invalidMessage' => 'No spaces or non-word characters allowed',
        'promptMessage'  => 'Single word consisting of alphanumeric ' .
                            'characters and underscores only',
    ),
    array(
        'maxlength' => 20,
    )
);