«
»

Module specific layouts in ZF2

If you need different layout scripts to be rendered for different modules in Zend Framework 2, then Evan Coury has made this extremely easy. His new module EdpModuleLayouts is just the ticket!

Once installed, you simply have to add a new array to a config file in the config/autoload folder with the following in it:

array(
    'module_layouts' => array(
        'Application' => 'layout/application',
        'ZfcUser' => 'layout/user',
    ),
);

i.e. you provide a list of the module name against the layout script to use.

What could be easier?

This entry was posted on Friday, 14th September 2012 at 16:17 and is filed under Zend Framework 2.

8 Responses to “Module specific layouts in ZF2”

  1. 1 mushfiq
    September 14th, 2012 at 17:33 #

    Why dont you explain a bit?I mean how it works?

  2. 2 Youri Thielen
    September 14th, 2012 at 19:19 #

    Why is this not possible this way by default in ZF2? (instead of registering a listener and changing it in module.php)

  3. 3 Rob...
    September 14th, 2012 at 20:01 #

    Mushfig,

    The operation is relatively straightforward. The module registers a event listener on Zend\Mvc\Controller\AbstractActionController's dispatch event. When it is triggered, the listener works out the current module's namespace and if the namespace is a key within the module_layouts config then the layout is changed.

    Youri,

    Zend Framework 2 is designed to be extended with single purpose modules so that the core doesn't have to have every feature.

    Regards,

    Rob...

  4. 4 Ronald van der Feer
    September 15th, 2012 at 02:06 #

    To me it makes more sense to have a module be responsible for it's own layout script, otherwise you end up setting the layout every time you use the module. Being able to override or decorate through DI does sound nice though.

  5. 5 Rob...
    September 15th, 2012 at 07:20 #

    This blog post by Evan covers how to make the module be responsible for changing the layout script.

  6. 6 MJ
    September 16th, 2012 at 22:00 #

    Hi Rob,
    When can we expect your new book on zf2?

  7. 7 Bart McLeod
    September 19th, 2012 at 20:46 #

    I think you can have the best of both worlds now, if you install Evan's module (or list that as a dependency of your own module if it's redistributable):
    - Use Evan's module
    - Put the layout config for your module in your module. It will be merged into a shared 'module_layouts' config.

    Benefits:
    - You write little configuration, because you reuse Evan's module
    - Your module is responsible for it's own layout.

    I did not try yet, but I think it should work this way.

  8. 8 Rob...
    September 28th, 2012 at 09:22 #

    MJ, I have nothing to announce at this time.

    Rob...

The views expressed in these comments are not the views of the publisher. However, we believe in the rights of others to express their legitimate views and concerns. Any legitimate complaint emailed to rob@akrabat.com will be seriously considered and the post reviewed as desirable and necessary.