ansaurus

Question

Zend Framework - layout best practices for 'includes'

Answer 1

+1 A:

To have a different layout/config for various sections of a site, I use Modules with the following module setup. Module Config

[Edit]

Directory Structure :

/application
    /forms
    /models
    /modules
        /admin
            /config
            /contollers
            /layout
            /views
        /default
            /config
            /contollers
            /layout
            /views

piddl0r 2009-11-19 15:29:04

How do modules differ from view helpers, or partial view helpers?

meder 2009-11-20 10:57:50

I use this method because each module has it's own layout and config directory, meaning the controller doesn't set the alternative layout. I find it makes controlling access through ACls easier with modules too.Directory Structure : /application /forms /models /modules /admin /config /contollers /layout /views /default /config /contollers /layout /views

piddl0r 2009-11-24 14:25:53

eww thats ugly, I'll add it to the answer

piddl0r 2009-11-24 14:26:29

Answer 2

A:

An implementation that I use is as follows:

In each of the layout phtml files (default, admin, etc)

I use:

<?= $this->action('header', 'page', 'default') ?>
<?= $this->layout()->content ?>
<?= $this->action('footer', 'page', 'default') ?>

so in my page controller I may have an action called "headerAction" or "adminHeaderAction" which does nothing (or actually could perform specific tasks) but returns a header.phtml (where I can customize my header information for that layout). I can then customize my header and footer separate from the content.

In my controller I just need to set the appropriate layout:

$this->_helper->layout->setLayout('adminLayout');

Arthur Frankel 2009-11-19 21:48:01

this is wrong as the action helper fires new request loop. That's slow.

Tomáš Fejfar 2009-11-19 22:23:27

Agreed. The action view helper is evil. I wish they'd just remove it already :) http://framework.zend.com/issues/browse/ZF-5840

Richard Nguyen 2009-11-20 16:58:07

Good point. I never thought of the extra round trip (for each one).

Arthur Frankel 2009-11-20 19:19:34

Hehe all good, everyone's done that kind of stuff before. Your `setLayout()` was spot on though

Richard Nguyen 2009-11-20 21:05:25

Answer 3

+1 A:

If the view helpers are complex use concrete view helper. If they are simple like <h1>my title</h1> use partial view helper to render a template.

Tomáš Fejfar 2009-11-19 22:24:41

Do you mind providing an example of at least structure, and example code of the inclusion of partial view helpers using the filenames header.phtml and footer.phtml, or however it works out?

meder 2009-11-20 00:23:37

//header<?php echo $this->partial('header.phtml', $optionalArrayWithDataToBeUsedInside);the second parameter like array('title' => 'my page') allows you to use `echo $this->title` inside your partial. For view helper setup see the manual.

Tomáš Fejfar 2009-11-21 09:47:50

Answer 4

+1 A:

Directory structure:

/application
  /layouts
    /scripts
      /layout.phtml
      /profile.phtml
      /admin.phtml
      /_header.phtml
      /_footer.phtml

layout.phtml:

<?php echo $this->doctype('HTML4_STRICT') ?>
<html> 
<head>  
  <title>Bah</title>
</head> 
<body>
  <?php echo $this->render('_header.phtml') ?>
  <?php echo $this->layout()->content ?>
  <?php echo $this->render('_footer.phtml') ?>
</body>
</html>

profile.phtml:

<?php echo $this->doctype('HTML4_STRICT') ?>
<html> 
<head>  
  <title>Profile</title>
</head> 
<body>
  <!-- profile header -->
  <?php echo $this->layout()->content ?>
  <!-- profile footer-->
</body>
</html>

FooController.php:

profileAction()
{
    // do stuff
    $this->_helper->layout->setLayout('profile');
}

This method allows you to change the entire page structure of different layouts (The admin suddenly needs a sidebar!). You trade off some code duplication for enhanced flexibility and maintainability.

If this is not important to you, a view helper would work also (query the Front Controller to find out if the request came from either the admin or profile actions, switch). For my tastes though, that type of logic is too involved to belong in the view.

Richard Nguyen 2009-11-20 16:36:57

Awesome, just what I needed - I'll try out the implementation.

meder 2009-11-20 23:36:39

ansaurus

tags:

views:

answers:

Zend Framework - layout best practices for 'includes'

related questions