How to implement a sidebar in Zend Framework

Question

How do I implement a sidebar in Zend Framework? I know that I can use a placeholder or something similar in Zend_layout, but how do I automatically generate the code for the sidebar in my controllers without having to call a sidebar class within every controller? My setup is as follows

Application
- modules
  - blog
  - other modules

I only want the sidebar for my blog module.

I have found this http://www.zfforums.com/zend-framework-components-13/model-view-controller-mvc-21/how-layout-sidebar-etc-2677.html but I do not understand the last part "just inject your layout, register it with the front controller ..."

Answer 1

You could just have a action and view in one of your controllers which renders the sidebar.

from the layout for the blog module you just call:

<? echo $this->action('action','controller','module',array('optionalparams'=>1); ?>

on the position where you want to have it. So one call to one action.

Answer 2

Rather than use the action stack and the action() view helper, you could render a "partial view script" that includes your sidebar elements.

# in your layout.phtml
<div id="sidebar">
    <?php echo $this->render('blog/_sidebar.phtml'); /*relative to your view scripts directory*/ ?>
</div>

# in blog/_sidebar.phtml
<div id="blog_categories">
    <?php foreach ($this->categories as $category): ?>
        <?php echo $category->name; ?>
    <?php endforeach; ?>
</div>

The render() view helper is used to render the content of another view script. It has the same scope as all your other view scripts, so if there are any variable assigned to the view, they will be available to your partial. So in the example above, the categories variable was set in the controller.

There is another view helper called the partial() view helper. This function is a little more expensive since it creates its own variable scope. In other words, none of your current view variables will be available. You will have a clean slate to work with, which means you must pass in any variables you need:

# in your layout.phtml
<div id="sidebar">
    <?php echo $this->partial('blog/_sidebar.phtml', array('categories2'=>$this->categories)); ?>
</div>

# in blog/_sidebar.phtml
<div id="blog_categories">
    <?php foreach ($this->categories2 as $category): ?>
        <?php echo $category->name; ?>
    <?php endforeach; ?>
</div>

I don't find myself using partial() very often since it is more expensive, and I rarely need to create a separate context.

As far as setting up the variables for use in the sidebar partial ($this->categories in this example), I have used a number of different methods depending on the particular problem. If it's specific to a controller action, I will write the code and assign it in the view script:

# controller
public function somethingAction()
{
    $this->view->categories = $this->_getCategoriesForThisParticularAction();
    // other controller code
}

If my code is more generic to all the actions of the controller, I will utilize the controller's preDispatch() function. If it's more generic to multiple controllers, I will put the code in the init() of my base controller (a controller the most of my controllers extend).

Sometimes I do not even put the code in my controller. If it's simple enough, I just stick the code in the partial. If it's a little more complex, I will move it to a view helper. This may break the MVC pattern, but I think it really depends on the particular case in order to determine the best placement.