elife/patterns

eLife patterns

dev-master 2024-11-22 15:32 UTC

Requires

• php: ^7.0
• beberlei/assert: ^2.0
• mustache/mustache: ^2.5

Requires (Dev)

• justinrainbow/json-schema: ^5.1
• php-jsonpointer/php-jsonpointer: ^1.0
• phpspec/prophecy: ^1.10
• phpunit/phpunit: ^5.2
• squizlabs/php_codesniffer: ^3.5
• symfony/filesystem: ^3.0
• symfony/finder: ^3.0
• symfony/process: ^3.0
• symfony/yaml: ^3.1
• twig/twig: ^2.10

Suggests

• twig/twig: ^2.0, to use PatternExtension

MIT

README

This library provides a PHP implementation for the Mustache templates/assets produced by the eLife Sciences Pattern Library.

Dependencies

• Composer
• PHP 7

Installation

Execute composer require elife/patterns:dev-master.

Versioning

This library is not versioned as the eLife Patterns can make breaking changes at any time. It's not expected to be used by libraries, but by applications where Composer lock files are used. These tie the application to a specific commit.

Usage

Create ViewModels and pass them to a PatternRenderer, which will return the rendered template.

For example:

use eLife\Patterns\PatternRenderer\MustachePatternRenderer;

$helpers = [
    'assetsPath' => '/path/to/assets',
    'assetRewrite' => function (string $path, Mustache_LambdaHelper $helper) : string {
        return $helper->render($path).'?cache-buster';
    },
];

$mustache = new Mustache_Engine([
    'helpers' => $helpers,
    'loader' => new Mustache_Loader_FilesystemLoader('/path/to/patterns-php'),
]);
$patternRenderer = new MustachePatternRenderer($mustache);

var_dump($patternRenderer->render($viewModel));

Updating the library

1. Install Docker.
2. Execute bin/update to update the resources folder from Pattern Lab (you can pass a commit or pull request if needed, eg bin/update 4303c0199112724bd5725537c7192828099018fb or bin/update pr-850).
3. Make changes to the view models accordingly.