From ee6a5a5cf218204c2682127de28ba04528945c5f Mon Sep 17 00:00:00 2001 From: yannick Date: Sun, 26 Dec 2004 17:02:12 +0000 Subject: [PATCH] sync with EN & typo --- .../api-functions/api-append-by-ref.xml | 77 +++++++-------- .../programmers/api-functions/api-append.xml | 83 ++++++++-------- .../api-functions/api-assign-by-ref.xml | 45 +++++---- .../programmers/api-functions/api-assign.xml | 63 ++++++------ .../api-functions/api-clear-all-assign.xml | 45 +++++---- .../api-functions/api-clear-all-cache.xml | 49 ++++++---- .../api-functions/api-clear-assign.xml | 47 +++++---- .../api-functions/api-clear-cache.xml | 66 +++++++------ .../api-functions/api-clear-compiled-tpl.xml | 56 +++++++---- .../api-functions/api-clear-config.xml | 46 +++++---- .../api-functions/api-config-load.xml | 71 ++++++++------ .../programmers/api-functions/api-display.xml | 97 ++++++++++--------- .../programmers/api-functions/api-fetch.xml | 85 ++++++++-------- .../api-functions/api-get-config-vars.xml | 47 +++++---- .../api-get-registered-object.xml | 62 +++++++----- .../api-functions/api-get-template-vars.xml | 47 +++++---- .../api-functions/api-is-cached.xml | 80 ++++++++------- .../api-functions/api-load-filter.xml | 55 ++++++----- .../api-functions/api-register-block.xml | 81 +++++++++++----- .../api-register-compiler-function.xml | 55 +++++++---- .../api-functions/api-register-function.xml | 70 +++++++++---- .../api-functions/api-register-modifier.xml | 61 ++++++++---- .../api-functions/api-register-object.xml | 39 ++++---- .../api-register-outputfilter.xml | 46 ++++++--- .../api-functions/api-register-postfilter.xml | 46 ++++++--- .../api-functions/api-register-prefilter.xml | 46 ++++++--- .../api-functions/api-register-resource.xml | 81 +++++++++++----- .../api-functions/api-template-exists.xml | 34 ++++--- .../api-functions/api-trigger-error.xml | 40 ++++---- .../api-functions/api-unregister-block.xml | 32 +++--- .../api-unregister-compiler-function.xml | 33 ++++--- .../api-functions/api-unregister-function.xml | 47 +++++---- .../api-functions/api-unregister-modifier.xml | 47 +++++---- .../api-functions/api-unregister-object.xml | 30 +++--- .../api-unregister-outputfilter.xml | 30 +++--- .../api-unregister-postfilter.xml | 30 +++--- .../api-unregister-prefilter.xml | 30 +++--- .../api-functions/api-unregister-resource.xml | 47 +++++---- 38 files changed, 1211 insertions(+), 835 deletions(-) diff --git a/docs/fr/programmers/api-functions/api-append-by-ref.xml b/docs/fr/programmers/api-functions/api-append-by-ref.xml index 16aa5c4d..ec0d72ae 100644 --- a/docs/fr/programmers/api-functions/api-append-by-ref.xml +++ b/docs/fr/programmers/api-functions/api-append-by-ref.xml @@ -1,49 +1,44 @@ - - - append_by_ref - - - void append_by_ref - string varname - mixed var - - - void append_by_ref - string varname - mixed var - boolean merge - - - - Utilisée pour ajouter des valeurs a un template par référence plut(t que - par copie. Si vous ajoutez une variable par référence puis changez sa - valeur, le changement est aussi répercuté sur la valeur assignée. - Pour les objets, append_by_ref ne fait pas de copie en mémoire de l'objet - assigné. Voir la documentation PHP pour plus d'informations sur les - références de variable. - Si vous passez le troisième paramètre a vrai, la valeur sera fusionnée - avec le tableau courant plut(t que d'être ajoutée. - - - Note technique + + + + append_by_ref + + + + + <methodsynopsis> + <type>void</type><methodname>append_by_ref</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam> + </methodsynopsis> <para> - Le paramètre de fusion respecte les clés des tableaux, ainsi si vous - fusionnez deux tableaux indexés numériquement, ils pourront s'écraser - l'un l'autre ou donner des clés qui ne se suivent pas. Cela diffère - donc de la fonction PHP array_merge() qui supprime les clés numériques - et les renumérote. + Utilisée pour ajouter des valeurs à un template par référence plutôt que + par copie. Si vous ajoutez une variable par référence puis changez sa + valeur, le changement est aussi répercuté sur la valeur assignée. + Pour les objets, append_by_ref ne fait pas de copie en mémoire de l'objet + assigné. Voir la documentation PHP pour plus d'informations sur les + références de variable. + Si vous passez le troisième paramètre à <literal>true</literal>, la valeur + sera fusionnée avec le tableau courant plutôt que d'être ajoutée. </para> - </note> - <example> - <title>append_by_ref - + ¬e.parameter.merge; + + Exemple avec append_by_ref + +append_by_ref("Name",$myname); -$smarty->append_by_ref("Address",$address); - - +$smarty->append_by_ref("Nom",$myname); +$smarty->append_by_ref("Adresse",$address); +?> +]]> + + + + - - - append - - - void append - mixed var - - - void append - string varname - mixed var - - - void append - string varname - mixed var - boolean merge - - - - Utilisée pour ajouter un élément a un tableau assigné. Si vous utilisez - cette fonction avec une chaîne de caractères, elle est convertie en - tableau auquel on ajoute ensuite l'élément. Vous pouvez explicitement passer - des paires nom/valeur. Si vous passez le troisième paramètre - (optionel) a vrai, la valeur sera fusionnée avec le tableau plut(t que - d'être ajoutée. - - - Note technique + + + + append + + + + + <methodsynopsis> + <type>void</type><methodname>append</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>void</type><methodname>append</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam> + </methodsynopsis> <para> - Le paramètre de fusion respecte les clés des tableaux, ainsi si vous - fusionnez deux tableaux indexés numériquement, ils pourront s'écraser - l'un l'autre ou donner des clés qui ne se suivent pas. Cela diffère - donc de la fonction PHP array_merge() qui supprime les clés numériques - et les renumérote. + Utilisée pour ajouter un élément à un tableau assigné. Si vous utilisez + cette fonction avec une chaîne de caractères, elle est convertie en + tableau auquel on ajoute ensuite l'élément. Vous pouvez explicitement + passer des paires nom/valeur. Si vous passez le troisième paramètre + (optionel) à <literal>true</literal>, la valeur sera fusionnée avec le + tableau plutôt que d'être ajoutée. </para> - </note> - <example> - <title>append - + ¬e.parameter.merge; + + Exemple avec append + +append("Name","Fred"); -$smarty->append("Address",$address); +$smarty->append("Nom","Fred"); +$smarty->append("Adresse",$address); // passe un tableau associatif -$smarty->append(array("city" => "Lincoln","state" => "Nebraska")); - - +$smarty->append(array("Ville" => "Lincoln","Pays" => "Nebraska")); +?> +]]> + + + + - - - assign_by_ref - - - void assign_by_ref - string varname - mixed var - - - - Utilisée pour assigner des valeurs aux templates par référence plut(t + + + + assign_by_ref + + + + + <methodsynopsis> + <type>void</type><methodname>assign_by_ref</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour assigner des valeurs aux templates par référence plutôt que par copie. Référez-vous au manuel PHP pour une explication plus précise sur les références des variables. </para> @@ -26,13 +29,19 @@ </para> </note> <example> - <title>assign_by_ref - + Exemple avec assign_by_ref + +assign_by_ref("Name",$myname); -$smarty->assign_by_ref("Address",$address); - - +$smarty->assign_by_ref("Nom",$myname); +$smarty->assign_by_ref("Adresse",$address); +?> +]]> + + + + - - - assign - - - void assign - mixed var - - - void assign - string varname - mixed var - - - - Utilisée pour assigner des valeurs aux templates. Vous pouvez - explicitement passer des paires nom/valeur, ou des tableaux - associatifs contenant des paires nom/valeur. - - - assign - + + + + assign + + + + + <methodsynopsis> + <type>void</type><methodname>assign</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>void</type><methodname>assign</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour assigner des valeurs aux templates. Vous pouvez + explicitement passer des paires nom/valeur, ou des tableaux + associatifs contenant des paires nom/valeur. + </para> + <example> + <title>Exemple avec assign + +assign("Name","Fred"); -$smarty->assign("Address",$address); +$smarty->assign("Nom","Fred"); +$smarty->assign("Adresse",$address); // passe un tableau associatif -$smarty->assign(array("city" => "Lincoln","state" => "Nebraska")); - - +$smarty->assign(array("Ville" => "Lincoln","Pays" => "Nebraska")); +?> +]]> + + + + - - - clear_all_assign - - - void clear_all_assign - - - - - Utilisée pour effacer les valeurs de toutes les variables assignées. - - - clear_all_assign - + + + + clear_all_assign + + + + + <methodsynopsis> + <type>void</type><methodname>clear_all_assign</methodname> + <void /> + </methodsynopsis> + <para> + Utilisée pour effacer les valeurs de toutes les variables assignées. + </para> + <example> + <title>Exemple avec clear_all_assign + +clear_all_assign(); - - +$smarty->clear_all_assign(); +?> +]]> + + + + - - - clear_all_cache - - - void clear_all_cache - int expire time - - - - Utilisée pour effacer les fichiers de cache des templates. Vous pouvez passer un - paramètre optionnel afin d'indiquer l'Gge minimun que doivent avoir - les fichiers de cache pour qu'ils soient effacés. - - - clear_all_cache - + + + + clear_all_cache + + + + + <methodsynopsis> + <type>void</type><methodname>clear_all_cache</methodname> + <methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour effacer les fichiers de cache des templates. Vous pouvez passer un + paramètre optionnel afin d'indiquer l'âge minimun que doivent avoir + les fichiers de cache pour qu'ils soient effacés. + </para> + <example> + <title>Exemple avec clear_all_cache + +clear_all_cache(); - - +$smarty->clear_all_cache(); +?> +]]> + + + + - - - clear_assign - - - void clear_assign - string var - - - - Efface la valeur d'une variable assignée. Il peut s'agir - d'une simple valeur ou d'un tableau de valeur. - - - clear_assign - + + + + clear_assign + + + + + <methodsynopsis> + <type>void</type><methodname>clear_assign</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Efface la valeur d'une variable assignée. Il peut s'agir + d'une simple valeur ou d'un tableau de valeur. + </para> + <example> + <title>Exemple avec clear_assign + +clear_assign("Name"); // efface plusieurs variables -$smarty->clear_assign(array("Name","Address","Zip")); - - +$smarty->clear_assign(array("Name","Address","Zip")); +?> +]]> + + + + - - - clear_cache - - voidclear_cache - stringtemplate - stringcache id - stringcompile id - intexpire time - - - Utilisée pour nettoyer le(s) fichier(s) de cache d'un template en particulier. - Si vous avez plusieurs fichiers de cache pour ce template vous - pouvez en spécifier un en particulier en passant son identifiant - en deuxième paramètre. Vous pouvez aussi passer un identifiant - de compilation en troisième paramètre. Vous pouvez grouper des - templates ensemble afin qu'ils puissent être supprimés en groupe. - Référez-vous a la section sur le - cache - pour plus d'informations. Vous pouvez passer un quatrième paramètre - pour indiquer un Gge minimum en secondes que le fichier en cache doit - avoir avant d'être effacé. + + + + clear_cache + + + + + <methodsynopsis> + <type>void</type><methodname>clear_cache</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour nettoyer le(s) fichier(s) de cache d'un + <parameter>template</parameter> en particulier. + Si vous avez plusieurs fichiers de cache pour ce template, vous + pouvez en spécifier un en particulier en passant son identifiant + <parameter>cache_id</parameter> en deuxième paramètre. + Vous pouvez aussi passer un identifiant de compilation + <parameter>compile_id</parameter> en troisième paramètre. + Vous pouvez grouper des templates ensemble afin qu'ils puissent + être supprimés en groupe. Référez-vous a la section sur le + <link linkend="caching">cache</link> pour plus d'informations. + Vous pouvez passer un quatrième paramètre pour indiquer un âge + minimum en secondes que le fichier en cache doit avoir avant d'être effacé. </para> <example> - <title>clear_cache - + Exemple avec clear_cache + +clear_cache("index.tpl"); -// efface un fichier de cache grGce a son identifiant de cache -$smarty->clear_cache("index.tpl","CACHEID"); +// efface un fichier de cache grâce à son identifiant de cache +$smarty->clear_cache("index.tpl","CACHEID"); +?> +]]> + - + + - - - clear_compiled_tpl - - - void clear_compiled_tpl - string tpl_file - - - - Utilisée pour effacer la version compilée du template spécifié ou - de tous les templates si aucun n'est spécifié. Cette fonction - est destinée a un usage avancé et n'est pas habituellement utilisée. - - - clear_compiled_tpl - + + + + clear_compiled_tpl + + + + + <methodsynopsis> + <type>void</type><methodname>clear_compiled_tpl</methodname> + <methodparam choice="opt"><type>string</type><parameter>tpl_file</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>exp_time</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour effacer la version compilée du template spécifié ou + de tous les templates si aucun n'est spécifié. + Si vous passez uniquement un compile_id, le template compilé + correspondant à ce compile_id sera effacé. Si vous passez un + exp_time, les templates compilés plus vieux que exp_time secondes + seront effacés, par défaut, tous les templates compilés seront + effacés au vû de leurs âges. Cette fonction est destinée à un usage + avancé et n'est habituellement pas utilisée. + </para> + <example> + <title>Exemple avec clear_compiled_tpl + +clear_compiled_tpl("index.tpl"); // efface tout le contenu du répertoire des templates compilés -$smarty->clear_compiled_tpl(); - - +$smarty->clear_compiled_tpl(); +?> +]]> + + + + - - - clear_config - - voidclear_config - stringvar - - - Utilisée pour effacer toutes les variables de configuration s'étant - vues assigner une valeur. Si une variable est spécifiée, seule cette - variable est effacée. - - - clear_config - + + + + clear_config + + + + + <methodsynopsis> + <type>void</type><methodname>clear_config</methodname> + <methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour effacer toutes les variables de configuration assignées. + Si un nom de variable est spécifié, seule cette variable sera effacée. + </para> + <example> + <title>Exemple avec clear_config + +clear_config(); // efface une seule variable -$smarty->clear_config('foobar'); - - +$smarty->clear_config('foobar'); +?> +]]> + + + + - - - config_load - - voidconfig_load - stringfile - stringsection - - - Utilisée pour charger des données d'un fichier de config et les - assigner a un template. Cette fonction fonctionne exactement comme - la fonction de template config_load. - - - Note technique + + + + config_load + + + + + <methodsynopsis> + <type>void</type><methodname>config_load</methodname> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>section</parameter></methodparam> + </methodsynopsis> <para> - Comme pour Smarty 2.4.0, les variables de templates assignées - sont conservées entre chaque appel a fetch et display. - Les variables de configuration chargées avec config_load sont - globales. Les fichiers de config sont aussi compilés pour une - exécution plus rapide et respecte les réglages de <link - linkend="variable.force.compile">force_compile</link> et de <link - linkend="variable.compile.check">compile_check</link>. + Utilisée pour charger des données d'un fichier <parameter>file</parameter> + de configuration et les assigner a un template. Cette fonction fonctionne + exactement comme la fonction de template <link + linkend="language.function.config.load">config_load</link>. </para> - </note> - <example> - <title>config_load - + + Note technique + + Comme pour Smarty 2.4.0, les variables de templates assignées + sont conservées entre chaque appel à fetch() et display(). + Les variables de configuration chargées avec config_load() sont + globales. Les fichiers de configuration sont aussi compilés pour une + exécution plus rapide et respecte les réglages de force_compile et de compile_check. + + + + Exemple avec config_load + +config_load('my.conf'); // charge une section -$smarty->config_load('my.conf','foobar'); - - +$smarty->config_load('my.conf','foobar'); +?> +]]> + + + + - - - display - - voiddisplay - stringtemplate - stringcache_id - stringcompile_id - - - Utilisée pour afficher un template. Il faut fournir un type et un - chemin de ressource template - valides. Vous pouvez passer en second paramètre un identifiant - de fichier de cache. Reportez-vous a la section - cache pour plus de renseignements. - + + + + display + + + + + <methodsynopsis> + <type>void</type><methodname>display</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> <para> - Le troisième paramètre optionnel est un identifiant de compilation. - Cela s'avère utile quand vous voulez compiler différentes versions - d'un même template, pour par exemple avoir des templates - compilés séparés pour différents langages. Une autre utilité de ce - paramètre est le cas oú vous utilisez plus d'un $template_dir mais un seul - $compile_dir, car certains templates avec le même nom s'écraseraient - entre eux. Vous pouvez aussi régler la variable <link - linkend="variable.compile.id">$compile_id</link> une seule - fois au lieu de la passer a chaque appel. + Utilisée pour afficher un template. Il faut fournir un type et un + chemin de <link + linkend="template.resources">ressource template</link> + valides. Vous pouvez passer en second paramètre un identifiant + de fichier de cache. Reportez-vous à la section + <link linkend="caching">cache</link> pour plus de renseignements. </para> + ¶meter.compileid; <example> - <title>affichage - + Exemple avec display + +caching = true; -// ne fait un appel a la base de données que si le fichier +// ne fait un appel à la base de données que si le fichier // de cache n'existe pas -if(!$smarty->is_cached("index.tpl")) -{ +if(!$smarty->is_cached("index.tpl")) { // quelques données $address = "245 N 50th"; $db_data = array( - "City" => "Lincoln", - "State" => "Nebraska", - "Zip" = > "68502" - ); + "Ville" => "Lincoln", + "Pays" => "Nebraska", + "Code postal" = > "68502" + ); - $smarty->assign("Name","Fred"); - $smarty->assign("Address",$address); + $smarty->assign("Nom","Fred"); + $smarty->assign("Adresse",$address); $smarty->assign($db_data); } // display the output -$smarty->display("index.tpl"); +$smarty->display("index.tpl"); +?> +]]> + Utilisez la syntaxe des ressources templates pour afficher des fichiers en-dehors du répertoire - $template_dir + $template_dir. - - exemples de fonction d'affichage de ressources templates - + Exemples de fonction d'affichage de ressources templates + +display("/usr/local/include/templates/header.tpl"); -// chemin absolu (pareil) +// chemin absolu (mêm chose) $smarty->display("file:/usr/local/include/templates/header.tpl"); // chemin absolu Windows (on DOIT utiliser le préfixe "file:") $smarty->display("file:C:/www/pub/templates/header.tpl"); -// inclue a partir de la ressource template "db" -$smarty->display("db:header.tpl"); +// inclue à partir de la ressource template nommée "db" +$smarty->display("db:header.tpl"); +?> +]]> + - - + + - - - fetch - - stringfetch - stringtemplate - stringcache_id - stringcompile_id - - - Utilisée pour renvoyer le résultat du template plut(t que de l'afficher. - Il faut passer un type et un chemin de ressource template - valides. Vous pouvez passer un identifiant de cache en deuxième - paramètre. Reportez-vous a la section cache - pour plus de renseignements. - - - Un troisième paramètre optionnel est un identifiant de compilation. - Cela s'avère utile quand vous voulez compiler différentes versions - d'un même template, pour par exemple avoir des templates - compilés séparés pour différents langages. Une autre utilité de ce - paramètre est le cas oú vous utilisez plus d'un $template_dir - mais un seul $compile_dir, car certains templates avec le même nom - s'écraseraient entre eux. Vous pouvez aussi régler la variable $compile_id une seule - fois plut(t que de la passer a chaque appel. - - - fetch - + + + + fetch + + + + + <methodsynopsis> + <type>string</type><methodname>fetch</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour renvoyer le résultat du template plutôt que de l'afficher. + Il faut passer un type et un chemin de <link + linkend="template.resources">ressource template</link> + valides. Vous pouvez passer un identifiant de cache en deuxième + paramètre. Reportez-vous à la section <link linkend="caching">cache + </link> pour plus de renseignements. + </para> + ¶meter.compileid; + <para> + <example> + <title>Exemple avec fetch + +caching = true; -// ne fait un appel a la base de données que si le fichier +// ne fait un appel à la base de données que si le fichier // de cache n'existe pas if(!$smarty->is_cached("index.tpl")) { @@ -44,13 +42,13 @@ if(!$smarty->is_cached("index.tpl")) // quelques données $address = "245 N 50th"; $db_data = array( - "City" => "Lincoln", - "State" => "Nebraska", - "Zip" = > "68502" - ); + "Ville" => "Lincoln", + "Pays" => "Nebraska", + "Code postal" = > "68502" + ); - $smarty->assign("Name","Fred"); - $smarty->assign("Address",$address); + $smarty->assign("Nom","Fred"); + $smarty->assign("Adresse",$address); $smarty->assign($db_data); } @@ -60,9 +58,14 @@ $output = $smarty->fetch("index.tpl"); // fait quelque chose avec $output -echo $output; - - +echo $output; +?> +]]> + + + + + - - - get_config_vars - - arrayget_config_vars - stringvarname - - - Retourne la valeur de la variable de configuration passée en paramètre. - Si aucun paramètre n'est donné, un tableau de toutes les variables de - configuration chargées est renvoyé. - - - get_config_vars - + + + + get_config_vars + + + + + <methodsynopsis> + <type>array</type><methodname>get_config_vars</methodname> + <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Retourne la valeur de la variable de configuration passée en paramètre. + Si aucun paramètre n'est donné, un tableau de toutes les variables de + configuration chargées est retourné. + </para> + <example> + <title>Exemple avec get_config_vars + +get_config_vars('foo'); @@ -22,9 +29,13 @@ $foo = $smarty->get_config_vars('foo'); $config_vars = $smarty->get_config_vars(); // les affiche a l'écran -print_r($config_vars); - - +print_r($config_vars); +?> +]]> + + + + - - - get_registered_object - - - array get_registered_object - string object_name - - - - Retourne la référence d'un objet enregistré. Utile quand vous - voulez accéder directement a un objet enregistré avec une - fonction utilisateur. - - - get_registered_object - -function smarty_block_foo($params, &$smarty) { - if (isset[$params['object']]) { - // récupère la référence de l'objet enregistré - $obj_ref =& $smarty->get_registered_object($params['object']); - // $obj_ref est maintenant une référence vers l'objet - } -} - - + + + + get_registered_object + + + + + <methodsynopsis> + <type>array</type><methodname>get_registered_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + </methodsynopsis> + <para> + Retourne la référence d'un objet enregistré. Utile quand vous + voulez accéder directement à un objet enregistré avec une + fonction utilisateur. + </para> + <example> + <title>Exemple avec get_registered_object + +get_registered_object($params['object']); + // $obj_ref est maintenant une référence vers l'objet + } +} +?> +]]> + + + + - - - get_template_vars - - arrayget_template_vars - stringvarname - - - Retourne la valeur assignée passée en paramètre. Si aucun paramètre - n'est donné, un tableau de toutes les variables assignées est - renvoyé. - - - get_template_vars - + + + + get_template_vars + + + + + <methodsynopsis> + <type>array</type><methodname>get_template_vars</methodname> + <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Retourne la valeur assignée passée en paramètre. Si aucun paramètre + n'est donné, un tableau de toutes les variables assignées est + retourné. + </para> + <example> + <title>Exemple avec get_template_vars + +get_template_vars('foo'); @@ -23,9 +30,13 @@ $foo = $smarty->get_template_vars('foo'); $tpl_vars = $smarty->get_template_vars(); // les affiche a l'écran -print_r($tpl_vars); - - +print_r($tpl_vars); +?> +]]> + + + + - - - is_cached - - - void is_cached - string template - [string cache_id] - - - - Retourne vrai s'il y a un fichier de cache valide pour ce template. - Cela fonctionne seulement si caching est a vrai. - - - is_cached + + + + is_cached + + + + + <methodsynopsis> + <type>bool</type><methodname>is_cached</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam> + </methodsynopsis> + <para> + Retourne &true; s'il y a un fichier de cache valide pour ce template. + Celà fonctionne seulement si <link + linkend="variable.caching">caching</link> est défini à <literal>true</literal>. + </para> + <example> + <title>Exemple avec is_cached display("index.tpl"); ?> ]]> - + - Vous pouvez aussi passer en second paramètre un identifiant - de cache au cas oú vous voudriez plusieurs fichiers de cache - pour ce template. + Vous pouvez aussi passer en second paramètre un identifiant + de cache au cas où vous voudriez plusieurs fichiers de cache + pour ce template. Vous pouvez donner un identifiant de compilation en tant que troisième paramètre. @@ -45,8 +49,8 @@ $smarty->display("index.tpl"); Si vous voulez utiliser un identifiant de compilation sans utilisez d'identifiant de cache, mettez null pour l'identifiant de cache. - - is_cached avec plusieurs templates + + Exemple avec is_cached et plusieurs templates display("index.tpl", "FrontPage"); ?> ]]> - + + - Note technique - - Si is_cached retourne vrai, il charge en fait le cache existant et - le stocke en interne. Tout appel supplémentaire à display() ou - fetch() retournera ce contenu stocké en interne - sans tenter de recharger le fichier en cache. Cela évite des problématiques d'accès concurents, - lorsqu'un second processus efface le cache entre l'appel de is_cached et l'appel à display dans - l'un de nos exemples ci-dessus. Cela signifie également que les appels à clear_cache() - et les changements de paramètres du cache peuvent n'avoir aucun effet alors que is_cached - à retourné vrai. - + Note technique + + Si is_cached retourne vrai, il charge en fait le cache existant et + le stocke en interne. Tout appel supplémentaire à + display() ou + fetch() retournera ce contenu stocké en interne + sans tenter de recharger le fichier en cache. Celà évite des problématiques d'accès concurents, + lorsqu'un second processus efface le cache entre l'appel de is_cached et l'appel à display + comme dans l'un de nos exemples ci-dessus. Cela signifie également que les appels à + clear_cache() + et les changements de paramètres du cache peuvent n'avoir aucun effet alors que + is_cached a retourné vrai. + - + + - - - load_filter - - - void load_filter - string type - string name - - - - Cette fonction peut être utilisée pour charger un plugin - de filtrage. Le premier argument spécifie le type du filtre - et peut prendre l'une des valeurs suivantes : 'pre', 'post' - ou 'output'. Le second argument spécifie le nom du plugin - de filtrage, par exemple 'trim'. - - - Chargement de plugins de filtrage - + + + + load_filter + + + + + <methodsynopsis> + <type>void</type><methodname>load_filter</methodname> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Cette fonction peut être utilisée pour charger un plugin + de filtrage. Le premier argument spécifie le type du filtre + et peut prendre l'une des valeurs suivantes : 'pre', 'post' + ou 'output'. Le second argument spécifie le nom du plugin + de filtrage, par exemple 'trim'. + </para> + <example> + <title>Chargement de plugins de filtrage + +load_filter('pre', 'trim'); // charge le filtre 'trim' de type 'pre' $smarty->load_filter('pre', 'datefooter'); // charge un autre filtre de type 'pre' appelé 'datefooter' -$smarty->load_filter('output', 'compress'); // charge le filtre 'compress' de type 'output' - - +$smarty->load_filter('output', 'compress'); // charge le filtre 'compress' de type 'output' +?> +]]> + + + + - - - register_block - - - void register_block - string name - string impl - - - - Utilisée pour déclarrer dynamiquement des plugins de fonction - de blocs. Il faut passer en paramètre le nom de la fonction - de blocs, suivi du nom de la fonction PHP qui l'implémente. - - - register_block - -/* PHP */ + + + + register_block + + + + + <methodsynopsis> + <type>void</type><methodname>register_block</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam><type>bool</type><parameter>cacheable</parameter></methodparam> + <methodparam><type>mixed</type><parameter>cache_attrs</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement des plugins de fonction + de blocs. Il faut passer en paramètre le nom de la fonction + de blocs, suivi du nom de la fonction PHP qui l'implémente. + </para> + <para> + La fonction PHP <parameter>impl</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + <para> + Les paramètre <parameter>cacheable</parameter> et + <parameter>cache_attrs</parameter> peuvent être omis dans la plupart + des cas. Voir <link + linkend="caching.cacheable">Contrôler la mise en cache des sorties des Plugins</link> + pour plus d'informations concernant cette utilisation. + </para> + <example> + <title>Exemple avec register_block + +register_block("translate", "do_translation"); function do_translation ($params, $content, &$smarty) { @@ -28,13 +51,23 @@ function do_translation ($params, $content, &$smarty) { echo $translation; } } - +?> +]]> + + + Le template Smarty : + + + - - +Hello, world! +{/translate} +]]> + + + + - - - register_compiler_function - - - void register_compiler_function - string name - string impl - - - - Utilisée pour déclarer dynamiquement un plugin de fonction - de compilation. Il faut passer en paramètres le nom de la fonction - de compilation, suivi par la fonction PHP qui - l'implémente. - - + + + + register_compiler_function + + + + + <methodsynopsis> + <type>bool</type><methodname>register_compiler_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam><type>bool</type><parameter>cacheable</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement un plugin de fonction + de compilation. Il faut passer en paramètres le nom de la fonction + de compilation, suivi par la fonction PHP qui + l'implémente. + </para> + <para> + La fonction PHP <parameter>impl</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + <para> + Le paramètre <parameter>cacheable</parameter> peut être omis dans la + plupart des cas. Voir <link + linkend="caching.cacheable">Contrôler la mise en cache des sorties des Plugins</link> + pour plus d'informations concernant cette utilisation. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-register-function.xml b/docs/fr/programmers/api-functions/api-register-function.xml index 7560f35c..347e2eb4 100644 --- a/docs/fr/programmers/api-functions/api-register-function.xml +++ b/docs/fr/programmers/api-functions/api-register-function.xml @@ -1,23 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.register.function"> - <title>register_function - - - void register_function - string name - string impl - - - - Utilisée pour déclarer dynamiquement des plugins de fonction - de templates. Il faut passer en paramètres le nom de la fonction - de templates, suivi par le nom de la fonction PHP qui l'implémente. - - - register_function - + + + + register_function + + + + + <methodsynopsis> + <type>void</type><methodname>register_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>cacheable</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>cache_attrs</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement des plugins de fonction + de templates. Il faut passer en paramètres le nom de la fonction + de templates, suivi par le nom de la fonction PHP qui l'implémente. + </para> + <para> + La fonction PHP <parameter>impl</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + <para> + Les paramètres <parameter>cacheable</parameter> et + <parameter>cache_attrs</parameter> peut être omis dans la + plupart des cas. Voir <link + linkend="caching.cacheable">Contrôler la mise en cache des sorties des Plugins</link> + pour plus d'informations concernant cette utilisation. + </para> + <example> + <title>Exemple avec register_function + +register_function("date_now", "print_current_date"); function print_current_date ($params) { @@ -29,9 +53,13 @@ function print_current_date ($params) { // vous pouvez maintenant utiliser ceci dans Smarty pour afficher // la date actuelle : {date_now} ou {date_now format="%Y/%m/%d"} -// pour la formater - - +// pour la formater +?> +]]> + + + + - - - register_modifier - - - void register_modifier - string name - string impl - - - - Utilisée pour déclarer dynamiquement un plugin de modificateur. - Il faut passer en paramètre le nom du modificateur de variables, - suivi de la fonction PHP qui l'implémente. - - - register_modifier - + + + + register_modifier + + + + + <methodsynopsis> + <type>void</type><methodname>register_modifier</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>impl</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement un plugin de modificateur. + Il faut passer en paramètre le nom du modificateur de variables, + suivi de la fonction PHP qui l'implémente. + </para> + <para> + La fonction PHP <parameter>impl</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + <example> + <title>register_modifier + +register_modifier("sslash","stripslashes"); -// vous pouvez maintenant utiliser {$var|sslash} pour supprimer les slash des variables - - +// vous pouvez maintenant utiliser {$var|sslash} pour supprimer les slash des variables +?> +]]> + + + + - - - register_object - - - void register_object - string object_name - object $object - array allowed methods/properties - boolean format - - - - Utilisée pour enregistrer un objet a utiliser dans un template. - Reportez-vous a la section - objet de + + + + register_object + + + + + <methodsynopsis> + <type>void</type><methodname>register_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + <methodparam><type>array</type><parameter>allowed_methods_properties</parameter></methodparam> + <methodparam><type>boolean</type><parameter>format</parameter></methodparam> + <methodparam><type>array</type><parameter>block_methods</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour enregistrer un objet à utiliser dans un template. + Reportez-vous a la section + <link linkend="advanced.features.objects">objet</link> de ce manuel pour des exemples. </para> - </sect1> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-register-outputfilter.xml b/docs/fr/programmers/api-functions/api-register-outputfilter.xml index f1c8b80d..f30dbffb 100644 --- a/docs/fr/programmers/api-functions/api-register-outputfilter.xml +++ b/docs/fr/programmers/api-functions/api-register-outputfilter.xml @@ -1,21 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.register.outputfilter"> - <title>register_outputfilter - - - void register_outputfilter - string function_name - - - - Utilisée pour déclarer dynamiquement des filtres de sortie, pour - agir sur la sortie d'un template avant qu'elle ne soit affichée. - Reportez-vous a la section - filtres de sortie pour plus d'information sur le sujet. - - + + + + register_outputfilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_outputfilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement des filtres de sortie, pour + agir sur la sortie d'un template avant qu'il ne soit affiché. + Reportez-vous à la section <link linkend="advanced.features.outputfilters"> + filtres de sortie</link> pour plus d'information sur le sujet. + </para> + <para> + La fonction PHP <parameter>function</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-register-postfilter.xml b/docs/fr/programmers/api-functions/api-register-postfilter.xml index 76583146..ddd64241 100644 --- a/docs/fr/programmers/api-functions/api-register-postfilter.xml +++ b/docs/fr/programmers/api-functions/api-register-postfilter.xml @@ -1,23 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.register.postfilter"> - <title>register_postfilter - - - void register_postfilter - string function_name - - - - Utilisée pour déclarer dynamiquement des filtres de post-compilation pour y faire - passer des templates une fois qu'ils ont été compilés. Reportez-vous - a la section - filtres de post-compilation de templates - pour avoir plus de renseignements sur la faton de paramétrer les fonctions + + + + register_postfilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_postfilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement des filtres de post-compilation pour y faire + passer des templates une fois qu'ils ont été compilés. Reportez-vous + à la section + <link linkend="advanced.features.postfilters">filtres de post-compilation de templates</link> + pour avoir plus de renseignements sur la façon de paramétrer les fonctions de post-compilation. </para> - </sect1> + <para> + La fonction PHP <parameter>function</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-register-prefilter.xml b/docs/fr/programmers/api-functions/api-register-prefilter.xml index 3011963a..9ccbdb64 100644 --- a/docs/fr/programmers/api-functions/api-register-prefilter.xml +++ b/docs/fr/programmers/api-functions/api-register-prefilter.xml @@ -1,23 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.register.prefilter"> - <title>register_prefilter - - - void register_prefilter - string function_name - - - - Utilisée pour déclarer dynamiquement des filtres de pré-compilation pour y faire - passer des templates avant qu'ils ne soient compilés. Reportez-vous - a la section - filtres de pré-compilation de templates - pour avoir plus de renseignements sur la faton de paramétrer les fonctions + + + + register_prefilter + + + + + <methodsynopsis> + <type>void</type><methodname>register_prefilter</methodname> + <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement des filtres de pré-compilation pour y faire + passer des templates avant qu'ils ne soient compilés. Reportez-vous + à la section + <link linkend="advanced.features.postfilters">filtres de pré-compilation de templates</link> + pour avoir plus de renseignements sur la façon de paramétrer les fonctions de pré-compilation. </para> - </sect1> + <para> + La fonction PHP <parameter>function</parameter> peut être soit (a) une + chaîne de caractères contenant le nom de la fonction, soit (b) un tableau + de la forme <literal>array(&$object, $method)</literal> où + <literal>&$object</literal> est une référence à un objet et + <literal>$method</literal> est le nom de la méthode, soit (c) un + tableau de la forme <literal>array(&$class, $method)</literal> où + <literal>$class</literal> est le nom de la classe et + <literal>$method</literal> est une méthode de cette classe. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-register-resource.xml b/docs/fr/programmers/api-functions/api-register-resource.xml index e3ccbf34..1ee21396 100644 --- a/docs/fr/programmers/api-functions/api-register-resource.xml +++ b/docs/fr/programmers/api-functions/api-register-resource.xml @@ -1,32 +1,61 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.register.resource"> - <title>register_resource - - - void register_resource - string name - array resource_funcs - - - - Utilisée pour déclarer dynamiquement une ressource plugin - dans Smarty. Il faut passer en paramètre le nom de la ressource - et le tableau des fonctions PHP qui l'implémentent. Reportez-vous - a la section ressources templates - pour avoir plus d'informations sur la faton de paramétrer une fonction - récupérant des templates. - - - register_resource - + + + + register_resource + + + + + <methodsynopsis> + <type>void</type><methodname>register_resource</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>array</type><parameter>resource_funcs</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour déclarer dynamiquement une ressource plugin + dans Smarty. Il faut passer en paramètre le nom de la ressource + et le tableau des fonctions PHP qui l'implémentent. Reportez-vous + a la section <link linkend="template.resources">ressources templates</link> + pour avoir plus d'informations sur la faton de paramétrer une fonction + récupérant des templates. + </para> + <note> + <title>Note technique + + Un nom de ressource doit être composé d'au moins deux caractères. + Les noms de ressources d'un seul caractère seront ignorés et utilisés + comme étant une partie du chemin du fichier, comme avec + $smarty->display('c:/path/to/index.tpl'); + + + + Le tableau de fonctions PHP resource_funcs + doit être composé de 4 ou 5 éléments. S'il est composé de 4 éléments, + les éléments seront les noms de fonctions pour, respectivement, + "source", "timestamp", "secure" et "trusted" de la ressource. + S'il est composé de 5 éléments, le premier élément devra être une + référence sur un objet ou le nom d'une classe de l'objet ou une classe + implémentant la ressource et les 4 éléments suivants doivent être + les noms des méthodes implémentant "source", "timestamp", + "secure" et "trusted". + + + Exemple avec register_resource + +register_resource("db", array("db_get_template", - "db_get_timestamp", - "db_get_secure", - "db_get_trusted")); - - +"db_get_timestamp", +"db_get_secure", + "db_get_trusted")); +?> +]]> + + + + - - - template_exists - - - bool template_exists - string template - - - - Cette fonction vérifie si le template spécifié existe. Elle accepte - soit un chemin vers le template, soit une ressource de type - chaene de caractères précisant le nom du template. - - + + + + template_exists + + + + + <methodsynopsis> + <type>bool</type><methodname>template_exists</methodname> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + </methodsynopsis> + <para> + Cette fonction vérifie si le template spécifié existe. Elle accepte + soit un chemin vers le template, soit une ressource de type + chaîne de caractères spécifiant le nom du template. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-trigger-error.xml b/docs/fr/programmers/api-functions/api-trigger-error.xml index 80a600a4..d29c4ae8 100644 --- a/docs/fr/programmers/api-functions/api-trigger-error.xml +++ b/docs/fr/programmers/api-functions/api-trigger-error.xml @@ -1,23 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.trigger.error"> - <title>trigger_error - - - void trigger_error - string error_msg - [int level] - - - - Cette fonction peut-être utilisée pour afficher un message d'erreur - en utilisant Smarty. Le paramètre level - peut prendre l'une des valeures utilisées par la fonction PHP - trigger_error, i.e. E_USER_NOTICE, E_USER_WARNING, etc. Par défaut - il s'agit de E_USER_WARNING. - - + + + + trigger_error + + + + + <methodsynopsis> + <type>void</type><methodname>trigger_error</methodname> + <methodparam><type>string</type><parameter>error_msg</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> + <para> + Cette fonction peut-être utilisée pour afficher un message d'erreur + en utilisant Smarty. Le paramètre <parameter>level</parameter> + peut prendre l'une des valeures utilisées par la fonction PHP + trigger_error(), i.e. E_USER_NOTICE, E_USER_WARNING, etc. Par défaut + il s'agit de E_USER_WARNING. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-block.xml b/docs/fr/programmers/api-functions/api-unregister-block.xml index 58886b57..91f38385 100644 --- a/docs/fr/programmers/api-functions/api-unregister-block.xml +++ b/docs/fr/programmers/api-functions/api-unregister-block.xml @@ -1,19 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.block"> - <title>unregister_block - - - void unregister_block - string name - - - - Utilisée pour désallouer dynamiquement un plugin de fonction - de blocs. Passez en paramètre le nom du bloc. - - + + + + unregister_block + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_block</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un plugin de fonction + de blocs. Passez en paramètre le nom <parameter>name</parameter> du bloc. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-compiler-function.xml b/docs/fr/programmers/api-functions/api-unregister-compiler-function.xml index 7dcd835e..c7705bb9 100644 --- a/docs/fr/programmers/api-functions/api-unregister-compiler-function.xml +++ b/docs/fr/programmers/api-functions/api-unregister-compiler-function.xml @@ -1,19 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.compiler.function"> - <title>unregister_compiler_function - - - void unregister_compiler_function - string name - - - - Utilisée pour désallouer dynamiquement un fonction de compilation. - Passez en paramètre le nom de la fonction de compilation. - - + + + + unregister_compiler_function + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_compiler_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un fonction de compilation. + Passez en paramètre le nom <parameter>name</parameter> de + la fonction de compilation. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-function.xml b/docs/fr/programmers/api-functions/api-unregister-function.xml index 1608cd46..d648fe16 100644 --- a/docs/fr/programmers/api-functions/api-unregister-function.xml +++ b/docs/fr/programmers/api-functions/api-unregister-function.xml @@ -1,27 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.function"> - <title>unregister_function - - - void unregister_function - string name - - - - Utilisée pour désallouer dynamiquement un plugin de fonction - de templates. Passez en paramètres le nom de la fonction de templates. - - - unregister_function - + + + + unregister_function + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_function</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un plugin de fonction + de templates. Passez en paramètres le nom de la fonction de templates. + </para> + <example> + <title>Exemple avec unregister_function + +unregister_function("fetch"); - - +$smarty->unregister_function("fetch"); +?> +]]> + + + + - - - unregister_modifier - - - void unregister_modifier - string name - - - - Utilisée pour désallouer dynamiquement un plugin modificateur de variable. - Passez en paramètre le nom du modificateur de templates. - - - unregister_modifier - + + + + unregister_modifier + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_modifier</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un plugin modificateur de variable. + Passez en paramètre le nom du modificateur de templates. + </para> + <example> + <title>Exemple avec unregister_modifier + +unregister_modifier("strip_tags"); - - +$smarty->unregister_modifier("strip_tags"); +?> +]]> + + + + - - - unregister_object - - - void unregister_object - string object_name - - - - Utilisée pour désallouer un objet. - - + + + + unregister_object + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_object</methodname> + <methodparam><type>string</type><parameter>object_name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer un objet. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-outputfilter.xml b/docs/fr/programmers/api-functions/api-unregister-outputfilter.xml index 5170628a..09665315 100644 --- a/docs/fr/programmers/api-functions/api-unregister-outputfilter.xml +++ b/docs/fr/programmers/api-functions/api-unregister-outputfilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.outputfilter"> - <title>unregister_outputfilter - - - void unregister_outputfilter - string function_name - - - - Utilisée pour désallouer dynamiquement un filtre de sortie. - - + + + + unregister_outputfilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_outputfilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un filtre de sortie. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-postfilter.xml b/docs/fr/programmers/api-functions/api-unregister-postfilter.xml index 247cf4bf..3edcb0dc 100644 --- a/docs/fr/programmers/api-functions/api-unregister-postfilter.xml +++ b/docs/fr/programmers/api-functions/api-unregister-postfilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.postfilter"> - <title>unregister_postfilter - - - void unregister_postfilter - string function_name - - - - Utilisée pour désallouer dynamiquement un filtre de post-compilation. - - + + + + unregister_postfilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_postfilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un filtre de post-compilation. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-prefilter.xml b/docs/fr/programmers/api-functions/api-unregister-prefilter.xml index 35f417b4..8fd72153 100644 --- a/docs/fr/programmers/api-functions/api-unregister-prefilter.xml +++ b/docs/fr/programmers/api-functions/api-unregister-prefilter.xml @@ -1,18 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.prefilter"> - <title>unregister_prefilter - - - void unregister_prefilter - string function_name - - - - Utilisée pour désallouer dynamiquement un filtre de pré-compilation. - - + + + + unregister_prefilter + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_prefilter</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un filtre de pré-compilation. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml diff --git a/docs/fr/programmers/api-functions/api-unregister-resource.xml b/docs/fr/programmers/api-functions/api-unregister-resource.xml index 7376d33c..a05d99bc 100644 --- a/docs/fr/programmers/api-functions/api-unregister-resource.xml +++ b/docs/fr/programmers/api-functions/api-unregister-resource.xml @@ -1,24 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision$ --> -<!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> -<sect1 id="api.unregister.resource"> - <title>unregister_resource - - - void unregister_resource - string name - - - - Utilisée pour désallouer dynamiquement un plugin ressource. - Passez en paramètre le nom de la ressource. - - - unregister_resource - -$smarty->unregister_resource("db"); - - + + + + unregister_resource + + + + + <methodsynopsis> + <type>void</type><methodname>unregister_resource</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Utilisée pour désallouer dynamiquement un plugin ressource. + Passez en paramètre le nom de la ressource. + </para> + <example> + <title>Exemple avec unregister_resource + +unregister_resource("db"); +?> +]]> + + + +