bulton-fr/bfw-fenom

Fenom template module for BFW

2.0.0-rc.11 2016-03-26 00:00 UTC

Requires

• bulton-fr/bfw: ~3.0.0-RC11@RC
• fenom/fenom: ~2.8

LGPL-3.0

• Vermeulen Maxime / Bulton

• template
• module
• fenom
• bfw

README

Module to use Fenom library with BFW framework

Install :

You can use composer to get the module : composer require bulton-fr/bfw-fenom @stable

And to install the module : ./vendor/bin/bfwInstallModules

Config :

All config file for this module will be into app/config/bfw-fenom/. There is one files to configure (manifest.json is for the module update system).

The file config.php. This file start with two variabled declared ($fenomOptions and $fenomOptionsDebug). The first variable is options passed to fenom, and the second is an override of the first variable used when the framework is run in debug mode (file /app/config/bfw/global.php).

Next you have a returned array with three keys :

• pathTemplate : It's the path to the template directory (you can use constant create by the framework)
• pathCompiled : It's the path to the compiled template directory (you can use constant create by the framework)
• fenomOptions : It's options will be passed to Fenom. The value is generate with $fenomOptions and $fenomOptionsDebug declared before in the file.

To know options list, you can refer to the fenom doc

Use it :

The module will instantiate Fenom with a call to Fenom::Factory with infos configured. The instance will be saved into the property fenom of the \BFW\Module instance for this module.

You can access to the property from anywhere with \BFW\Application::getInstance()->getModuleList()->getModuleByName('bfw-fenom')->fenom;