bulton-fr/bfw-savant3

BFW template module with Savant3

2.0.0-rc.11 2014-11-11 00:00 UTC

Requires

• bulton-fr/bfw: ~3.0.0-RC11@RC
• saltybeagle/savant3: dev-master@dev

LGPL-3.0

• Vermeulen Maxime / Bulton

• template
• module
• bfw
• Savant3

README

Module to use Savant3 library with BFW framework

Install :

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

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

Config :

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

The file config.php. You have a returned array with two keys :

• templateDir : It's the path to the template directory (you can use constant create by the framework)
• initSavant3 : Define if savant3 will be instanciate by the module himself or not

Use it :

If the config allow the module to instantiate Savant3, the instance will be saved into the property savant3 of the \BFW\Module instance for this module.

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