TemplateEngineSmarty by wanze

This module adds the Smarty template engine to the TemplateEngineFactory

TemplateEngineSmarty

License: MIT ProcessWire 3

A ProcessWire module adding Smarty to the TemplateEngineFactory.

Requirements


  • ProcessWire 3.0 or newer
  • TemplateEngineFactory 2.0 or newer
  • PHP 7.0 or newer
  • Composer

The 1.x version of this module is available on the 1.x branch. Use this version if you still use TemplateEngineFactory 1.x.

Installation


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

composer require blue-tomato/template-engine-smarty:^2.0

This will install the TemplateEngineSmarty and TemplateEngineFactory modules in one step. Afterwards, don't forget to enable Smarty 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 Smarty template files, defaults to tpl.
  • Provide ProcessWire API variables in Smarty templates API variables ($pages, $input, $config...) are accessible in Smarty, e.g. {{ config }} for the config API variable.
  • Debug If enabled, Smarty outputs debug information.
  • Compile Check If enabled, templates are recompiled whenever the source code changes.
  • Error Reporting If set to false, Smarty will silently ignore invalid variables (variables and or attributes/methods that do not exist) and replace them with a null value. When set to true, Smarty throws an exception instead
  • Escape HTML If enabled, templates will auto-escape variables. If you are using ProcessWire textformatters to escape field values, do not enable this feature.

Extending Smarty


It is possible to extend Smarty after it has been initialized by the module. Hook the method TemplateEngineSmarty::initSmarty to register custom functions, extensions, global variables, filters etc.

Here is an example how you can use the provided hook to attach a custom function.

function foo_function($params, $smarty) {
  return 'bar';
};

wire()->addHookAfter('TemplateEngineSmarty::initSmarty', function (HookEvent $event) {
    /** @var \Smarty $smarty */
    $smarty = $event->arguments('smarty');

    $smarty->registerPlugin("function", "foo", "foo_function");
});

// ... and then use it anywhere in a Smarty template:

{foo}

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.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • This week we focus in on a new and unique Inputfield module added to the core that enables a lot of useful new input capabilities for tags, sortable multiple selection and custom user input— More
    30 April 2021
  • With more than 25 commits, ProcessWire 3.0.176 resolves lots of minor issues, adds support for multiple randomly selected read-only database connections, upgrades the tag features in the Template editor, adds a useful new Tags Inputfield, and more… More
    23 April 2021
  • This week ProcessWire (3.0.175) gained the ability to maintain separate read-only and read-write database connections to optimize scalability, cost and performance. The post covers why this can be so valuable and how to configure it in ProcessWire— More
    2 April 2021

Latest news

  • ProcessWire Weekly #365
    In the 365th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called FieldtypeOembed, and more. Read on!
    Weekly.pw / 9 May 2021
  • ProcessWire 3.0.177 core updates
    This week we focus in on a new and unique Inputfield module added to the core that enables a lot of useful new input capabilities for tags, sortable multiple selection and custom user input.
    Blog / 30 April 2021
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits