symfonybundle's Introduction

PrismicBundle

This Bundle integrates the http://prismic.io php-kit with the Symfony Framework: https://github.com/prismicio/php-kit

For an example use see: https://github.com/prismicio/php-symfony-starter

Installation

Add the following dependencies to your projects composer.json file:

"require": {
    # ..
    "prismic/prismic-bundle": "~1.0@dev"
    # ..
}

Configuration

Add the following configuration to your projects app/config/config.yml file:

# Default configuration for extension with alias: "prismic"
prismic:
    api:
        endpoint:             ~ # Required
        access_token:         ~
        client_id:            ~
        client_secret:        ~

If you would like to have OAuth authentication in your app so you can preview upcoming releases for example. You must import the OAuth specific routes in your app/config/routing.yml file:

# Default OAuth routes which will redirect to the "home" route after signin/signout
prismic_oauth:
    resource: "@PrismicBundle/Resources/config/routing/oauth.xml"

You can override the redirect route from the bundle configuration:

# Default configuration for extension with alias: "prismic"
prismic:
    oauth:
        redirect_route:         home # Name of the route
        redirect_route_params:  []   # An array with additional route params

TODOs

Add a listener for Symfony 2.3 to set the request data into the context as 2.3 does not support ExpressionLanguage
Add unit (and functional?) tests
Provide twig templates to render documents
Make caching configurable once prismicio-community/php-kit#32 is implemented