netglue/zf2-prismic-module

This package is abandoned and no longer maintained. The author suggests using the netglue/expressive-prismic package instead.

There is no license information available for the latest version (0.2.0) of this package.

ZF2 module for the Prismic PHP SDK. Simple wrapper and some added convenience.

0.2.0 2017-04-26 15:28 UTC

Requires

• php: >=5.4
• prismic/php-sdk: >=1.5.3
• zendframework/zend-mvc: <=2.6.3
• zendframework/zendframework: ~2.3

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• phpunit/phpunit: ~5.0

Unknown License

• George Steel

• zf2
• netglue
• prismic.io

README

Routing

The module can currently helpfully determine which document corresponds to which Controller/Action by adding additional parameters to your routes.

Displaying a specific document that has been bookmarked would go something like this:

// ...
'myRouteName' => array(
    'type' => 'Literal',
    'options' => array(
        'route' => '/some-where',
        'defaults' => array(
            'controller' => 'My\Controller',
            'action' => 'my-place',
            'bookmark' => 'my-bookmark-name',
        ),
    ),
),
// ...

Then, in your My\Controller :

public function myPlaceAction()
{
    $document = $this->prismic()->getDocument();
}


'prismic' => array(
    'routeParameters' => array(
        'bookmark' => 'bookmark',
        'mask'     => 'mask',
        'ref'      => 'ref',
        'id'       => 'prismic-id',
        'slug'     => 'slug',
    ),
),

Automatic Page Meta

If you are in the habit of designing document masks that use the same document field for common page elements such as <title> and meta description, you can configure the module to watch out for these and trigger the appropriate view helper automatically. Current supported elements are:

<title>
<meta name="description">
<meta property="og:title">
<meta property="og:description">
<meta property="og:image">

The automation is implemented by way of a listener that listens to the Prismic controller plugin NetgluePrismic\Mvc\Controller\Plugin\Prismic::setDocument method. Once we know what document we're dealing with for the current request, if enabled, the listener will examine the document and try to pair up document fields with meta data and call the appropriate zend view helper with the found information. Example configuration is found in config/module.config.php

By default the listener, although attached, is not enabled.