Cockpit-Twig

Use Cockpit and Twig together.

Installation

Clone the repo:

```git clone https://github.com/rensite/cockpit-twig your_cockpit_folder/modules/addons/Twig`

Or

Download zip and unpack to 'your_cockpit_folder/addons/Twig'.
Make sure you require 'your_cockpit_folder/bootstrap.php'.
Hook up your Twig_Environment to the module.

cockpit('twig')->use($your_twig_env);

Start using Cockpit in your templates.

Initialisation Example

define('DOCROOT', $_SERVER['DOCUMENT_ROOT']);
require_once('./vendor/autoload.php'); // If you're using composer.
require_once('./cockpit-master/bootstrap.php');

$loader = new \Twig\Loader\FilesystemLoader(DOCROOT . '/templates');
$twig = new \Twig\Environment($loader, array(
  'cache' => DOCROOT . '/cache', // turns on cache
));

cockpit('twig')->use($twig);

// Make sure '/templates/index.twig' exists.
$template = $twig->load('index.twig');
echo $template->render();

Debug mode

In case you need to use dump() method in yout twig templates.

$twig = new \Twig\Environment($loader, array(
  'debug' => true,
));

$twig->addExtension(new \Twig\Extension\DebugExtension());

Use with cache

To enable page caching:

$twig = new \Twig\Environment($loader, array(
  'cache' => DOCROOT . '/cache', // turns on cache
));

Usage

Collections

Retrieve all items for a collection:

{% for item in collection('projects') %}
  {{ item.name }}
{% endfor %}

Query a collection:

{% for item in collection('projects', {active: 1}) %}
  {{ item.name }}
{% endfor %}

Singletons

Render the entire singleton, with template:

{{ singleton('info') }}

Render one field:

{{ singleton_field('info', 'title') }}

Parameters are: region name & field name.

Galleries & Mediamanager

Print an image tag for each image in gallery:

{% for image in gallery('projects') %}
  {{ thumbnail(image.path) }}
{% endfor %}

or just the url:

{% for image in gallery('projects') %}
  <img src="{{ thumbnail_url(image.path) }}" />
{% endfor %}

Forms

{{ form('contact') }}
  <input type="text" name="form[name]" />
  <input type="email" name="form[email]" />
  <input type="submit" value="submit" />
</form>

Authentication Methods

get_user() returns a User object representing the currently logged in user if any. has_access($resource, $action) returns true or false depending on the granted permissions for that action and resource and for the currently logged in user.

{% set user = get_user() %}
{% if user %}
  Nice to see you again {{ user.name }}!
  {% if has_access('gallery', 'create') %}
    Let's snap some pictures.
  {% endif %}
{% endif %}

rensite / cockpit-twig