Modifications
Module:Outils/Documentation (voir la source)
Version du 16 janvier 2019 à 02:13
, 16 janvier 2019 à 02:13cela fait un an que la fonction n'existe plus
Ce module contient différentes fonctions pratiques.
== Résumé des fonctions ==
Fonctions exportables :
* <code>trim( texte )</code> – similaire à mw.text.trim mais retourne nil lorsque la chaine est vide ou lorsque le paramètre n'est pas une chaine (ne génère pas d'erreur).
* <code>[[#extractArgs|extractArgs]]( frame, ... )</code> – retourne une table avec les paramètres, à partir d'un objet frame, d'une table ou d'une liste de paramètres.
* <code>[[#validTextArg|validTextArg]]( args, name, ... )</code> – retourne le premier paramètre chaine non vide à partir de la table des paramètres et d'une liste de noms de paramètres.
* <code>[[#notEmpty|notEmpty]]( var, ... )</code> – retourne le premier élément non vide.
== Détail par fonction ==
=== extractArgs ===
====== Syntaxe ======
<code>Outils.extractArgs( frame, ... )</code>
* Si frame n'est pas une table, retourne <code>{ frame, ... }</code>
* Si frame est une table simple et non un [[:mw:Extension:Scribunto/Lua reference manual/fr#L'objet Frame|objet Frame]], retourne <code>frame</code>
* Si frame est un objet créé par <code>#invoke:</code>, retourne les paramètres passés à #invoke: (en priorité) et ceux passés au modèle. Si le paramètre <code>invokeArgsOnly </code> n'est pas vide, seul les paramètres transmis à invoke seront utilisés.
'''Attention''' : cette fonction peut modifier la table <code>frame.getParent().args</code>. S'il est probable qu'un autre module passe un objet <code>frame</code> à votre fonction, il est préférable de l'indiquer dans la documentation.
====== Exemple ======
<source lang=lua>
function p.maFonction( frame, ... )
local args = Outils.extractArgs( frame, ... )
return ( args[1] or 'nil' ) .. ' ' .. ( args[2] or 'nil' ) .. ' ' .. ( args['nom'] or 'nil' )
end
</source>
* appel direct : <code>p.maFonction( 'oui', 'deux', 'Zebulon84' )</code> → « oui deux nil » (impossible de transmettre un paramètre nommé)
*
* appel par table : <code>p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' }</code> → « oui deux Zebulon84 »
*
* appel par <code>#invoke:</code> : <code><nowiki>{{#invoke:p |maFonction |oui |2 |nom = Zebulon84}}</nowiki></code> → « oui deux Zebulon84 »
*
* appel par modèle <code><nowiki>{{Ma fonction}}</nowiki></code> :
** le modèle contient <code><nowiki>{{#invoke:p |maFonction}}</nowiki></code>,
***<code><nowiki>{{Ma fonction|oui | deux |nom= Zebulon84}}</nowiki></code> → « oui deux Zebulon84 »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = Zebulon84}}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « oui deux Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « oui deux Zebulon84 »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} }}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « oui deux Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « oui deux Hexasoft »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = }}</nowiki></code> → « oui deux nil »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} |invokeArgsOnly = oui}}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « nil nil Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « nil nil Hexasoft»
=== validTextArg ===
====== Syntaxe ======
<code>Outils.validTextArg( args, name, ... )</code>
Retourne args.name si c'est un texte valide.
Sinon teste les autres éléments transmis à la fonction. S'il n'y en a pas ou s'ils ne correspondent pas à un texte valide dans la table args, retourne <code>nil</code>
Cette fonction est pratique pour obtenir le contenu d'un paramètre pouvant avoir plusieurs noms.
'''Attention''' : les nombres (type 'number') ne sont pas considérés comme un texte valide.
====== exemple ======
<source lang=lua>
local args = { '1', '2', 3, nom1 = nil, nom2 = '', nom3 = 'a' }
local v1 = Outils.validTextArg( args, 'nom1' } -- v1 = nil
local v2 = Outils.validTextArg( args, 'nom1', 'nom2', 'nom3' ) -- v2 = 'a'
local v3 = Outils.validTextArg( args, 3, 2, 1 ) -- v3 = '2'
local function validArg( ... )
return Outils.validTextArg( args, ... }
end
local v4 = validArg( 'nom' ) -- v4 = nil
local v5 = validArg( 'nom2', 'nom3' ) -- v5 = 'a'
</source>
=== notEmpty ===
<code>Outils.notEmpty( var, ... )</code>
Retourne le premier élément non vide, sinon retourne nil.
* Sont considérés comme vide : {{code|nil, false, '', ' \t \n ', 0, { }|lua}}
* Sont considérés comme non vide : {{code|true, 'blabla', ' ', 1, { '' }, { {} }, function () end|lua}}
<includeonly>
{{Projet Scribunto}}
</includeonly>
<noinclude>
[[Catégorie:Documentation de module|{{BASEPAGENAME}}]]
</noinclude>
== Résumé des fonctions ==
Fonctions exportables :
* <code>trim( texte )</code> – similaire à mw.text.trim mais retourne nil lorsque la chaine est vide ou lorsque le paramètre n'est pas une chaine (ne génère pas d'erreur).
* <code>[[#extractArgs|extractArgs]]( frame, ... )</code> – retourne une table avec les paramètres, à partir d'un objet frame, d'une table ou d'une liste de paramètres.
* <code>[[#validTextArg|validTextArg]]( args, name, ... )</code> – retourne le premier paramètre chaine non vide à partir de la table des paramètres et d'une liste de noms de paramètres.
* <code>[[#notEmpty|notEmpty]]( var, ... )</code> – retourne le premier élément non vide.
== Détail par fonction ==
=== extractArgs ===
====== Syntaxe ======
<code>Outils.extractArgs( frame, ... )</code>
* Si frame n'est pas une table, retourne <code>{ frame, ... }</code>
* Si frame est une table simple et non un [[:mw:Extension:Scribunto/Lua reference manual/fr#L'objet Frame|objet Frame]], retourne <code>frame</code>
* Si frame est un objet créé par <code>#invoke:</code>, retourne les paramètres passés à #invoke: (en priorité) et ceux passés au modèle. Si le paramètre <code>invokeArgsOnly </code> n'est pas vide, seul les paramètres transmis à invoke seront utilisés.
'''Attention''' : cette fonction peut modifier la table <code>frame.getParent().args</code>. S'il est probable qu'un autre module passe un objet <code>frame</code> à votre fonction, il est préférable de l'indiquer dans la documentation.
====== Exemple ======
<source lang=lua>
function p.maFonction( frame, ... )
local args = Outils.extractArgs( frame, ... )
return ( args[1] or 'nil' ) .. ' ' .. ( args[2] or 'nil' ) .. ' ' .. ( args['nom'] or 'nil' )
end
</source>
* appel direct : <code>p.maFonction( 'oui', 'deux', 'Zebulon84' )</code> → « oui deux nil » (impossible de transmettre un paramètre nommé)
*
* appel par table : <code>p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' }</code> → « oui deux Zebulon84 »
*
* appel par <code>#invoke:</code> : <code><nowiki>{{#invoke:p |maFonction |oui |2 |nom = Zebulon84}}</nowiki></code> → « oui deux Zebulon84 »
*
* appel par modèle <code><nowiki>{{Ma fonction}}</nowiki></code> :
** le modèle contient <code><nowiki>{{#invoke:p |maFonction}}</nowiki></code>,
***<code><nowiki>{{Ma fonction|oui | deux |nom= Zebulon84}}</nowiki></code> → « oui deux Zebulon84 »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = Zebulon84}}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « oui deux Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « oui deux Zebulon84 »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} }}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « oui deux Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « oui deux Hexasoft »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = }}</nowiki></code> → « oui deux nil »
** le modèle contient <code><nowiki>{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} |invokeArgsOnly = oui}}</nowiki></code>
*** <code><nowiki>{{Ma fonction |oui | deux }}</nowiki></code> → « nil nil Zebulon84 »
*** <code><nowiki>{{Ma fonction |oui | deux |nom = Hexasoft}}</nowiki></code> → « nil nil Hexasoft»
=== validTextArg ===
====== Syntaxe ======
<code>Outils.validTextArg( args, name, ... )</code>
Retourne args.name si c'est un texte valide.
Sinon teste les autres éléments transmis à la fonction. S'il n'y en a pas ou s'ils ne correspondent pas à un texte valide dans la table args, retourne <code>nil</code>
Cette fonction est pratique pour obtenir le contenu d'un paramètre pouvant avoir plusieurs noms.
'''Attention''' : les nombres (type 'number') ne sont pas considérés comme un texte valide.
====== exemple ======
<source lang=lua>
local args = { '1', '2', 3, nom1 = nil, nom2 = '', nom3 = 'a' }
local v1 = Outils.validTextArg( args, 'nom1' } -- v1 = nil
local v2 = Outils.validTextArg( args, 'nom1', 'nom2', 'nom3' ) -- v2 = 'a'
local v3 = Outils.validTextArg( args, 3, 2, 1 ) -- v3 = '2'
local function validArg( ... )
return Outils.validTextArg( args, ... }
end
local v4 = validArg( 'nom' ) -- v4 = nil
local v5 = validArg( 'nom2', 'nom3' ) -- v5 = 'a'
</source>
=== notEmpty ===
<code>Outils.notEmpty( var, ... )</code>
Retourne le premier élément non vide, sinon retourne nil.
* Sont considérés comme vide : {{code|nil, false, '', ' \t \n ', 0, { }|lua}}
* Sont considérés comme non vide : {{code|true, 'blabla', ' ', 1, { '' }, { {} }, function () end|lua}}
<includeonly>
{{Projet Scribunto}}
</includeonly>
<noinclude>
[[Catégorie:Documentation de module|{{BASEPAGENAME}}]]
</noinclude>