Catégorie:Plugins

De Cms Made Simple France
Aller à : navigation, rechercher

Les plugins sont des petites portions de programmes php qui permettent pour la plupart à assister l'utilisateur à la rédaction des pages du site web.

La grande différence entre un module et un plugin réside dans la taille du programme. Ainsi un module sera plus approprié dans le cas de fonctionnalités très poussée nécessitant une interface utilisateur par exemple. A l'inverse, les plugins sont généralement réservé à de tout petits programmes très légers.

Notez également l'existence des Balises Utilisateurs (UDT) qui sont un équivalant aux plugins mais avec l'avantage d'être modifiable depuis l'interface d'administration de CmsMadeSimple

CmsMadeSimple est livré avec quelques plugins installés par défaut dont vous trouverez quelques explications dans la liste ci dessous


Créer son propre plugins

Avant de créer son propre plugin il est important d'avoir les connaissances requises : une bonne connaissance en PHP et éventuellement une bonne connaissance du fonctionnement de smarty.

Comme dans la majorité des cas dans CmsMadeSimple, la création d'un plugin passe par une normalisation extrême des fichiers. En voici quelques points.

Pour qu'un plugin foobar puisse être appelé depuis le gabarit d'une page sous la forme {foobar} il faut :

  • respecter le répertoire du fichier : ./plugins
  • respecter le nom du fichier : function.foobar.php
  • posséder en son sein la fonction : function smarty_cms_function_foobar($params, &$smarty)
  • posséder en son sein la fonction : function smarty_cms_help_function_foobar()
  • posséder en son sein la fonction : smarty_cms_about_function_foobar()

La première fonction est le traitement principal de votre plugin. La gestion des paramètres est simple :

{foobar param1='foo' param2='bar'}

les paramètres param1 et param2 seront utilisables dans votre code ainsi :

echo "le premier paramètre est : " . $params['param1'];
echo "le second paramètre est : " . $params['param2'];

La récupération des paramètres globaux de CmsMadeSimple sont également très simplement accessible. Ainsi récupérer la configuration du logiciel tiens en deux ligne.

global $gCms;
$config = $gCms->GetConfig();

echo "l'url de base dans le fichier config.php est : " . $config['root_url'];

Vous avez besoin de récupérer l'entité base de donnée avant de faire d'éventuelles requêtes bdd.

global $gCms;
$db =& $gCms->GetDb();

[... code sql ...]

La seconde fonction sert d'affichage d'aide à l'utilisation de votre plugin. Par exemple :

echo "Ce plugin sert à faire un truc";

La troisième fonction sert d'affichage d'historique de votre plugin. Par exemple :

echo "<p>Version 1.00</p>
  <ul>
   <li>Ajout d'un correctif</li>
   <li>Ajout d'une fonction</li>
  </ul>
";

Pages dans la catégorie « Plugins »

Cette catégorie contient 8 pages, dont les 8 ci-dessous.