README

Smarty IncludeQ

This library provides a rewritten version of the Smarty {include} tag variant originally developed for XOOPS CMS. The {includeq} tag offers enhanced template inclusion capabilities and is now used across various PHP-based content management systems, including ImpressCMS.

This implementation was created as a clean-room rewrite to avoid GPL licensing constraints while maintaining full compatibility with the original functionality. The plugin extends Smarty's template inclusion system with additional features specifically designed for CMS environments.

For reference, see the original XOOPS implementation to understand the historical context and requirements this plugin addresses.

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.

Setup

Modern Smarty Extension (Recommended)

For Smarty 5.x, use the modern extension system by adding the extension to your Smarty instance:

// Create a Smarty instance
$smarty = new \Smarty\Smarty();

// Register the IncludeQ extension
$smarty->addExtension(new \Imponeer\Smarty\Extensions\IncludeQ\IncludeQExtension());

Legacy Plugin Registration

For compatibility with older Smarty versions or legacy code, you can register the compiler directly:

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

Using with Dependency Injection Containers

Symfony Container

To integrate with Symfony, you can leverage autowiring:

# config/services.yaml
services:
    _defaults:
        autowire: true
        autoconfigure: true

    # Configure Smarty with the extension
    \Smarty\Smarty:
        calls:
            - [addExtension, ['@Imponeer\Smarty\Extensions\IncludeQ\IncludeQExtension']]

PHP-DI Container

With PHP-DI container:

use function DI\create;
use function DI\get;

return [
    \Smarty\Smarty::class => create()
        ->method('addExtension', get(\Imponeer\Smarty\Extensions\IncludeQ\IncludeQExtension::class))
];

League Container

If you're using League Container, you can register the extension like this:

// Create the container
$container = new \League\Container\Container();

// Register Smarty with the IncludeQ extension
$container->add(\Smarty\Smarty::class, function() {
    $smarty = new \Smarty\Smarty();
    // Configure Smarty...

    // Create and add the IncludeQ extension
    $extension = new \Imponeer\Smarty\Extensions\IncludeQ\IncludeQExtension();
    $smarty->addExtension($extension);

    return $smarty;
});

Then in your application code, you can retrieve the Smarty instance:

// Get the configured Smarty instance
$smarty = $container->get(\Smarty\Smarty::class);

Usage

The {includeq} tag provides enhanced template inclusion capabilities with support for variable passing and output assignment.

Basic Template Inclusion

Simple template inclusion:

{includeq file="header.tpl"}

Passing Variables to Included Templates

You can pass variables to the included template:

{includeq file="user_profile.tpl" user_id=123 show_avatar=true}

Assigning Output to a Variable

Capture the output of the included template into a variable:

{includeq file="sidebar.tpl" assign="sidebar_content"}
{* Now you can use $sidebar_content variable *}
<div class="main-content">
    {$sidebar_content}
</div>

Advanced Examples

Including with dynamic file names:

{includeq file="modules/{$module_name}/template.tpl" module_data=$data}

Conditional inclusion with assignment:

{if $show_sidebar}
    {includeq file="sidebar.tpl" assign="sidebar" user=$current_user}
{/if}

Including with complex variable passing:

{includeq file="product_list.tpl"
          products=$products
          show_prices=true
          currency="USD"
          per_page=20}

Development

Code Quality Tools

This project uses several tools to ensure code quality:

PHPUnit - For unit testing
```
composer test
```

PHP CodeSniffer - For coding standards (PSR-12)

composer phpcs    # Check code style
composer phpcbf   # Fix code style issues automatically

PHPStan - For static analysis
```
composer phpstan
```

Documentation

API documentation is automatically generated and available in the project's wiki. For more detailed information about the classes and methods, please refer to the project wiki.

Contributing

Contributions are welcome! Here's how you can contribute:

Fork the repository
Create a feature branch: git checkout -b feature-name
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin feature-name
Submit a pull request

Please make sure your code follows the PSR-12 coding standard and include tests for any new features or bug fixes.

If you find a bug or have a feature request, please create an issue in the issue tracker.

imponeer / smarty-includeq

Maintainers

Details