Extension:SmartyAdaptor

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

SmartyAdaptor Release status: beta
Description	Provides integration with Smarty Template Engine by providing a hook to other extensions.
Author(s)	Jean-Lou Dupont
Last Version	2.1.0
MediaWiki	1.11, 1.12
License	No license specified
Download	SVN See SVN ($Id: SmartyAdaptor.doc.wikitext 989 2008-04-07 13:35:38Z jeanlou.dupont $)

[edit] Purpose

Provides integration with Smarty Template Engine by providing a hook to other extensions.

[edit] Features

• Hook based for easy integration
  • hook smarty: used when template resource is located through the filesystem
  • hook smarty_direct: used to pass template source directly
• Debug information available on Special:Version

[edit] Configuration Notes

Two directories must be accessible and writable by PHP / WEB Server:

• $IP/smarty/cache
• $IP/smarty/compile

Where $IP is the global PHP variable denoting MediaWiki's installation path. E.g. /var/www/html/wiki

On Linux, one must use, as example,

chown apache cache

to make the directory writable for the owner apache.

[edit] Hook smarty

Other extensions use Extension:SmartyAdaptor for their templating needs through the hook smarty.

[edit] Calling Method

wfRunHooks( 'smarty', array( $name, $tpl_path, $params, &$result ) );

• $name: name of template; only useful when other extensions want to insert themselves in the chain
• $tpl_path: absolute path to the template file
• $params: array of parameters. E.g. array( 'var1' => 'value1' ... )
• $result: result

[edit] Hook smarty_direct

Other extensions use Extension:SmartyAdaptor for their templating needs through the hook smarty_direct.

[edit] Calling Method

wfRunHooks( 'smarty_direct', array( $name, $tpl_source, $params, &$result ) );

• $name: name of template; only useful when other extensions want to insert themselves in the chain
• $tpl_source: template source
• $params: array of parameters. E.g. array( 'var1' => 'value1' ... )
• $result: result

[edit] Dependencies

• StubManager extension version >= 1.2.0
• Smarty: available at official site or PEAR-Smarty

[edit] SmartyAdaptor-2.1.0 with Smarty > 2.4.2

Adaptor extension won't work unless you install Smarty into

SmartyAdaptor-2.1.0/Smarty

name smarty installation directory just "Smarty" - i.e - without version suffix.

Also smarty has moved location of main class (and maybe other things) to Smarty/libs directory so SmartyAdaptor-2.1.0 won't work "out of the box"

[edit] Installation

See the Mediawiki Extension table entry "download" above.^[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote^[2]

• Add the following to LocalSettings.php if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)^[2]:

require_once( "$IP/extensions/SmartyAdaptor/SmartyAdaptor.php" );

pear channel-discover mediawiki.googlecode.com/svn

pear install mediawiki/SmartyAdaptor

require 'MediaWiki/SmartyAdaptor/SmartyAdaptor.php';

pear upgrade pear

pear clear-cache

pear upgrade --force mediawiki/SmartyAdaptor

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feed.

[edit] Notes

[edit] Sandbox

You are invited in the author's sandbox to try-out some of his extensions.

[edit] Other Extensions From the same author

Consult User Jldupont's page.

1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
2. ↑ ^{2.0 2.1 2.2} Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
   Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] See Also

• Extension:FlowProcessor
• Extension:ClassProcessor

[edit] History