Modifications
Module:Outils/Documentation (voir la source)
Version du 22 avril 2020 à 15:59
, 22 avril 2020 à 15:59Bot: remplacer la balise <source> obsolète et le paramètre "enclose" [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html]
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, ou 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.
=== 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 syntaxhighlight 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
</sourcesyntaxhighlight>
* appel par table : <code>p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' }</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 »
=== validTextArg ===
====== exemple ======
<source syntaxhighlight lang="lua">
local args = { '1', '2', 3, nom1 = nil, nom2 = '', nom3 = 'a' }
local v1 = Outils.validTextArg( args, 'nom1' } -- v1 = nil
local v4 = validArg( 'nom' ) -- v4 = nil
local v5 = validArg( 'nom2', 'nom3' ) -- v5 = 'a'
</sourcesyntaxhighlight>
=== notEmpty ===
* 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}}
{{Projet Scribunto}}
<includeonly>
</includeonly>