vssl/render

Rendering agent for Journey Group’s Vessel Pages.

5.4.0 2024-04-15 14:43 UTC

Requires

• php: ^8.3
• guzzlehttp/guzzle: ^6.5
• guzzlehttp/promises: ^1.4
• guzzlehttp/psr7: ^1.7
• journey/cache: ^1.1
• league/plates: ^3.3
• psr/http-message: ^1.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• phpunit/phpunit: ^10.4

MIT

• Joshua Bryant
• Emily Merricks
• Justin Schroeder

README

What

This package contains a PHP rendering agent for Vessel Pages. It includes a PSR-15 middleware implementation to easily attach to any conforming framework and will automatically consume the Vessel Pages API and render production-ready markup.

Configuration

use Vssl\Resolver;
use Journey\Cache\LocalAdapter;

$config = [
    'cache' => new LocalAdapter('/tmp')
];

Resolver::config($config);

// for manual instantiation, you can also pass in a configuration.

$resolver = new Resolver($request, $config);

Configuration options

The only required configuration option is an implementation of Journey\Cache\CacheAdapterInterface.

Option	Description
cache	Instance of Journey\Cache\CacheAdapterInterface (or null to disable)
cache_ttl	Integer, number of seconds to store in cache
base_uri	URI for Vessel API interaction
base_path	Path to add to base_uri for versioned Vessel API interaction
required_fields	Keys required for API data to be considered valid
templates	Additional directory to find custom render templates

How

Attach the middleware to your favorite PSR-15 dispatcher before your router. When the request arrives in your controller methods, it will have an attribute vssl-page with content ready to be rendered.

<?php

namespace App\Controllers;

class YourController {
    /**
     * Any controller method.
     */
    public function anypage(ServerRequestInterface $request)
    {
        $page = $request->getAttribute('vssl-page');
    }
}