Anda di halaman 1dari 5

Zend_Layout Quick Start

There are two primary use cases for Zend_Layout: with the Zend Framework MVC, and
without.

Layout scripts
In both cases, however, you'll need to create a layout script. Layout scripts simply utilize
Zend_View (or whatever view implementation you are using). Layout variables are registered
with a Zend_Layout placeholder, and may be accessed via the placeholder helper or by
fetching them as object properties of the layout object via the layout helper.
As an example:
1. <!DOCTYPE html
2.
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3.
"http://www.w3.org/TR/xhtml1/DTD/xhtml1transitional.dtd">
4. <html>
5. <head>
6.
<meta http-equiv="Content-Type" content="text/html;
charset=utf-8" />
7.
<title>My Site</title>
8. </head>
9. <body>
10.
<?php
11.
// fetch 'content' key using layout helper:
12.
echo $this->layout()->content;
13.
14.
// fetch 'foo' key using placeholder helper:
15.
echo $this->placeholder('Zend_Layout')->foo;
16.
17.
// fetch layout object and retrieve various keys
from it:
18.
$layout = $this->layout();
19.
echo $layout->bar;
20.
echo $layout->baz;
21.
?>
22.
</body>
23.
</html>
Because Zend_Layout utilizes Zend_View for rendering, you can also use any view helpers
registered, and also have access to any previously assigned view variables. Particularly useful
are the various placeholder helpers, as they allow you to retrieve content for areas such as the
<head> section, navigation, etc.:
1. <!DOCTYPE html
2.
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

3.

"http://www.w3.org/TR/xhtml1/DTD/xhtml1transitional.dtd">
4. <html>
5. <head>
6.
<meta http-equiv="Content-Type" content="text/html;
charset=utf-8" />
7.
<?php echo $this->headTitle() ?>
8.
<?php echo $this->headScript() ?>
9.
<?php echo $this->headStyle() ?>
10.
</head>
11.
<body>
12.
<?php echo $this->render('header.phtml') ?>
13.
14.
<div id="nav"><?php echo $this>placeholder('nav') ?></div>
15.
16.
<div id="content"><?php echo $this->layout()>content ?></div>
17.
18.
<?php echo $this->render('footer.phtml') ?>
19.
</body>
20.
</html>

Using Zend_Layout with the Zend Framework MVC


Zend_Controller offers a rich set of functionality for extension via its front controller plugins
and action controller helpers. Zend_View also has helpers. Zend_Layout takes advantage of
these various extension points when used with the MVC components.
Zend_Layout::startMvc() creates an instance of Zend_Layout with any optional configuration
you provide it. It then registers a front controller plugin that renders the layout with any
application content once the dispatch loop is done, and registers an action helper to allow
access to the layout object from your action controllers. Additionally, you may at any time
grab the layout instance from within a view script using the Layout view helper.
First, let's look at how to initialize Zend_Layout for use with the MVC:
1. // In your bootstrap:
2. Zend_Layout::startMvc();
startMvc() can take an optional array of options or Zend_Config object to customize the
instance; these options are detailed in this section.
In an action controller, you may then access the layout instance as an action helper:
1. class FooController extends Zend_Controller_Action
2. {
3.
public function barAction()
4.
{
5.
// disable layouts for this action:

6.
$this->_helper->layout->disableLayout();
7.
}
8.
9.
public function bazAction()
10.
{
11.
// use different layout script with this
action:
12.
$this->_helper->layout->setLayout('foobaz');
13.
};
14.
}
In your view scripts, you can then access the layout object via the Layout view helper. This
view helper is slightly different than others in that it takes no arguments, and returns an
object instead of a string value. This allows you to immediately call methods on the layout
object:
1. <?php $this->layout()->setLayout('foo'); // set alternate
layout ?>
At any time, you can fetch the Zend_Layout instance registered with the MVC via the
getMvcInstance() static method:
1. // Returns null if startMvc() has not first been called
2. $layout = Zend_Layout::getMvcInstance();
Finally, Zend_Layout's front controller plugin has one important feature in addition to
rendering the layout: it retrieves all named segments from the response object and assigns
them as layout variables, assigning the 'default' segment to the variable 'content'. This allows
you to access your application content and render it in your view scripts.
As an example, let's say your code first hits FooController::indexAction(), which renders
some content to the default response segment, and then forwards to
NavController::menuAction(), which renders content to the 'nav' response segment. Finally,
you forward to CommentController::fetchAction() and fetch some comments, but render
those to the default response segment as well (which appends content to that segment). Your
view script could then render each separately:
1. <body>
2.
<!-3.
<div
?></div>
4.
5.
<!-6.
<div
?></div>
7. </body>

renders /nav/menu -->


id="nav"><?php echo $this->layout()->nav
renders /foo/index + /comment/fetch -->
id="content"><?php echo $this->layout()->content

This feature is particularly useful when used in conjunction with the ActionStack action
helper and plugin, which you can use to setup a stack of actions through which to loop, and
thus create widgetized pages.

Using Zend_Layout as a Standalone Component


As a standalone component, Zend_Layout does not offer nearly as many features or as much
convenience as when used with the MVC. However, it still has two chief benefits:

Scoping of layout variables.


Isolation of layout view script from other view scripts.

When used as a standalone component, simply instantiate the layout object, use the various
accessors to set state, set variables as object properties, and render the layout:
1. $layout = new Zend_Layout();
2.
3. // Set a layout script path:
4. $layout->setLayoutPath('/path/to/layouts');
5.
6. // set some variables:
7. $layout->content = $content;
8. $layout->nav
= $nav;
9.
10.
// choose a different layout script:
11.
$layout->setLayout('foo');
12.
13.
// render final layout
14.
echo $layout->render();

Sample Layout
Sometimes a picture is worth a thousand words. The following is a sample layout script
showing how it might all come together.

The actual order of elements may vary, depending on the CSS you've setup; for instance, if
you're using absolute positioning, you may be able to have the navigation displayed later in
the document, but still show up at the top; the same could be said for the sidebar or header.
The actual mechanics of pulling the content remain the same, however.

Anda mungkin juga menyukai