Smarty - Engin de template

Sortit en janvier 2001, Smarty est devenue un projet stagnant et contenant encore beaucoup de bug. De plus est, Smarty est devenu, aujourd’hui, l’engin de template PHP le plus populaire et le plus utiliser. Mais cela ne devrait pas être le cas. Cet article est pour avertir les développeurs de ne pas utiliser cet engin et utiliser des alternatives qui sont de loin supérieures.

Cette articles est aussi, en partie, une traduction dans mes propres mots du site anglais nosmarty.net

Est-ce que SMARTY est bon pour moi?

Il ne faut pas se fier au nom de l’engin, car SMARTY n’est pas la solution la plus intelligente disponible actuellement. C’est vrai que SMARTY a recu plusieurs mentions année après année. Mais quoi qu’il en soit, la plupart d’entre eux on été écrit par des développeur qui n’était vraisemblablement pas familier avec une architecture multi-tier. Pour ces utilisateurs, le concept de séparation de la logique et de la présentation est un concept innovateur. Mais SMARTY est seulement une façon pour parvenir a faire cette séparation (qui ne fait pas très bien d’ailleurs) et aujourd’hui totalement dépasser par les autres produits existants.

SMARTY a sur son site web une liste des bénéfices (en anglais). Allons voir quelque un de ces bénéfices et descendons-les de leurs piédestaux.

Caching

Voici ce que SMARTY dit (en anglais) :

Smarty provides fine-grained caching features for caching all or parts of a rendered web page, or leaving parts uncached. Programmers can register template functions as cacheable or non-cachable, group cached pages into logical units for easier management, etc.

OK. Alors, jetons un oeil au système de cache de Smarty. Pour activer le cache, vous allez écrire quelque chose comme :

$smarty = new Smarty();
$smarty->caching = 1;

Cela configure le cache avec un temps de vie de 3600 secondes (1 heure). Comment faire alors si vous voulez utiliser un TTL, disons, de 30 minutes? Vous allez écrire :

$smarty = new Smarty();
$smarty->caching = 2;
$smarty->cache_lifetime = 1800;

Oh, évidement, $smarty->caching = 2;. Quoi d’autre cela aurait pu être? Bien… une constante aux lieux d’un nombre magique aurait été, bien mieux je crois. Mais attendez, pourquoi le TTL dépend qu’un nombre magique soit configuré pour pouvoir s’appliquer? Si caching est accessible directement par une propriété publique de Smarty, ne devrait-il pas être au moins un boulean, soit vrai ou faux?

Il y a plusieurs casse-têtes comme cela un peu partout dans Smarty. Le fait que ce soit non intuitif à un impacte réelle sur notre usage au jour le jour de Smarty, car nous sommes forcés de nous référer à la documentation encore et encore pour des choses souvent très courantes.

La syntaxe n’est pas le seul problème. Utiliser le cache de Smarty dans un environnement avec plusieurs serveurs peut s’avérer un vrai mal de tête, car les fichiers générés ne peuvent pas être réutilisés par un autre serveur sauf s’il utilise des systèmes de fichier en cluster comme GFS ou OCFS.

Configuration

Jetons un oeil à la configuration (en anglais) :

Smarty can assign variables pulled from configuration files. Template designers can maintain values common to several templates in one location without intervention from the programmer, and config variables can easily be shared between the programming and presentation portions of the application.

Smarty vous permet de sauvegarder vos fichiers de configuration en format INI et ensuite les charger. Il y a déja une fonction php pour cela. Elle s’appelle parse_ini_file(). Sauf si vous êtes résistant a utiliser php dans vos template de vue, le chargement des configurations dois ce faire dans la partit logique de toute façons. (Incidemment, Smarty n’utilise pas cette fonction, il opte plutôt pour sont propre mécanisme de traitement pour aucune raison apparente).

Sécurité

Et maintenant la sécurité (toujours en anglais):

Templates do not contain PHP code. Therefore, a template designer is not unleashed with the full power of PHP, but only the subset of functionality made available to them from the programmer (application code.)

Ne penser jamais qu’une application est plus sécuritaire simplement parce que sont engin de template assure qu’il sécurise votre application. La seul sécurité que vous pouvez avoir c’est de désactiver le tag {php} et cela entraîne une augmentation énorme de l’inflexibilité qu’aura votre designer de template. Il faudra alors que votre développeur PHP développe de nombreux plug-ins au fur et à mesure que votre designer de template progressera. La plupart des sites qui utilise Smarty avec le tag {php} activé pour éviter d’avoir a faire milles courbettes pour arriver à leur résultat. Donc où est la véritable sécurité dans Smarty?

De toutes façons, aujourd’hui, les trous de sécurité les plus courants ne viennent pas des templates, mais des développeurs paresseux qui ne filtre pas les données entrantes. Si vous avez un trou de sécurité dans un template, je vous conseille de changer de développeur! La meilleure sécurité se trouve dans un bon développeur consciencieux!

Facile à utiliser et à maintenir

Smarty dit ceci à propos de sa facilité d’utilisation (encore et toujours en anglais) :

Web page designers are not dealing with PHP code syntax, but instead an easy-to-use templating syntax not much different than plain HTML. The templates are a very close representation of the final output, dramatically shortening the design cycle.

Par le passé, j’ai personnellement beaucoup utilisé Smarty. La syntax est relativement facile et on pouvais bien voir la séparation du html et de la syntax Smarty. J’ai appris Smarty, car j’utilisais le CMS XOOPS. Un système de portail évoluer qui existant sous PHP4. J’ai après PHP avec ce portail. Bien évidemment, ce portail utilisait Smarty comme engin de template. Cela m’aidait beaucoup dans le développement de nouveau thème pour ce CMS. Enfin, c’est ce que je croyais!

Mais regardons un peu cette syntaxe.

{$foo}

Ce n’est pas vraiment plus compliquer à utiliser et à maintenir que :

<?= $foo ?>

Bon ok. 3 caractères de plus. Mais comparer à toute la compilation qu’il va faire pour traiter {$foo}, c’est pas sa qui devrais vous faire reculer.

Et Smarty demontre qu’il n’est pas facile a maintenir en comparaisons :

<?= foo ?>

Va afficher « foo », vous donnant un indice que vous vouliez imprimer une variable, mais qu’il vous manque un signe de $ et puis

{foo}

Qui va afficher… rien! Vous laissant complètement dans ignorance que vous avez oublié le signe $.

Et quand vous assignez une variables :

{assign var=”foo” value=”bar”}

c’est certainement plus facile a lire et plus intuitif que

<?php $foo = ‘bar’; ?>

Bien sûr ce ne sont que des exemples très basiques. Le vrai test de syntaxe entre PHP et Smarty c’est avec une approche plus complexe par exemple :

{capture assign=”foo”}{my_helper var1=”bar” var2=”qux”}{/capture}

qui est un peu trop bizarre pour les nouveaux utilisateurs comparés a quelque chose comme dans une application MVC :

<?php $foo = $this->myHelper(‘bar’, ‘qux’); ?>

Qui va être beaucoup plus intuitif et facile a comprendre.

« Variable Modifiers »

The content of assigned variables can easily be adjusted at display-time with modifiers, such as displaying in all upper-case, html-escaped, formatting dates, truncating text blocks, adding spaces between characters, etc. Again, this is accomplished with no intervention from the programmer.

L’idée des « variable modifiers » est d’aider le monteur HTML a ne pas avoir a recourir au programmeur php pour faire ses templates. Smarty vient avec 22 de ces modifiés, mais le programmeur devra en créer plusieurs autres pour atteindre cet objectif. Et il y aura toujours de nouvelle demande, encore et encore, et au final, vous activerez {php} car ce sera moins compliqué.

Fonction de template, Filtre, Plugins et Add-ons

Many functions are available to the template designer to handle tasks such as generating HTML code segments (dropdowns, tables, pop-ups, etc.), displaying content from other templates in-line, looping over arrays of content, formatting text for e-mail output, cycling though colors, etc.

The programmer has complete control of template output and compiled template content with pre-filters, post-filters and output-filters.

Almost every aspect of Smarty is controlled through the use of plugins. They are generally as easy as dropping them into the plugin directory and then mentioning them in the template or using them in the application code. Many user-community contributions are also available. (See the plugins section of the forum and wiki.)

Many user-community contributed Add-ons are available such as Pagination, Form Validation, Drop Down Menus, Calander Date Pickers, etc. These tools help speed up the development cycle, there is no need to re-invent the wheel or debug code that is already stable and ready for deployment. (see the Add-ons section of the forum and wiki.)

Smarty a plusieurs noms pour ses aides de vue. Les aides de vue sont très pratiques, mais il existe des aides de vue bien meilleure que celle de Smarty avec un plus grand lot de fonctionnalité. La vérité c’est que les aides de vue par défaut de Smarty font le minimum pour aider le programmeur et plusieurs de ces addons contienne du code qui non pas leur place dans un engin de template. C’est le résultat d’une mauvaise séparation des logiques.

Ressources

Templates can be pulled from any number of sources by creating new resource handlers, then using them in the templates.

Mode de debug

Smarty dit ceci à propos de sont mode de débogage :

Smarty comes with a built-in debugging console so the template designer can see all of the assigned variables and the programmer can investigate template rendering speeds.

C’est de loin une interface à la Firebug. C’est simplement un dump de variable de 200 lignes et plus très difficile à suivre.

Compilation

Smarty compiles templates into PHP code behind the scenes, eliminating run-time parsing of templates.

Smarty va compiler ses templates en code PHP. Ça devrait vous donner une bonne piste! Vraiment!

Performence

Smarty performs extremely well, despite its vast feature set. Most of Smarty’s capabilities lie in plugins that are loaded on-demand. Smarty comes with numerous presentation tools, minimizing your application code and resulting in quicker, less error-prone application development/deployment. Smarty templates get compiled to PHP files internally (once), eliminating costly template file scans and leveraging the speed of PHP op-code accelerators.

Rien en PHP ne pourrait être plus rapide que PHP lui même! PHP est déjà lui même un engin de template à la base.

Conclusion

Pour conclure, si Smarty n’est pas le bon outil pour faire la job, quel autre outil puis-je utiliser? Il y a plusieurs alternatives qui font exactement ce que Smarty fait, mais encore mieux! Mon framework favori pour le moment est Zend Framework. Il supporte plusieurs types de cache, de configuration, de filtre, d’aide de vue et plus encore. Il est écrit en PHP5 et utilise PHP5 tout simplement pour ses templates. Il y aussi d’autre alternative que vous pourrez facilement trouver en faisant une petite recherche sur Google.

Mais s’il vous plait… n’utiliserplus SMARTY!

Related posts:

1. Howto setup Smarty3 Engine in Joomla!