PhlySimplePage

A ZF2 module for "static" pages.

Overview

In most ZF2 applications, you'll have at least a few pages that are basically static -- the controller contains no logic for the given endpoint, and it simply renders a template.

By default, this requires the following steps:

• Create a route
• Create a controller (if you don't have one already)
• Create an action in that controller
• Create a template

This module halves the workflow by eliminating the middle two steps.

Installation

Source download

Grab a source download:

• https://github.com/weierophinney/PhlySimplePage/archive/master.zip

Unzip it in your vendor directory, and rename the resulting directory:

cd vendor
unzip /path/to/PhlySimplePage-master.zip
mv PhlySimplePage-master PhlySimplePage

Git submodule

Add the repository as a git submodule in your project.

git submodule add git://github.com/weierophinney/PhlySimplePage.git vendor/PhlySimplePage

Use Composer

Assuming you already have composer.phar, add PhlySimplePage to your composer.json file:

{
    "require": {
        "phly/phly-simple-page": "dev-master"
    }
}

And then install:

php composer.phar install

Enable the module

Once you've installed the module, you need to enable it. You can do this by adding it to your config/application.config.php file:

<?php
return array(
    'modules' => array(
        'Application',
        'PhlySimplePage',
    ),
);

Usage

Create configuration in your application, mapping a route to the controller PhlySimplePage\Controller\Page, and specifying a template key in the route defaults.

return array(
    'router' => array(
        'routes' => array(
            'about' => array(
                'type' => 'Literal',
                'options' => array(
                    'route' => '/about',
                    'defaults' => array(
                        'controller' => 'PhlySimplePage\Controller\Page',
                        'template'   => 'application/pages/about',
                        // optionally set a specific layout for this page
                        'layout'     => 'layout/some-layout',
                    ),
                ),
            ),
        ),
    ),
);

Then, make sure you create a template for the page. In the above example, I'd likely create the file in module/Application/view/application/pages/about.phtml.

Caching

You can enable a write-through cache for all pages served by the PageController. This is done via the following steps:

• Creating cache configuration
• Enabling the page cache factory

To create cache configuration, create a phly-simple-page configuration key in your configuration, with a cache subkey, and configuration suitable for Zend\Cache\StorageFactory::factory. As an example, the following would setup filesystem caching:

return array(
    'phly-simple-page' => array(
        'cache' => array(
            'adapter' => array(
                'name'   => 'filesystem',
                'options => array(
                    'namespace'       => 'pages',
                    'cache_dir'       => getcwd() . '/data/cache',
                    'dir_permission'  => 0777,
                    'file_permission' => '0666',
                ),
            ),
        ),
    ),
);

To enable the page cache factory, do the following:

return array(
    'service_manager' => array(
        'factories' => array(
            'PhlySimplePage\PageCache' => 'PhlySimplePage\PageCacheService',
        ),
    ),
);

Selectively disabling caching for given routes

If you do not want to cache a specific page/route, you can disable it by adding the default key do_not_cache with a boolean true value to the route. As an example:

'about' => array(
    'type' => 'Literal',
    'options' => array(
        'route' => '/about',
        'defaults' => array(
            'controller'   => 'PhlySimplePage\Controller\Page',
            'template'     => 'application/pages/about',
            'do_not_cache' => true,
        ),
    ),
),

Clearing the cache

To clear the cache for any given page, or for all pages, your cache adapter (a) must support cache removal from the command line (APC, ZendServer, and several other adapters do not), and (b) must support flushing if you wish to clear all page caches at once.

The module defines two command line actions:

• php public/index.php phlysimplepage cache clear all -- clear all cached pages at once.
• php public/index.php phlysimplepage cache clear --page= clear a single cached page; use the template name you used in the routing configuration as the page value.

TODO

• Ability to clear sets of pages