Contact : info@ackwa.fr

Récupérer les paramètres d'un Snippet

Lorsque l'on développe un Snippet, il est - en général - nécessaire de lui faire passer un ou plusieurs paramètres...

[[monSnippet?&param1=`value1`]]

Le premier réflexe pour les récupérer va être d'utiliser une structure conditionnelle du type :

$param1 = ((isset($param1) && $param1) ? $param1 : '' );

Toutefois MODX possède une méthode bien pratique qui permet de faire exactement la même chose :

$param1 = $modx->getOption('param1', $scriptProperties, 10);

Cette méthode prend trois paramètres :

  1.  Le premier, obligatoire, et le nom du paramètre du Snippet à "collecter".
  2.  Le second est le tableau "global" qui contient tous les paramètres du Snippet.
  3.  Enfin, le troisième est optionnel et permet de définir une éventuelle valeur par défaut.

NB : Ce principe est également valable pour un Plugin.

En savoir plus :

http://rtfm.modx.com/display/xPDO20/getOption
http://rtfm.modx.com/display/revolution20/How+to+Write+a+Good+Snippet