Dojo 本身没有 AutoCompletion 小部件，但有两个小部件可以执行 AutoCompletion：ComboBox 和 FilteringSelect。对于这两者，都要求实现 QueryReadStore 的数据存储，关于这话题的更多信息参见 » dojo.data 文档。

在 Zend Framework 中，可以传递简单的索引的数组给 AutoCompleteDojo 助手，它将返回一个适合和这样一个存储一起使用的 JSON 响应：

// within a controller action:
$this->_helper->autoCompleteDojo($data);

        

dojo.provide("custom.TestNameReadStore");
dojo.declare("custom.TestNameReadStore", dojox.data.QueryReadStore, {
    fetch:function (request) {
        request.serverQuery = { test:request.query.name };
        return this.inherited("fetch", arguments);
    }
});

class TestController extends Zend_Controller_Action
{
    protected $_form;

    public function getForm()
    {
        if (null === $this->_form) {
            $this->_form = new Zend_Form();
            $this->_form->setMethod('get')
                ->setAction(
                    $this->getRequest()->getBaseUrl() . '/test/process'
                )
                ->addElements(array(
                    'test' => array('type' => 'text', 'options' => array(
                        'filters'        => array('StringTrim'),
                        'dojoType'       => array('dijit.form.ComboBox'),
                        'store'          => 'testStore',
                        'autoComplete'   => 'false',
                        'hasDownArrow'   => 'true',
                        'label' => 'Your input:',
                    )),
                    'go' => array('type' => 'submit',
                                  'options' => array('label' => 'Go!'))
                ));
        }
        return $this->_form;
    }
}

            

class TestController extends Zend_Controller_Action
{
    // ...

    /**
     * Landing page
     */
    public function indexAction()
    {
        $this->view->form = $this->getForm();
    }

    public function autocompleteAction()
    {
        if ('ajax' != $this->_getParam('format', false)) {
            return $this->_helper->redirector('index');
        }
        if ($this->getRequest()->isPost()) {
            return $this->_helper->redirector('index');
        }

        $match = trim($this->getRequest()->getQuery('test', ''));

        $matches = array();
        foreach ($this->getData() as $datum) {
            if (0 === strpos($datum, $match)) {
                $matches[] = $datum;
            }
        }
        $this->_helper->autoCompleteDojo($matches);
    }
}

            

<? // setup our data store: ?>
<div dojoType="custom.TestNameReadStore" jsId="testStore"
    url="<?= $this->baseUrl() ?>/unit-test/autocomplete/format/ajax"
    requestMethod="get"></div>

<? // render our form: ?>
<?= $this->form ?>

<? // setup Dojo-related CSS to load in HTML head: ?>
<? $this->headStyle()->captureStart() ?>
@import "<?= $this->baseUrl() ?>/javascript/dijit/themes/tundra/tundra.css";
@import "<?= $this->baseUrl() ?>/javascript/dojo/resources/dojo.css";
<? $this->headStyle()->captureEnd() ?>

<? // setup javascript to load in HTML head, including all required
   // Dojo libraries: ?>
<? $this->headScript()
        ->setAllowArbitraryAttributes(true)
        ->appendFile($this->baseUrl() . '/javascript/dojo/dojo.js',
            'text/javascript',
            array('djConfig' => 'parseOnLoad: true'))
        ->captureStart() ?>
djConfig.usePlainJson=true;
dojo.registerModulePath("custom","../custom");
dojo.require("dojo.parser");
dojo.require("dojox.data.QueryReadStore");
dojo.require("dijit.form.ComboBox");
dojo.require("custom.TestNameReadStore");
<? $this->headScript()->captureEnd() ?>

            

» Scriptaculous 需要一个特定格式的 HTML 响应。

和这个库一起使用的助手是 'AutoCompleteScriptaculous'，给它提供一个数据数组，这个助手将生成兼容于 Ajax.Autocompleter 的 HTML 响应。

缺省地，ContextSwitch 助手的两个上下文可用：json 和 xml。

• JSON. JSON 上下文设置 'Content-Type' 响应头为 'application/json'，设置视图脚本后缀为 'json.phtml'。

  缺省地，不需要视图脚本，它将系列化所有的视图变量，立即发出 JSON 响应。

  通过关闭 auto-JSON serialization 可禁止这个行为：

  $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
  
                  

• XML. XML 上下文设置 'Content-Type' 响应头为 'text/xml'，设置视图脚本后缀为 'xml.phtml'。你需要为这个上下文创建新的视图脚本。

有时候，缺省的上下文不够用，例如你需要返回 YAML，或系列化 PHP、RSS 或 ATOM feed 等等，ContextSwitch 正是你需要的东西。

最容易的添加新的上下文的办法是通过 addContext() 方法。这个方法带有两个参数：上下文的名称和一个规范（specification）数组，规范应当包含下列中的一个或多个：

• suffix: 当在视图解析器里注册时，预先准备的缺省的视图后缀。

• headers: 作为响应的一部分发送的头/值（header/value）对的数组。

• callbacks: 数组，包含一个或更多键 'init' 或 'post'，指向有效的可用于上下文和善后处理的 PHP 回调（callback）。

  回调的初始化发生在当 ContextSwitch 检测到上下文时，你可以用它来执行任意的应该发生的逻辑。作为例子，当 auto-JSON serialization 是 on 的时候，JSON 上下文使用回调来关闭视图解析器（ViewRenderer）。

  善后处理（post processing）发生在动作的 postDispatch() 程序期间，可用来执行任意的逻辑。作为例子，JSON 上下文使用回调（callback）来决定是否 auto-JSON serialization 是 on；如果是，它系列化视图变量到 JSON 和 发送响应，如果不是，它重新打开（re-enable）视图解析器（ViewRenderer）。

和上下文交互作用的方法：

• addContext($context, array $spec): 添加新的上下文，如果上下文存在，抛出一个异常。

• setContext($context, array $spec): 添加新的上下文或重写一个已存在的上下文，和 addContext() 使用相同的规范（specification）。

• addContexts(array $contexts): 一次添加多个上下文。$contexts 应当是上下文/规范（context/specification）对的数组。如果任何一个上下文存在，就抛出异常。

• setContexts(array $contexts): 添加和重写存在的上下文（多于一个），和 addContexts() 使用相同的规范。

• hasContext($context): 如果上下文存在，返回 true，否则返回 false。

• getContext($context): 通过名称来获取一个单个的上下文，返回一个遵循用于 addContext() 的规范的数组。

• getContexts(): 获取所有的上下文，返回上下文/规范对的数组。

• removeContext($context): 通过名称来清除一个单个的上下文，成功返回 true，如果没有发现上下文返回 false。

• clearContexts(): 清除所有上下文。

有两个设置可用的上下文的机制：或者在控制器里手工创建数组，或者使用在 ContextSwitch 里的方法来装配它们。

添加动作/上下文关系的基本方法是 addActionContext() 。它有两个参数：上下文被添加到的动作和上下文的名称或上下文数组的其中之一。作为例子，考虑下列的控制器类：

class FooController extends Zend_Controller_Action
{
    public function listAction()
    {
    }

    public function viewAction()
    {
    }

    public function commentsAction()
    {
    }

    public function updateAction()
    {
    }
}

        

假如我们想添加 XML 上下文到 'list'动作、XML 和 JSON 上下文到 'comments' 动作，可以在 init() 方法中完成：

class FooController extends Zend_Controller_Action
{
    public function init()
    {
        $this->_helper->contextSwitch()
             ->addActionContext('list', 'xml')
             ->addActionContext('comments', array('xml', 'json'))
             ->initContext();
    }
}

        

另外，还可以定义数组属性 $contexts：

class FooController extends Zend_Controller_Action
{
    public $contexts = array(
        'list'     => array('xml'),
        'comments' => array('xml', 'json')
    );

    public function init()
    {
        $this->_helper->contextSwitch()->initContext();
    }
}

        

上述不但缺少周密考虑，而且有潜在的错误。

下面的方法可用来构造上下文映射：

• addActionContext($action, $context): 标记一个或多个可用的上下文给一个动作，如果映射已经存在，就追加到那些映射中。$context 可以是一个单个的上下文，或者是一个上下文数组。

  一个上下文的 true 值将标记所有可用的上下文给动作。

  一个 $context 的空值将关闭（disable）所有给定动作的上下文。

• setActionContext($action, $context): 标记一个或多个上下文对动作可用，如果映射已经存在，它就替换它们。$context 可以是一个单个的上下文，或者是一个上下文数组。

• addActionContexts(array $contexts): 一次性添加若干动作/上下文对，$contexts 是动作/上下文对的关联数组。它代理 addActionContext()，意味着如果那些动作/上下文对存在，就追加之。

• setActionContexts(array $contexts): 和 addActionContexts() 一样，但重写已存在的动作/上下文对。

• hasActionContext($action, $context): 决定一个特定的动作是否有一个给定的上下文。

• getActionContexts($action = null): 返回或者给定动作的所有上下文，或者所有动作/上下文对。

• removeActionContext($action, $context): 从给定动作中清除一个或多个上下文。$context 可以是一个单个的上下文，或者是一个上下文数组。

• clearActionContexts($action = null): 从给定动作或者从有上下文的动作中清除所有上下文。

为初始化上下文开关，需要在动作控制器中调用 initContext()：

class NewsController extends Zend_Controller_Action
{
    public function init()
    {
        $this->_helper->contextSwitch()->initContext();
    }
}

        

在某些情况下，你想强制使用上下文，例如，如果上下文开关是激活状态，你只想用 XML 上下文，可以通过传递上下文给 initContext() 来完成：

$contextSwitch->initContext('xml');

        

用来改变 ContextSwitch 助手行为的方法包括：

• setAutoJsonSerialization($flag): 缺省地，JSON 上下文将系列化任何视图变量给 JSON 符号并把它作为响应返回。如果想创建自己的响应，你需要关闭它，这需要在调用 initContext() 之前来完成。

  $contextSwitch->setAutoJsonSerialization(false);
  $contextSwitch->initContext();
  
                  

  用 getAutoJsonSerialization() 来获取 flag 的值。

• setSuffix($context, $suffix, $prependViewRendererSuffix): 用这个方法，你可以为给定的上下文指定一个不同的后缀。第三个参数用来指示是否用新的后缀预先准备当前视图解析器，这个 flag 缺省为打开。

  传递空值给后缀将导致只有视图解析器的后缀被使用。

• addHeader($context, $header, $content): 为给定的上下文添加一个响应头，$header 是头的名称，$content 是为这个头传递的值。

  每个上下文可以有多个头，addHeader() 把另外的头添加到头的堆栈。

  如果为上下文指定的 $header 已经存在，就抛出一个异常。

• setHeader($context, $header, $content): setHeader() 和 addHeader() 一样，但它允许重写已经存在的上下文的头。

• addHeaders($context, array $headers): 一次性添加多个头到给定的上下文，代理 addHeader()，如果头已经存在，将抛出异常。$headers 是一个头/上下文对的数组。

• setHeaders($context, array $headers.): 象 addHeaders() 一样，但代理 setHeader()，允许重写已存在的头。

• getHeader($context, $header): 获取给定上下文的头的值，如果没有发现返回 null。

• removeHeader($context, $header): 清除一个单个的给定上下文的头。

• clearHeaders($context, $header): 清除所有给定上下文的头。

• setCallback($context, $trigger, $callback): 为给定的上下文在给定的触发器设置回调（callback），触发器或者是 'init'，或者是 'post'（指明回调将被在上下文初始化时或者派遣后（postDispatch）调用）。 $callback 应当是一个有效的 PHP 回调。

• setCallbacks($context, array $callbacks): 为给定的上下文设置多个回调，$callbacks 应当是触发器/回调对。事实上，最常用的可注册的回调有两个：一个为初始化用的，一个是做善后处理。

• getCallback($context, $trigger): 在给定的上下文中从给定的触发器中获取一个回调。

• getCallbacks($context): 从给定的上下文获取所有的回调，返回一个触发器/回调对数组。

• removeCallback($context, $trigger): 从给定的触发器和上下文清除一个回调。

• clearCallbacks($context): 为给定的上下文清除所有的回调。

• setContextParam($name): 设置请求参数来检查什么时候决定上下文开关是否已经请求，缺省值为 'format'，但这个访问器可以用来设置一个备用的值。

  getContextParam() 用来获取当前的值。

• setAutoDisableLayout($flag): 缺省地，当上下文开关出现，布局是关闭的；这是因为一般布局将只用来返回正常的相应，对备用的（alternate）上下文没有意义。然而，如果想使用布局（也许你对新的上下文有个布局），你可以通过传递一个 false 的值给 setAutoDisableLayout() 来改变它的行为。这应当 在 调用 initContext() 之前 来做。

  用访问器 getAutoDisableLayout() 来获取这个 flag 的值。

• getCurrentContext() 可用来确定什么上下文被检测到，如果有的话。如果没有上下文开关发生，或者在调用 initContext() 之前调用它，则返回 null。

AjaxContext 助手继承 ContextSwitch，所有 ContextSwitch 函数列表对它也有效，只是有些小小的不同。

首先，它为确定上下文使用不同的动作控制器属性 － $ajaxable。这样你就可以对 AJAX 和 普通的 HTTP 请求使用不同的上下文。AjaxContext 的各种各样 *ActionContext*() 方法将写到这个属性。

其次，由请求对象的 isXmlHttpRequest() 方法来确定，它只有在 XmlHttpRequest 出现后才触发。这样，如果上下文参数 （'format'）在请求中传递，但请求没有做成 XmlHttpRequest，不会触发上下文开关。

第三，AjaxContext 添加另外的上下文 － HTML。在这个上下文中，为了区别这个上下文和普通的请求，它设置后缀为 'ajax.phtml'。没有另外的头返回。

class CommentController extends Zend_Controller_Action
{
    public function init()
    {
        $ajaxContext = $this->_helper->getHelper('AjaxContext');
        $ajaxContext->addActionContext('view', 'html')
                    ->addActionContext('form', 'html')
                    ->addActionContext('process', 'json')
                    ->initContext();
    }

    public function viewAction()
    {
        // Pull a single comment to view.
        // When AjaxContext detected, uses the comment/view.ajax.phtml
        // view script.
    }

    public function formAction()
    {
        // Render the "add new comment" form.
        // When AjaxContext detected, uses the comment/form.ajax.phtml
        // view script.
    }

    public function processAction()
    {
        // Process a new comment
        // Return the results as JSON; simply assign the results as
        // view variables, and JSON will be returned.
    }
}

            

FlashMessenger助手允许你传递用户可能需要在下个请求看到的消息。为实现它，FlashMessenger使用Zend_Session_Namespace来存储消息以备将来或下个请求来读取。如果你计划使用Zend_Session或者Zend_Session_Namespace，在引导文件里用Zend_Session::start()初始化，的确是个好主意。（参见Zend_Session文档有更多的关于它的用法的细节。）

下面的例子展示flash messenger最基本的用法。当动作/some/my 被调用，它添加flash message "Record Saved!"，随后的对动作/some/my-next-request的请求将读取它（并也这样删除它）。

class SomeController extends Zend_Controller_Action
{
    /**
     * FlashMessenger
     *
     * @var Zend_Controller_Action_Helper_FlashMessenger
     */
    protected $_flashMessenger = null;

    public function init()
    {
        $this->_flashMessenger =
            $this->_helper->getHelper('FlashMessenger');
        $this->initView();
    }

    public function myAction()
    {
        /**
         * default method of getting
         * Zend_Controller_Action_Helper_FlashMessenger instance
         * on-demand
         */
        $this->_flashMessenger->addMessage('Record Saved!');
    }

    public function myNextRequestAction()
    {
        $this->view->messages = $this->_flashMessenger->getMessages();
        $this->render();
    }
}

        

转向器(Redirector)助手让你使用一个转向器对象帮助程序重定向到新的URL。与_redirect()方法相比，它具有多项优势。例如能够在转向器对象中预先配置整个站点的行为，或者使用与Zend_Controller_Action::_forward()相似的gotoSimple($action, $controller, $module, $params)接口。

转向器拥有影响重定向行为的大量方法：

• setCode() 设置重定向过程中使用的HTTP响应码。

• setExit() 在重定向后强制执行exit()方法。默认已设定。

• setGotoSimple()设置默认的URL，当没有提供参数给gotoSimple()方法时转向该URL。可以使用类似Zend_Controller_Action::_forward()的API：setGotoSimple($action, $controller = null, $module = null, array $params = array());

• setGotoRoute()设置基于一个注册路由器的URL。通过传入一个键/值数组和一个路由器名，它将根据路由器的类型和定义来组织URL。

• setGotoUrl()设置默认的URL，当没有参数传入gotoUrl()，将使用该URL。接受单个URL字符串。

• setPrependBase()在setGotoUrl()、gotoUrl()或者gotoUrlAndExit()指定的URL前面，加入请求对象的基地址(base URL)。

• setUseAbsoluteUri()强制转向器在重定向时使用绝对的URI。当该选项设定后，将使用$_SERVER['HTTP_HOST']、 $_SERVER['SERVER_PORT']和 $_SERVER['HTTPS']以及重定向方法指定的URL，来形成一个完整的URI。该选项目前默认关闭，将来的版本可能会默认开启。

此外，转向器中还有大量方法来执行实际的重定向。

• gotoSimple()使用setGotoSimple()(类似_forward()的API)来构建URL并执行重定向。

• gotoRoute()使用setGotoRoute()(路由组装route-assembly)来构建URL并执行重定向。

• gotoUrl()使用setGotoUrl() URL字符串）来构造URL并执行重定向。

最后，你可以在任何时刻使用getRedirectUrl()确定当前的重定向URL。

视图解析(ViewRenderer)助手为实现下列目标设计：

• 不需要在控制器内创建视图对象实例；视图对象将在控制器内自动注册。

• 根据当前的模块自动地设置视图脚本、助手、过滤器路径。指派当前的模块名为助手和过滤器类的类名前缀。

• 为所有分发的控制器和动作创建全局有效的视图对象。

• 允许开发人员为所有控制器设置默认的视图解析选项。

• 加入无需干预自动解析试图脚本的功能。

• 允许开发人员为视图基路径和视图脚本路径创建自己的规范。

Note: 如果手动执行_forward()、redirect、或者render时，不会发生自动解析。因为执行这些动作时，等于告诉ViewRenderer，你要自己确定输出结果。

Note: ViewRenderer助手默认启用。你可以通过前端控制器的noViewRenderer方法、设定参数($front->setParam('noViewRenderer', true))或者从助手经纪人栈(helper broker stack)中移除助手(Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer'))等方式禁用该助手。
如希望在分发前端控制器前修改ViewRenderer设定，可采用下面的两种方法：

• 创建实例并注册自己的ViewRenderer对象，然后传入到助手经纪人。

  $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
  $viewRenderer->setView($view)
               ->setViewSuffix('php');
  Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
  
                      

• 通过助手经纪人即时的初始化并/或获取ViewRenderer对象。

  $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  $viewRenderer->setView($view)
               ->setViewSuffix('php');
  
                      

大多数使用中，只需要简单的创建 ViewRenderer对象，然后传入到动作助手经纪人。创建实例并注册的最简单方式是使用助手经纪人的getStaticHelper()方法：

Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');

        

动作控制器第一次实例化时，会触发ViewRenderer创建一个视图对象。动作控制器每次实例化都会调用ViewRenderer的init()方法，设定动作控制器的视图属性，并以相对于当前模块的路径为参数调用addScriptPath()方法；调用时带有以当前模块命名的类前缀参数，该参数对为该模块定义的所有助手和过滤器类都有效。(this will be called with a class prefix named after the current module, effectively namespacing all helper and filter classes you define for the module. )

每次执行postDispatch()方法，它将为当前动作执行render()方法。

例如这个类：

// A controller class, foo module:
class Foo_BarController extends Zend_Controller_Action
{
    // Render bar/index.phtml by default; no action required
    public function indexAction()
    {
    }

    // Render bar/populate.phtml with variable 'foo' set to 'bar'.
    // Since view object defined at preDispatch(), it's already available.
    public function populateAction()
    {
        $this->view->foo = 'bar';
    }
}

...

// in one of your view scripts:
$this->foo(); // call Foo_View_Helper_Foo::foo()

        

ViewRenderer也定义了大量的访问器用来设定和获取视图选项。

• setView($view)可以为ViewRenderer设定视图对象。以公共类属性$view获取设定值。

• setNeverRender($flag = true)可以全局的启用或禁用自动解析，也就是对所有控制器都有效。如果设定为true，在所有控制器器内，postDispatch()将不会自动调用render()。getNeverRender()返回当前的设定值。

• setNoRender($flag = true) 用来启用或禁用自动解析，如果设置为true，在当前控制器内，postDispatch()不会调用render()方法。这个设定在preDispatch()每次执行时会被重置。getNoRender()返回当前的设定值。

• setNoController($flag = true)通知render()不要再到以控制器命名的子目录中寻找视图脚本。getNoController()返回当前值。

• setNeverController($flag = true)与setNoController($flag = true)相似，但是其在全局范围内有效——也就是说，它不会在每次分发动作时重置。getNeverController()返回当前值。

• setScriptAction($name)用来指定解析的视图脚本。$name是脚本的名字去掉后缀(不带控制器子目录，除非noController已开启)。如果没有指定，它将寻找以请求对象中的动作命名的视图脚本。getScriptAction()返回当前值。

• setResponseSegment($name)用来指定解析到响应对象中的哪个命名片段。如果没有指定，解析到默认片断。getResponseSegment()返回当前值。

• initView($path, $prefix, $options)可以指定视图的基路径，为助手和过滤器脚本设置类前缀，设定ViewRenderer选项。可以传入以下任意的标志：neverRender，noRender，noController， scriptAction，和responseSegment。

• setRender($action = null, $name = null, $noController = false)可以一次设定scriptAction、responseSegment和noController。 direct()是它的别名，使得控制器中可以方便的调用。

  // Render 'foo' instead of current action script
  $this->_helper->viewRenderer('foo');
  
  // render form.phtml to the 'html' response segment, without using a
  // controller view script subdirectory:
  $this->_helper->viewRenderer('form', 'html', true);
  
                  

  Note: setRender() 和 direct()并不会实际解析视图脚本，而是提示postDispatch()和postDispatch()解析视图。
  

构造函数允许可选的传入参数视图对象和ViewRenderer选项，接受与initView()一样的标志(flags)：

$view    = new Zend_View(array('encoding' => 'UTF-8'));
$options = array('noController' => true, 'neverRender' => true);
$viewRenderer =
    new Zend_Controller_Action_Helper_ViewRenderer($view, $options);

        

还有几个额外的方法用来定制路径规则，供确定视图基路径来增加视图对象，确定视图脚本路径查找并解析视图脚本时使用。这些方法每个都带有下面一个或更多的占位符(placehodlers)。

• :moduleDir 引用当前模块的基目录（常规的是模块的控制器目录的父目录）。

• :module 引用当前的模块名。

• :controller 引用当前的控制器名。

• :action引用当前的模块名。

• :suffix 引用当前的视图脚本后缀（可以通过setViewSuffix()来设置）。

控制器路径规则有关的方法:

• setViewBasePathSpec($spec)可以改变确定加入到视图对象的基路径的路径规则。默认规则是:moduleDir/views。任何时候都可以使用getViewBasePathSpec()获取当前的规则。

• setViewScriptPathSpec($spec)允许改变确定到达单独的视图脚本路径(去除试图脚本基路径)的路径规则。默认的路径规则是 :controller/:action.:suffix。任何时候都可以通过getViewScriptPathSpec()获取当前规则。

• setViewScriptPathNoControllerSpec($spec)允许改变 noController有效时确定到达单独的视图脚本路径(去除试图脚本基路径)的路径规则。默认的规则是:action.:suffix，任何时候都可以通过getViewScriptPathNoControllerSpec()获取当前规则。

为在路径规范之上精心设计的控制，可以使用Zend_Filter_Inflector。深入地，视图解析器（ViewRenderer）已经使用inflector来执行路径映射。为和inflector互动 － 或者设置你自己的或者修改缺省的inflector，下面的方法可以被使用：

• getInflector() 将获取inflector。如果在视图解析器中不存在， 它用缺省的规则创建一个。

  缺省地，它用静态规则引用和静态目标做为后缀和模块目录；这允许不同的视图解析器具备动态修改inflector能力的属性。

• setInflector($inflector, $reference) 允许设置定制的inflector和视图解析器一起使用。如果$reference 是true，它将设置后缀和模块目录作为静态引用和目标给视图解析器 属性。

Note: 缺省查找约定（Conventions）
视图解析器做了一些路径标准化使视图脚本查找更容易。缺省规则如下：

• :module: 混合词和驼峰词被短横线分开，并整个串变成小写。例如："FooBarBaz" 变成 "foo-bar-baz"。

  在内部，变形器（inflector） 使用过滤器Zend_Filter_Word_CamelCaseToDash 和 Zend_Filter_StringToLower。

• :controller: 混合词和驼峰词被短横线分开；下划线转换成目录分隔符，并且整个串变小写。例如："FooBar" becomes "foo-bar"; "FooBar_Admin" 变成 "foo-bar/admin".

  在内部，inflector 使用过滤器Zend_Filter_Word_CamelCaseToDash、Zend_Filter_Word_UnderscoreToSeparator 和 Zend_Filter_StringToLower。

• :action: 混合词和驼峰词被短横线分开；非字母数字字符翻译成短横线，并且整个串变成小写。 例如 "fooBar" 变成 "foo-bar"； "foo-barBaz" 变成 "foo-bar-baz"。

  在内部，inflector 使用过滤器 Zend_Filter_Word_CamelCaseToDash、Zend_Filter_PregReplace 和 Zend_Filter_StringToLower。

视图解析器 API中的最后一项是关于实际确定视图脚本路径和解析视图的。包括：

• renderScript($script, $name)允许解析指定路径的脚本，可选的命名的路径片段。(renderScript($script, $name) allows you to render a script with a path you specify, optionally to a named path segment. )使用该方法时，ViewRenderer不会自动的确定脚本名称，而是直接的向视图对象的render()传入$script参数。

  Note: 当视图已经被解析到响应对象，将会设置noRender阻止相同的脚本被多次解析。
  

  Note: 默认的，Zend_Controller_Action::renderScript()代理ViewRenderer的renderScript()方法。
  

• getViewScript($action, $vars)基于传入的动作和/或$vars中的变量创建到视图脚本的路径。该数组中的键可以包含所有的路径指定键('moduleDir','module', 'controller', 'action', and 'suffix')。传入的任何变量都会优先使用，否则利用基于当前请求的值。

  getViewScript()根据noController标志的设定值使用viewScriptPathSpec或者viewScriptPathNoControllerSpec。

  模块、控制器以及动作中的单词定界符将后替换成短线('-')。因此，控制器名称'foo.bar'和动作'baz:bat'按照默认的路径规则将会得到视图脚本路径'foo-bar/baz-bat.phtml'。

  Note: 默认的，Zend_Controller_Action::getViewScript()代理ViewRenderer的getViewScript()方法。
  

• render($action, $name, $noController)首先检查$name或 $noController参数是否传入，如果传入，则在ViewRenderer中设定相应的标志(分别是响应片段和noController)。然后传入$action参数到getViewScript()，最后传入计算的试图脚本路径到renderScript()。

  Note: 注意使用render()的边际效应：传入的响应片段名称和noController标志在视图对象中存留。此外解析结束后noRender会被设置。
  

  Note: 默认的，Zend_Controller_Action::render()代理 ViewRenderer的render()方法。
  

• renderBySpec($action, $vars, $name)允许传入路径规则变量以确定创建的视图脚本路径。它把$action和$vars传入到getScriptPath()，将脚本路径结果和$name传入到renderScript()。

// In your bootstrap:
Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');

...

// 'foo' module, 'bar' controller:
class Foo_BarController extends Zend_Controller_Action
{
    // Render bar/index.phtml by default; no action required
    public function indexAction()
    {
    }

    // Render bar/populate.phtml with variable 'foo' set to 'bar'.
    // Since view object defined at preDispatch(), it's already available.
    public function populateAction()
    {
        $this->view->foo = 'bar';
    }

    // Renders nothing as it forwards to another action; the new action
    // will perform any rendering
    public function bazAction()
    {
        $this->_forward('index');
    }

    // Renders nothing as it redirects to another location
    public function batAction()
    {
        $this->_redirect('/index');
    }
}

            

Note: 命名规则：控制器和动作名中的单词定界符
如果控制器或者动作名称由几个单词组成，分发器要求在URL中使用特定的路径和单词定界符分隔。ViewRenderer创建路径时将控制器名称中的任何路径定界符替换成实际的路径定界符('/')，任何单词定界符替换成短线('-')。对动作/foo.bar/baz.bat的调用将分发到FooBarController.php中的FooBarController::bazBatAction()，然后解析foo-bar/baz-bat.phtml；对动作/bar_baz/baz-bat的调用将分发到Bar/BazController.php中的Bar_BazController::bazBatAction()，并解析bar/baz/baz-bat.phtml。
注意到在第二个例子中，模块依然是默认的模块，但由于路径分隔符的存在，控制器的接收到的名字为Bar_BazController，该类在文件Bar/BazController.php中。ViewRenderer模拟了控制器的目录分层。

// Baz controller class, bar module:
class Bar_BazController extends Zend_Controller_Action
{
    public function fooAction()
    {
        // Don't auto render this action
        $this->_helper->viewRenderer->setNoRender();
    }
}

// Bat controller class, bar module:
class Bar_BatController extends Zend_Controller_Action
{
    public function preDispatch()
    {
        // Never auto render this controller's actions
        $this->_helper->viewRenderer->setNoRender();
    }
}

            

Note: 大多数情况下，全局的关闭自动解析(setNeverRender())没有意义，因为这样ViewRenderer做的唯一件事只是自动设置了视图对象。

// Bar controller class, foo module:
class Foo_BarController extends Zend_Controller_Action
{
    public function addAction()
    {
        // Render 'bar/form.phtml' instead of 'bar/add.phtml'
        $this->_helper->viewRenderer('form');
    }

    public function editAction()
    {
        // Render 'bar/form.phtml' instead of 'bar/edit.phtml'
        $this->_helper->viewRenderer->setScriptAction('form');
    }

    public function processAction()
    {
        // do some validation...
        if (!$valid) {
            // Render 'bar/form.phtml' instead of 'bar/process.phtml'
            $this->_helper->viewRenderer->setRender('form');
            return;
        }

        // otherwise continue processing...
    }

}

            

// Bar controller class, foo module:
class Foo_BarController extends Zend_Controller_Action
{
    public function preDispatch()
    {
        // change view encoding
        $this->view->setEncoding('UTF-8');
    }

    public function bazAction()
    {
        // Get view object and set escape callback to 'htmlspecialchars'
        $view = $this->_helper->viewRenderer->view;
        $view->setEscape('htmlspecialchars');
    }
}