必要なファイルを レイヤー にまとめます。 レイヤーは、すべての必要なファイルをひとつの JS ファイルにまとめたものです (これが、このセクションの名前の由来です)。

digit が使用する javascript 以外のファイル (テンプレートファイルなど) をまとめます。 これらもまた、レイヤーとして同じ JS ファイルにまとめられます。

そのファイルを ShrinkSafe に渡します。 これは、空白文字やコメントを削除して変数名を短くします。

setView(Zend_View_Interface $view): コンテナ内のビューインスタンスを設定します。

enable(): Dojo 統合機能を明示的に有効化します。

disable(): Dojo 統合機能を無効化します。

isEnabled(): Dojo 統合機能が有効かどうかを調べます。

requireModule($module): dojo.require 文を作成します。

getModules(): どのモジュールが必要なのかを調べます。

registerModulePath($module, $path): 独自の Dojo モジュールのパスを登録します。

getModulePaths(): 登録済みのモジュールパスの一覧を取得します。

addLayer($path): 使用するレイヤー (カスタムビルド) のパスを追加します。

getLayers(): 登録済みのすべてのレイヤー (カスタムビルド) のパスの一覧を取得します。

removeLayer($path): $path にマッチするレイヤー (カスタムビルド) を、 登録済みレイヤーの一覧から削除します。

setCdnBase($url): CDN 用のベース URL を設定します。一般的には Zend_Dojo::CDN_BASE_AOL あるいは Zend_Dojo::CDN_BASE_GOOGLE となりますが、これはバージョン番号より前に URL 文字列に必要となります。

getCdnBase(): 使用するベース CDN の URL を取得します。

setCdnVersion($version = null): CDN から使用する Dojo のバージョンを設定します。

getCdnVersion(): CDN からどのバージョンの Dojo を使用しているかを取得します。

setCdnDojoPath($path): CDN 上のファイル dojo.js あるいは dojo.xd.js への相対パスを設定します。一般的には Zend_Dojo::CDN_DOJO_PATH_AOL あるいは Zend_Dojo::CDN_DOJO_PATH_GOOGLE となりますが、これはバージョン番号の後の URL 文字列に必要となります。

getCdnDojoPath(): dojo.js ファイルを指す、CDN url のパスの最後の部分を取得します。

useCdn(): コンテナに、CDN を使用するよう指定します。暗黙的に統合機能を有効化します。

setLocalPath($path): コンテナに、ローカルの Dojo インストールパスを指定します (サーバからの相対パスで、かつ dojo.js ファイル自体も含まなければなりません)。 暗黙的に統合機能を有効化します。

getLocalPath(): どのローカルパスの Dojo を使用しているかを取得します。

useLocalPath(): 統合機能がローカルパスの Dojo を使用しているかどうかを調べます。

setDjConfig(array $config): dojo または dijit の設定項目を設定します (連想配列で指定します)。

setDjConfigOption($option, $value): 単一の dojo または dijit 設定項目を設定します。

getDjConfig(): すべての dojo または dijit 設定値を取得します。

getDjConfigOption($option, $default = null): 単一の dojo または dijit 設定値を取得します。

addStylesheetModule($module): モジュールのテーマに基づいたスタイルシートを追加します。

getStylesheetModules(): モジュールのテーマとして登録されたスタイルシートを取得します。

addStylesheet($path): Dojo で使用するローカルスタイルシートを追加します。

getStylesheets(): ローカル Dojo スタイルシートを取得します。

addOnLoad($spec, $function = null): dojo.onLoad がコールするラムダ関数を追加します。 引数をひとつわたした場合は、 関数名あるいは javascript のクロージャと見なされます。 引数をふたつわたした場合は、 最初の引数がオブジェクトのインスタンスを表す変数名、 二番目の引数がそのオブジェクトのメソッド名あるいは そのオブジェクトで使用するクロージャと見なされます。

prependOnLoad($spec, $function = null): addOnLoad() と同じですが、onLoad スタックの先頭に追加するという点だけが異なります。

getOnLoadActions(): コンテナに登録されているすべての dojo.onLoad() アクションを取得します。 これは配列の配列となります。

onLoadCaptureStart($obj = null): dojo.onLoad() のラムダ関数として使用するデータをキャプチャします。 $obj が指定された場合は、キャプチャされた JS コードはその Javascript オブジェクトで使用するクロージャであると見なします。

onLoadCaptureEnd($obj = null): dojo.onLoad() で使用するデータのキャプチャを終了します。

javascriptCaptureStart(): 任意の javascript をキャプチャし、Dojo JS (onLoad や require など) として取り込めるようにします。

javascriptCaptureEnd(): javascript のキャプチャを終了します。

__toString(): コンテナを文字列にキャストします。すべての HTML style 要素および script 要素をレンダリングします。

AccordionContainer: dijit.layout.AccordionContainer. Stack all panes together vertically; clicking on a pane titlebar will expand and display that particular pane.

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

AccordionPane: dijit.layout.AccordionPane. For use within AccordionContainer.

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

BorderContainer: dijit.layout.BorderContainer. Achieve layouts with optionally resizable panes such as you might see in a traditional application.

<?php echo $view->borderContainer(
    'foo',
    $content,
    array(
        'design' => 'headline',
    ),
    array(
        'style' => 'width: 100%; height: 100%',
    ),
); ?>

ContentPane: dijit.layout.ContentPane. Use inside any container except AccordionContainer.

<?php echo $view->contentPane(
    'foo',
    $content,
    array(
        'title'  => 'Pane Title',
        'region' => 'left',
    ),
    array(
        'style' => 'width: 120px; background-color: lightgray;',
    ),
); ?>

SplitContainer: dijit.layout.SplitContainer. Allows resizable content panes; deprecated in Dojo in favor of BorderContainer.

<?php echo $view->splitContainer(
    'foo',
    $content,
    array(
        'orientation'  => 'horizontal',
        'sizerWidth'   => 7,
        'activeSizing' => true,
    ),
    array(
        'style' => 'width: 400px; height: 500px;',
    ),
); ?>

StackContainer: dijit.layout.StackContainer. All panes within a StackContainer are placed in a stack; build buttons or functionality to reveal one at a time.

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

TabContainer: dijit.layout.TabContainer. All panes within a TabContainer are placed in a stack, with tabs positioned on one side for switching between them.

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

captureStart($id, array $params = array(), array $attribs = array());: begin capturing content to include in a container. $params refers to the dijit params to use with the container, while $attribs refer to any general HTML attributes to use.

Containers may be nested when capturing, so long as no ids are duplicated.

captureEnd($id): finish capturing content to include in a container. $id should refer to an id previously used with a captureStart() call. Returns a string representing the container and its contents, just as if you'd simply passed content to the helper itself.

Button: dijit.form.Button. Display a form button.

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

CheckBox: dijit.form.CheckBox. Display a checkbox. Accepts an optional fifth argument, the array $checkedOptions, which may contain either:

If $checkedOptions is not provided, 1 and 0 are assumed.

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

ComboBox: dijit.layout.ComboBox. ComboBoxes are a hybrid between a select and a text box with autocompletion. The key difference is that you may type an option that is not in the list of available options, and it will still consider it valid input. It accepts an optional fifth argument, an associative array $options; if provided, ComboBox will be rendered as a select. Note also that the label values of the $options array will be returned in the form -- not the values themselves.

Alternately, you may pass information regarding a dojo.data datastore to use with the element. If provided, the ComboBox will be rendered as a text input, and will pull its options via that datastore.

To specify a datastore, provide one of the following $params key combinations:

// 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. Inherits from ValidationTextBox, and provides client-side validation of currency. It expects that the dijit parameter 'currency' will be provided with an appropriate 3-character currency code. You may also specify any dijit parameters valid for ValidationTextBox and TextBox.

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

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

DateTextBox: dijit.form.DateTextBox. Inherits from ValidationTextBox, and provides both client-side validation of dates, as well as a dropdown calendar from which to select a date. You may specify any dijit parameters available to ValidationTextBox or TextBox.

echo $view->dateTextBox(
    'foo',
    '2008-07-11',
    array('required' => true)
);

Editor: dijit.Editor. Provides a WYSIWYG editor via which users may create or edit content. dijit.Editor is a pluggable, extensible editor with a variety of parameters you can utilize for customization; see the dijit.Editor documentation for more details.

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

FilteringSelect: dijit.form.FilteringSelect. Similar to ComboBox, this is a select and text hybrid that can either render a provided list of options or those fetched via a dojo.data datastore. Unlike ComboBox, however, FilteringSelect does not allow typing in an option not in its list. Additionally, it operates like a standard select in that the option values, not the labels, are returned when the form is submitted.

Please see the information above on ComboBox for examples and available options for defining datastores.

HorizontalSlider and VerticalSlider: dijit.form.HorizontalSlider and dijit.form.VerticalSlider. Sliders allow are UI widgets for selecting numbers in a given range; these are horizontal and vertical variants.

At their most basic, they require the dijit parameters 'minimum', 'maximum', and 'discreteValues'. These define the range of values. Other common options are:

The implication from Zend Framework creates a hidden element to store the value of the slider.

You may optionally desire to show a rule or labels for the slider. To do so, you will assign one or more of the dijit params 'topDecoration' and/or 'bottomDecoration' (HorizontalSlider) or 'leftDecoration' and/or 'rightDecoration' (VerticalSlider). Each of these expects the following options:

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 for numeric entry, with buttons for incrementing and decrementing.

Expects either an associative array for the dijit parameter 'constraints', or simply the keys 'min', 'max', and 'places' (these would be the expected entries of the constraints parameter as well). 'places' can be used to indicate how much the number spinner will increment and decrement.

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

NumberTextBox: dijit.form.NumberTextBox. NumberTextBox provides the ability to format and display number entries in a localized fashion, as well as validate numerical entries, optionally against given constraints.

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

PasswordTextBox: dijit.form.ValidationTextBox tied to a password input. PasswordTextBox provides the ability to create password input that adheres to the current dijit theme, as well as allow for client-side validation.

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

RadioButton: dijit.form.RadioButton. A set of options from which only one may be selected. This behaves in every way like a regular radio, but has a look-and-feel consistent with other dijits.

RadioButton accepts an optional fifth argument, $options, an associative array of value and label pairs used as the radio options. You may also pass these as the $attribs key options.

echo $view->radioButton(
    'foo',
    'bar',
    array(),
    array(),
    array(
        'foo' => 'Foo',
        'bar' => 'Bar',
        'baz' => 'Baz',
    )
);

SimpleTextarea: dijit.form.SimpleTextarea. These act like normal textareas, but are styled using the current dijit theme. You do not need to specify either the rows or columns attributes; use ems or percentages for the width and height, instead.

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

SubmitButton: a dijit.form.Button tied to a submit input element. See the Button view helper for more details; the key difference is that this button can submit a form.

Textarea: dijit.form.Textarea. These act like normal textareas, except that instead of having a set number of rows, they expand as the user types. The width should be specified via a style setting.

echo $view->textarea(
    'foo',
    'Start writing here...',
    array(),
    array('style' => 'width: 300px;')
);

TextBox: dijit.form.TextBox. This element is primarily present to provide a common look-and-feel between various dijit elements, and to provide base functionality for the other TextBox-derived classes (ValidationTextBox, NumberTextBox, CurrencyTextBox, DateTextBox, and TimeTextBox).

Common dijit parameter flags include 'lowercase' (cast to lowercase), 'uppercase' (cast to UPPERCASE), 'propercase' (cast to Proper Case), and trim (trim leading and trailing whitespace); all accept boolean values. Additionally, you may specifiy the parameters 'size' and 'maxLength'.

echo $view->textBox(
    'foo',
    'some text',
    array(
        'trim'       => true,
        'propercase' => true,
        'maxLength'  => 20,
    ),
    array(
        'size' => 20,
    )
);

TimeTextBox: dijit.form.TimeTextBox. Also in the TextBox family, TimeTextBox provides a scrollable drop down selection of times from which a user may select. Dijit parameters allow you to specify the time increments available in the select as well as the visible range of times available.

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. Provide client-side validations for a text element. Inherits from TextBox.

Common dijit parameters include:

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,
    )
);