https://github.com/daun/templateenginelatte

A ProcessWire module adding Latte to the TemplateEngineFactory.
https://github.com/daun/templateenginelatte

latte processwire processwire-modules template-engine

Last synced: 23 days ago
JSON representation

A ProcessWire module adding Latte to the TemplateEngineFactory.

• Host: GitHub
• URL: https://github.com/daun/templateenginelatte
• Owner: daun
• License: mit
• Created: 2020-10-31T23:17:24.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-22T16:51:42.000Z (12 months ago)
• Last Synced: 2024-04-23T17:52:21.044Z (7 months ago)
• Topics: latte, processwire, processwire-modules, template-engine
• Language: PHP
• Homepage:
• Size: 71.3 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TemplateEngineLatte

[![Build Status](https://travis-ci.org/daun/TemplateEngineLatte.svg?branch=master)](https://travis-ci.org/daun/TemplateEngineLatte)

[![StyleCI](https://github.styleci.io/repos/308988747/shield?branch=master)](https://github.styleci.io/repos/308988747)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![ProcessWire 3](https://img.shields.io/badge/ProcessWire-3.x-orange.svg)](https://github.com/processwire/processwire)

A ProcessWire module adding [Latte](https://latte.nette.org/) to the [TemplateEngineFactory](https://github.com/wanze/TemplateEngineFactory).

This module version uses Latte 3, which comes with breaking changes in how tags/macros are

defined. If you need to keep using Latte 2, stick with major version `^1.0` of this module. Learn more about

the [migration to Latte 3](https://latte.nette.org/en/cookbook/migration-from-latte2) and

[upgrading macros to tags](https://tomasvotruba.com/blog/how-to-upgrade-latte-2-macro-to-latte-3-tag/).

## Requirements

* ProcessWire `3.0` or newer

* TemplateEngineFactory `2.0` or newer

* PHP `8.0` or newer

* Composer

## Installation

Execute the following command in the root directory of your ProcessWire installation:

```

composer require daun/template-engine-latte:^2.0

```

This will install the _TemplateEngineLatte_ and _TemplateEngineFactory_ modules in one step. Afterwards, don't forget

to enable Latte as engine in the _TemplateEngineFactory_ module's configuration.

> ℹ️ This module includes test dependencies. If you are installing on production with `composer install`, make sure to

pass the `--no-dev` flag to omit autoloading any unnecessary test dependencies!.

## Configuration

The module offers the following configuration:

* **`Template files suffix`** The suffix of the Latte template files, defaults to `latte`.

* **`Default layout file`** Layout that all views will extend from unless overwritten.

* **`Provide ProcessWire API variables in Latte templates`** API variables (`$pages`, `$input`, `$config`...)

are accessible in Latte,

e.g. `{$config}` for the config API variable.

* **`Simplified path resolution`** Enable Blade-style dot syntax for directory traversal. [See below](#simplified-path-resolution).

* **`Auto refresh templates (recompile)`** Recompile templates whenever the source code changes.

### Simplified Path Resolution

This option will enable two things:

* Allow dot syntax for directory traversal à la Blade.

* Prepend the base view directory to all paths, eliminating the need for endless `../` in subdirectories.

#### Example

Both of these will resolve to `site/templates/views/partials/navigation.latte`:

* Normal resolution: `{include '../../partials/navigation.latte'}`

* Simplified resolution enabled: `{include 'partials.navigation'}`

## Extending Latte

It is possible to extend Latte after it has been initialized by the module. Hook the method

`TemplateEngineLatte::initLatte` to register custom tags, filters, functions etc.

Here is an example how you can use the provided hook to add custom macros and filters.

```php

wire()->addHookAfter('TemplateEngineLatte::initLatte', function (HookEvent $event) {

    /** @var Latte\Engine */

    $latte = $event->arguments('latte');

    $compiler = $latte->getCompiler();

    // Add filter

    $latte->addFilter('lower', function ($str) { return strtolower($str); });

    // Add custom tags via extensions

    $latte->addExtension(new FooExtension);

});

```

> The above hook can be put in your `site/init.php` file. If you prefer to use modules, put it into the module's `init()`

method and make sure that the module is auto loaded.