README.md

Smarty IncludeQ

Rewritten (due that original use GPLv2+ license) Smarty 'include' variant that was invented for use in XOOPS, but nowadays used in some other PHP based CMS'es (like ImpressCMS!).

See, original version of this smarty plugin in Xoops to see more accurate description why this plugin exists.

Installation

To install and use this package, we recommend to use Composer:

composer require imponeer/smarty-includeq

Otherwise, you need to include manually files from src/ directory.

Registering in Smarty

If you want to use these extensions from this package in your project you need register them with registerPlugin function from Smarty. For example:

$smarty = new \Smarty();
$includeqPlugin = new \Imponeer\Smarty\Extensions\IncludeQ\IncludeQCompiler();
$smarty->registerPlugin('compiler', $includeqPlugin->getName(), [$includeqPlugin, 'execute']);

Using from templates

Example how to use it:

  {includeq file="file.tpl"}

How to contribute?

If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try interactive GitHub tutorial.

If you found any bug or have some questions, use issues tab and write there your questions.