projek-xyz/slim-plates

Render your Slim 3 application views using Plates template engine.

, _(*1)

Plates Template Integration for Slim micro framework 3

Render your Slim 3 application views using Plates template engine., _(*2)

Install

Via Composer, _(*3)

$ composer require projek-xyz/slim-plates --prefer-dist

Requires Slim micro framework 3 and PHP 5.5.0 or newer., _(*4)

Usage

// Create Slim app
$app = new \Slim\App();

// Fetch DI Container
$container = $app->getContainer();

// Register Plates View helper:
// Option 1, using PlatesProvider
$container->register(new \Projek\Slim\PlatesProvider);

// Option 2, using Closure
$container['view'] = function ($c) {
    $view = new \Projek\Slim\Plates([
        // Path to view directory (default: null)
        'directory' => 'path/to/views',
        // Path to asset directory (default: null)
        'assetPath' => 'path/to/static/assets',
        // Template extension (default: 'php')
        'fileExtension' => 'tpl',
        // Template extension (default: false) see: http://platesphp.com/extensions/asset/
        'timestampInFilename' => false,
    ]);

    // Set \Psr\Http\Message\ResponseInterface object
    // Or you can optionaly pass `$c->get('response')` in `__construct` second parameter
    $view->setResponse($c->get('response'));

    // Instantiate and add Slim specific extension
    $view->loadExtension(new Projek\Slim\PlatesExtension(
        $c->get('router'),
        $c->get('request')->getUri()
    ));

    return $view;
};

// Define named route
$app->get('/hello/{name}', function ($request, $response, $args) {
    return $this->view->render('profile', [
        'name' => $args['name']
    ]);
})->setName('profile');

// Run app
$app->run();

NOTE: * If you are using option 1 please make sure you already have $container['settings']['view'] in your configuration file. * Plates::setResponse() is required to use Plates::render() otherwise \LogicException will thrown., _(*5)

Custom functions

This component exposes some Slim functions to your Plates templates., _(*6)

pathFor()

You can use this function to generate complete URLs to any Slim application named route. Example:, _(*7)

layout('base-template') ?>

start('body') ?>


Hallo =$this->e($name)?>


<small>=$this->pathFor('profile', ['name'=> $name])?></small>
stop() ?>

baseUrl($permalink = '')

Retrieve the base url of your Slim application. Example:, _(*8)

<a href="<?=$this->baseUrl()?>">Some Link</a>

Or you can pass a permalink, _(*9)

<a href="<?=$this->baseUrl('some/path')?>">Some Other Link</a>

basePath()

Retrieve the base url of your Slim application. Example:, _(*10)

<link rel="stylesheet" href="<?=$this->basePath().'asset/css/main.css'?>">

uriFull()

Retrieve full request URI., _(*11)

uriScheme()

Retrieve the scheme component of the URI., _(*12)

uriHost()

Retrieve the host component of the URI, _(*13)

uriPort()

Retrieve the port component of the URI., _(*14)

uriPath()

Retrieve the path component of the URI., _(*15)

uriQuery()

Retrieve the query string component of the URI., _(*16)

uriFragment()

Retrieve the fragment component of the URI., _(*17)

Contributing

Please see CONTRIBUTING and CONDUCT for details., _(*18)

License

This library is open-sourced software licensed under MIT license., _(*19)