CakePHP 2.x CookBook 中文版 第六章 视图

视图

视图是 MVC 中的 V。 视图负责为请求生成指定的输出。常用的格式有 HTML、XML 或者 JSON，不过用户可以下载的流文件和 PDF 文件也可以由视图层提供。

CakePHP 为多数常用的渲染情况提供了一些内置的视图类： :

• 可以使用 JSON 和 XML 视图. 建立 XML 或者 JSON webservices
• 可以使用 媒体视图 提供受保护的文件，或者动态生成文件
• 可以使用 主题 生成多主题视图

视图模板

CakePHP 的视图层决定你如何向用户展示。 多数时候，视图在浏览器中显示 (X)HTML 文档，也可能会需要给 Flash 对象提供 AMF 数据，以 SOAP 形式回复远程应用程序，或者为用户输出一个 CSV 文件。

CakePHP 的默认视图文件是以 .ctp（CakePHP TempLate）为扩展名的纯 PHP 文件。这些文件包含了所有的从控制器获取的准备以某种格式提供给你的观众的数据的呈献逻辑。如果你喜欢使用类似 Twig 或者 Smarty 这样的模板语言，可以使用 View 的一个子类来桥接 CakePHP 和你的模板语言。

视图存储在 /app/View/ ，所有文件都放在以控制器命名的子文件夹中，文件名则是以动作命名的。例如，Products 控制器的 “view()” 动作的视图通常是 /app/View/Products/view.ctp。

CakePHP 的视图层可以由不同的部分构成。每一部分有不同的用途，将在下面的章节中介绍：

• views：视图是动作运行的唯一的页面部分。它们构成了应用程序的响应。
• elements：小的可重用的视图代码。元件通常在视图内部渲染。
• layouts： 应用程序中打包了呈献逻辑的一些视图接口文件。多数视图在布局内部渲染。
• helpers：这些类包装了视图层的许多地方都使用的视图逻辑。除了其它事项，CakePHP 的助手帮助你建立表单、构建 AJAX 功能、分页模型数据，或者提供 RSS feed。

继承视图

2.1 新版功能.

视图继承允许你在一个视图中包含另一个视图。使用 视图块 进行绑定提供了保持视图 DRY 的强劲手段。例如，应用程序中有一个边栏，它在特定的视图中需要呈献不同的内容。通过继承一个共用的视图文件，你无需重复边栏中共有的标记，只需要定义改变的部分：

// app/View/Common/view.ctp
<h1><?php echo $this->fetch('title'); ?></h1>
<?php echo $this->fetch('content'); ?>

<div class="actions">
    <h3>Related actions</h3>
    <ul>
<?php echo $this->fetch('sidebar'); ?>
    </ul>
</div>

上面的视图文件可以作为父视图。它需要继承它的视图定义 sidebar 和 title 块。它将包含继承视图中所有未捕获的内容。假设我们的视图文件有一个带有帖子数据的 $posts 变量，我们的视图看起来将是这个样子的：

<?php
// app/View/Posts/view.ctp
$this->extend('/Common/view');

$this->assign('title', $post);

$this->start('sidebar');
?>
<li>
<?php
echo $this->Html->link('edit', array(
    'action' => 'edit',
    $post['Post']['id']
)); ?>
</li>
<?php $this->end(); ?>

// 剩余的内容将以父视图中的 'content' 块的形式生效
<?php echo h($post['Post']['body']);

上面显示的这个帖子视图展示了如何继承一个视图，并且植入一个块集。块中未定义的内容将被捕捉并放入一个叫做content 的特殊块。当一个视图包含一个 extend() 调用，其将一直执行到当前文件的结尾。一旦它完成，被继承的视图被渲染。一个视图调用 extend() 超过一次， 将用后一个父视图覆盖前一个父视图：

$this->extend('/Common/view');
$this->extend('/Common/index');

上面的代码中， `` /Common/index.ctp`` 将作为当前视图的父视图。

必要时，你可以嵌套继承视图。如果需要，每个视图都能被另一个视图继承。每个父视图将获得前一个视图的内容，当作自己的 content 块。

注解

你应该在应用程序中避免使用 content 作为块名。CakePHP 用它作为继承视图中未捕获的内容块。

使用视图块

2.1 新版功能.

视图块放在 $scripts_for_layout，并提供一个允许你在视图/布局中任意位置定义插槽或者块的灵活的 API。 块是实现类似边栏这样的东东的理想方法，或者是在布局的头/尾加载资源的好地方。块有两种定义方式：作为捕获块，或者通过直接赋值。start()、 append() 和 end() 方法是和捕获块一同工作的：

// 建立一个边栏块
$this->start('sidebar');
echo $this->element('sidebar/recent_topics');
echo $this->element('sidebar/recent_comments');
$this->end();


// 随后添加一个边栏
$this->append('sidebar');
echo $this->element('sidebar/popular_topics');
$this->end();

也可以多次使用 start() 添加进一个块。 任何时候都可以使用 assign() 清除或者覆盖一个块：

// 清除之前定义的边栏块的内容。
$this->assign('sidebar', '');

在 2.3 版本中，新加了几个与块一同工作的方法。prepend() 预置一个已存在的块的内容：

// 预置到边栏。
$this->prepend('sidebar', 'this content goes on top of sidebar');

startIfEmpty() 方法在一个块为空或者未定义时生成一个块。如果块已经存在，则 startIfEmpty() 定义的内容被忽略。当你想要在块不存在时为其定义默认内容时，可以使用这一方法：:

// 在视图文件中。
// 创建一个导航栏块。
$this->startIfEmpty('navbar');
echo $this->element('navbar');
echo $this->element('notifications');
$this->end();

// 在父视图/布局中。
$this->startIfEmpty('navbar');
Default content
$this->end();

echo $this->fetch('navbar');

上面的例子中，navbar 块包含在第一部分中添加的内容。一旦在子视图中定义了这个块，其默认内容将被忽略。

注解

应该避免使用 content 作块名。它被用于 CakePHP 的内部视图和继承视图，以及布局视图内容中。

显示块

2.1 新版功能.

可以使用 fetch() 方法显示块。 fetch 将安全地输出一个块，如果块不存在，就返回 ‘’。

echo $this->fetch('sidebar');

还可以根据一个块是否存在来决定是否显示其内容。要想在布局、继承视图文件中有条件的显示头或者其它标签时，这种方法非常有用：

// 在 app/View/Layouts/default.ctp 中
<?php if ($this->fetch('menu')): ?>
<div class="menu">
    <h3>Menu options</h3>
<?php echo $this->fetch('menu'); ?>
</div>
<?php endif; ?>

在 2.3.0 版，还可以在块没有内容时为其提供默认值。这使为空状态添加占位符变得更容易。可以使用两个参数提供默认值：

<div class="shopping-cart">
    <h3>Your Cart</h3>
<?php echo $this->fetch('cart', 'Your cart is empty');
</div>

在 2.3 版更改: $default 添加于 2.3 版。

使用 script 和 CSS 文件块

2.1 新版功能.

块替代了被废弃的 $scripts_for_layout 布局变量。HtmlHelper 关联到视图块，它的 script() 、 css() 和 meta()方法在与 inline = false 选项共同使用时使用相同的相同的名字更新一个块。

<?php
// 在视图文件中。
$this->Html->script('carousel', array('inline' => false));
$this->Html->css('carousel', null, array('inline' => false));
?>

// 在布局文件中。
<!DOCTYPE html>
<html lang="en">
    <head>
    <title><?php echo $this->fetch('title'); ?></title>
<?php echo $this->fetch('script'); ?>
<?php echo $this->fetch('css'); ?>
    </head>
    // 下面是剩余的布局尊容...

HtmlHelper 还允许你控制使用哪个 scripts 和 CSS 块：

// 在视图文件中。
$this->Html->script('carousel', array('block' => 'scriptBottom'));

// 在布局文件中。
echo $this->fetch('scriptBottom');

布局

布局包含围绕视图的展示代码。想要在视图中看到的所有内容都将被放在布局中。

布局文件放在 /app/View/Layouts 中。CakePHP 的默认布局可以通过在 /app/View/Layouts/default.ctp 中建立一个新的默认布局来覆盖。 一旦一个新的默认布局被建立，当页被渲染时，控制器渲染的视图代码就被放在默认视图中。

当你创建一个布局，你需要告诉 CakePHP 你的视图代码放在哪儿了。要做到这一点，确保你的布局中包含了 $this->fetch('content')。下面是一个默认布局的示例：

<!DOCTYPE html>
<html lang="en">
<head>
<title><?php echo $title_for_layout?></title>
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<!-- Include external files and scripts here (See HTML helper for more info.) -->
<?php
echo $this->fetch('meta');
echo $this->fetch('css');
echo $this->fetch('script');
?>
</head>
<body>

<!-- If you'd like some sort of menu to
show up on all of your views, include it here -->
<div id="header">
    <div id="menu">...</div>
</div>

<!-- Here's where I want my views to be displayed -->
<?php echo $this->fetch('content'); ?>

<!-- Add a footer to each displayed page -->
<div id="footer">...</div>

</body>
</html>

注解

在 2.1 版之前，fetch() 方法无效。fetch('content') 是 2.0 版中 $scripts+for_layout 变量里包含的$content_for_layout 和 fetch('meta')、fetch('css')、fetch('script') 行的替代品。

script、 css 和 meta 块包含所有使用内置 HTML 助手定义在定义在视图中的内容。用于包含来自视图的 javascript 和 CSS 文件。

注解

当在视图文件中使用 HtmlHelper::css() 或 HtmlHelper::script() 时，将 ‘inline’ 设置为 ‘false’，将在一个带有相同名字的块中放置 html 源代码。（更多的详细信息和用法请参见 API）

content 块包含渲染视图的内容。

$title_for_layout 包含页面标题。这个变量是自动生成的，不过你能够通过在控制器/视图中设置它的值来覆盖其自动生成的默认值。

要设置布局的标题，最简单的办法是在控制器中设置 $title_for_layout 变量：

class UsersController extends AppController {
    public function view_active() {
        $this->set('title_for_layout', 'View Active Users');
    }
}

也可以在视图文件中设置 title_for_layout 变量：

$this->set('title_for_layout', $titleContent);

可以根据自己的愿望建立许多布局：把它们放进 app/View/Layouts 目录, 然后在控制器动作中使用控制器或者视图的$layout 属性在不同布局间切换：

// 通过控制器的布局属性
public function admin_view() {
    // stuff
    $this->layout = 'admin';
}

// 通过视图的布局属性
$this->layout = 'loggedin';

举例来说，假设我的站点包含一个小的广告条，我可能会创建一个带有小型广告空间的新布局，并把它指定为所有的控制器方案都使用的一部分：

class UsersController extends AppController {
    public function view_active() {
        $this->set('title_for_layout', 'View Active Users');
        $this->layout = 'default_small_ad';
    }

    public function view_image() {
        $this->layout = 'image';
        //output user image
    }
}

除了 CakePHP 的默认布局，CakePHP 还包含两可以在你的应用程序中使用的核心布局： ‘ajax’ 和 ‘flash’。 Ajax 布局便于生成 Ajax 响应 - 它是一个空布局（很多 ajax 调用的返回中仅仅包含那么几个标签，不需要完整的渲染接口）。 Flash 布局用于借助 Controller::flash() 方法显示消息。

内核中的另外三个视图，xml，js 和 rss，是提供非 text/html 内容的简捷方法。

使用插件中的布局

2.1 新版功能.

如果你想使用插件中的布局，可以用 插件语法。 例如，使用 Contacts 插件中的 contact 布局：

class UsersController extends AppController {
    public function view_active() {
        $this->layout = 'Contacts.contact';
    }
}

元素

很多应用程序都有需要在多个页面重复使用的处理显示的代码块，有时是在布局的不同地方。 CakePHP 能够帮助你在站点中重用这些重复部分。这些可重用的部分被称为 元素。广告、帮助、导航控制、扩展菜单、登录表单和标注，在 CakePHP 中常常被实现为元素。 一个元素基本上是一个能够被包含在其它视图、布局，甚至其它元素中的迷你视图。 元素可以使视图的可读性更好，重复的元素被放在自己的文件中。它们能帮助你在应用程序中重用内容片断。

元素放在 /app/View/Elements/ 文件夹，使用 .ctp 作为文件扩展名。 在视图中使用 element 方法输出元素：

echo $this->element('helpbox');

向元素传递变量

可以通过 element 方法的第二个参数向元素传递数据：

echo $this->element('helpbox', array(
    "helptext" => "Oh, this text is very helpful."
));

在元素文件中，所有传递过来的变量被当作参数数组的成员变量（与和视图文件一起工作的控制器中的Controller::set() 方法设置的变量相同）。在上例中， /app/View/Elements/helpbox.ctp 文件可以使用 $helptext变量：

// 在 app/View/Elements/helpbox.ctp 中
echo $helptext; //输出 "Oh, this text is very helpful."

View::element() 方法也支持元素的选项。这些选项支持 ‘缓存’ 和 ‘回调’。例如：

echo $this->element('helpbox', array(
        "helptext" => "This is passed to the element as $helptext",
        "foobar" => "This is passed to the element as $foobar",
    ),
    array(
        "cache" => "long_view", // 使用 "long_view" 缓存配置
        "callbacks" => true // 将此元素的 before/afterRender 回调设置为 true
    )
);

元素缓存很容易通过 Cache 类实现。可以让元素以你设置的任何缓存配置进行存储。 这为你决定在哪儿和如何长期存储元素提供了极为灵活地方法。 为达到在应用程序中缓存同一元素的不同版本的目的，可以通过使用如下格式为每个版本提供一个唯一的缓存键的方式：

$this->element('helpbox', array(), array(
        "cache" => array('config' => 'short', 'key' => 'unique value')
    )
);

可以通过使用 requestAction() 来获得元素的全部优点。 requestAction() 函数从控制器动作中获取视图变量，并以数组形式返回它们。 这会使你的元素能够以真正的 MVC 风格运行。 建立一个为元素准备视图数据的控制器动作，然后在 element() 的第二个参数中调用 requestAction()，自控制器向元素提供视图变量。

要做到这一点，在控制器中加入类似于下面的 Post 例子中的内容：

class PostsController extends AppController {
    // ...
    public function index() {
        $posts = $this->paginate();
        if ($this->request->is('requested')) {
            return $posts;
        } else {
            $this->set('posts', $posts);
        }
    }
}

然后我们就能够通过元素访问分页的 posts 模型。我们可以通过如下方式获取最后五个帖子的有序列表：

<h2>Latest Posts</h2>
<?php $posts = $this->requestAction('posts/index/sort:created/direction:asc/limit:5'); ?>
<ol>
<?php foreach ($posts as $post): ?>
      <li><?php echo $post['Post']['title']; ?></li>
<?php endforeach; ?>
</ol>

缓存元素

如果你提供了缓存参数，你就可以获得 CakePHP 视图缓存的好处。将其设置为 true，将会以 ‘默认’ 缓存配置缓存元素。此外，你也可以设置要使用的任意一个缓存配置。关于配置 Cache 的更多信息参见 缓存 。一个简单的缓存元素的例子：

echo $this->element('helpbox', array(), array('cache' => true));

如果你在一个视图中多次渲染了同一元素，只要确保每次手忙脚乱的 ‘key’ 参数的值是不同的即可。这将防止连续的调用会覆盖前一个元素调用的缓存结果。例如：

echo $this->element(
    'helpbox',
    array('var' => $var),
    array('cache' => array('key' => 'first_use', 'config' => 'view_long')
);

echo $this->element(
    'helpbox',
    array('var' => $differenVar),
    array('cache' => array('key' => 'second_use', 'config' => 'view_long')
);

上面的例子保证了两个元素的缓存结果是相互隔离的。 如果你想所有的元素缓存使用同一个缓存配置，你可以通过设置 View::$elementCache 给你想使用的缓存配置的方式来保存一些重复项。在什么都不提供时，CakePHP 将使用这一配置。

从插件请求元素

2.0

要从插件载入元素，使用 plugin 选项（从 1.x 版的 data 选项中移出）：

echo $this->element('helpbox', array(), array('plugin' => 'Contacts'));

2.1

如果你使用了一个插件并且希望使用其内置的元素，使用熟知的 插件语法。 如果视图被插件 控制器/动作 渲染，插件的名字将自动添加到所有要用的元素的前面，直到另一个插件名称出现。 如果插件内不存在这个元素，将会在主 APP 文件夹内寻找它：

echo $this->element('Contacts.helpbox');

如果视图是插件的一部分，你可以活略插件名。例如，如果你在 Contacts 插件的 ContactsController 中工作：

echo $this->element('helpbox');
// 和
echo $this->element('Contacts.helpbox');

是等同的，其结果是渲染了同一个元素。

在 2.1 版更改: $options[plugin] 选项被废弃，同时添加了 Plugin.element 支持。

建立你自己的视图类

你可能需要建立自定义的新数据视图类型的视图类，或者向应用程序添加附加的自定义视图渲染逻辑。就像多数 CakePHP 组件视图类，有几条约定：

• 视图文件要放在 App/View``文件夹中。例如 ``App/View/PdfView.php 。
• 视图文件必须以 View 做后缀。例如 PdfView 。
• 在指定要渲染的视图类名时，需要省略 View 后缀。例如 $this->viewClass = 'Pdf'; 。

你也许需要扩展 View 以使某些东西正常工作：

// 在 App/View/PdfView.php 中

App::uses('View', 'View');
class PdfView extends View {
    public function render($view = null, $layout = null) {
        // custom logic here.
    }
}

替换 render 方法会让你对如果渲染内容有更大的控制权。

View API

class View

视图方法在所有的视图、元素和布局文件中都可用。

使用 $this->method() 调用视图方法。

View::set(string $var, mixed $value)

视图有一个与控制器对象中的 set() 方法作用相同的 set() 方法。在视图文件中调用 set() 方法将向附后被渲染的布局或元素中添加变量。关于使用 set() 方法的更多信息参见 控制器方法 。

可以在视图文件中使用：

$this->set('activeMenuButton', 'posts');

之后 $activeMenuButton 变量就可以在布局中使用了，并且它的值为 ‘posts’ 。

View::getVar(string $var)

获取视图变量 $var 的值

View::getVars()

获取当前渲染范围内的所有有效的视图变量的列表。返回变量名组成的数组。

View::element(string $elementPath, array $data, array $options = array())

渲染元素或者局部视图。更多的信息和示例参见 元素 一节。

View::uuid(string $object, mixed $url)

为对象生成基于对象类型和 url 的唯一的非随机的 DOM ID。这个方法常常被助手使用，为每个元素生成唯一的 DOM ID，例如 JsHelper：

$uuid = $this->uuid('form', array('controller' => 'posts', 'action' => 'index'));
//$uuid 包含 'form0425fe3bad'

View::addScript(string $name, string $content)

向内部脚本缓冲添加内容。这个缓冲在布局中是 $scripts_for_layout。当用手需要直接向布局添加 javascript 或者 css 时很有用。 谨记，从布局或者布局中的元素中添加的脚本不能补添加到 $scripts_for_layout。 此方法经常用在助手中，比如 Javascript 助手 和 Html助手 助手。

2.1 版后已移除: 被 使用视图块 特性取代。

View::blocks()

获取所有已定义的块的名字，返回结果为所有名字构成的数组。

View::start($name)

开始捕获视图块。参见 使用视图块 一节的示例。

2.1 新版功能.

View::end()

结束最近开放的捕捉块。参见 使用视图块 一节的示例。

2.1 新版功能.

View::append($name, $content)

以 $name 为名称向块中追加内容。参见 使用视图块 一节的示例。

2.1 新版功能.

View::prepend($name, $content)

以 $name 为名称向块中预存内容。 参见 使用视图块 一节的示例。

2.3 新版功能.

View::startIfEmpty($name)

在块为空时开始一个块。如果块已经被定义，则其全部内容将被捕获并抛弃。

2.3 新版功能.

View::assign($name, $content)

为块赋值。这会覆盖已存在的内容。参见 使用视图块 一节的示例。

2.1 新版功能.

View::fetch($name)

获取块的值。如果块没有定义，其值为’‘（空字符串）。 参见 使用视图块 一节的示例。

2.1 新版功能.

View::extend($name)

继承以 $name 命名的 视图/元素/布局。参见 使用视图块 一节的示例。

2.1 新版功能.

property View::$layout

设置包含当前视图的布局。

property View::$elementCache

这个缓存配置用于缓存元素。设置此属性将改变默认的元素缓存配置。 此默认值可以使用 element 方法的 ‘cache’ 选项覆盖。

property View::$request

CakeRequest 的实例。使用此实例方法有关当前请求的信息。

property View::$output

包含最后渲染的视图内容（来自视图文件或者布局内容）。

2.1 版后已移除: 被 $view->Blocks->get('content'); 代替。

property View::$Blocks

ViewBlock 的实例。用于在视图渲染中提供视图块功能。

2.1 新版功能.

关于视图的更多内容

• 主题
  • Theme 部件
  • 提高插件和主题部件的运行效率
• 媒体视图
  • 可设置的参数
• JSON 和 XML 视图
  • 在应用程序中允许使用数据视图
  • 利用 serialize 键使用数据视图
  • 利用视图文件使用数据视图
• 助手
  • 使用和配置助手
  • 使用助手
  • 回调方法
  • 创建助手
    • 包含其它助手
    • 使用助手
  • 为所有助手创建功能
  • 助手 API
    • 回调
  • 内核 Helpers