Module:Outils
Ce module contient différentes fonctions pratiques.
Résumé des fonctions
Fonctions exportables :
trim( texte )
– 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).extractArgs( frame )
– retourne une table avec les paramètres, à partir d'un objet frame ou d'une table.validTextArg( args, name, ... )
– retourne le premier paramètre chaine non vide à partir de la table des paramètres et d'une liste de noms de paramètres.notEmpty( var, ... )
– retourne le premier élément non vide.
Détail par fonction
extractArgs
Syntaxe
Outils.extractArgs( frame )
- Si frame est une table simple et non un objet Frame, retourne
frame
- Si frame est un objet créé par
#invoke:
, retourne les paramètres passés à #invoke: (en priorité) et ceux passés au modèle.
Attention : cette fonction peut modifier la table frame.getParent().args
. S'il est probable qu'un autre module passe un objet frame
à votre fonction, il est préférable de l'indiquer dans la documentation.
Exemple
function p.maFonction( frame )
local args = Outils.extractArgs( frame )
return ( args[1] or 'nil' ) .. ' ' .. ( args[2] or 'nil' ) .. ' ' .. ( args['nom'] or 'nil' )
end
- appel par table :
p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' }
→ « oui deux Zebulon84 » - appel par
#invoke:
:{{#invoke:p |maFonction |oui |2 |nom = Zebulon84}}
→ « oui deux Zebulon84 » - appel par modèle
{{Ma fonction}}
:- le modèle contient
{{#invoke:p |maFonction}}
,{{Ma fonction|oui | deux |nom= Zebulon84}}
→ « oui deux Zebulon84 »
- le modèle contient
{{#invoke:p |maFonction |nom = Zebulon84}}
{{Ma fonction |oui | deux }}
→ « oui deux Zebulon84 »{{Ma fonction |oui | deux |nom = Hexasoft}}
→ « oui deux Zebulon84 »
- le modèle contient
{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} }}
{{Ma fonction |oui | deux }}
→ « oui deux Zebulon84 »{{Ma fonction |oui | deux |nom = Hexasoft}}
→ « oui deux Hexasoft »{{Ma fonction |oui | deux |nom = }}
→ « oui deux nil »
- le modèle contient
validTextArg
Syntaxe
Outils.validTextArg( args, name, ... )
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 nil
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
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'
notEmpty
Outils.notEmpty( var, ... )
Retourne le premier élément non vide, sinon retourne nil.
- Sont considérés comme vide :
nil, false, '', ' \t \n ', 0, { }
- Sont considérés comme non vide :
true, 'blabla', ' ', 1, { '' }, { {} }, function () end
La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (modifier).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.
local Outil = { }
-- trim nettoie un paramètre non nommé (supprime les espaces et retours ligne au début et à la fin)
-- retourne nil si le texte est vide ou n'est pas du texte. Les nombres ne sont PAS considérés comme du texte.
function Outil.trim( texte )
if type( texte ) == "string" and texte ~= "" then
return mw.text.trim( texte )
end
end
-- validArg renvoit le premier paramètre chaine non vide
-- Paramètre :
-- 1 - tableau contenant tous paramètres
-- 2, ... - les noms des paramètres qui doivent êtres testés.
function Outil.validTextArg( args, name, ... )
local texte = Outil.trim( args[name] )
if texte then
return texte
end
if select( '#', ... ) > 0 then
return Outil.validTextArg( args, ... )
end
end
-- validArg renvoie le premier paramètre non vide ou nul.
-- Paramètre :
-- 1 - tableau contenant tous paramètres
-- 2, ... - les noms des paramètres qui doivent êtres testés.
function Outil.validArg( args, name, ... )
local arg = args[name]
local targ = type( arg )
if targ == "string" and arg ~= "" then
return mw.text.trim( arg )
end
if targ == 'number' and arg ~= 0
or targ == 'table' and #arg > 0
or arg == true
then
return arg
end
if select( '#', ... ) > 0 then
return Outil.validArg( args, ... )
end
end
-- extractArgs permet de récupérer les arguements du modèle,
-- ou la table transmise à la fonction par une autre fonction d'un module
-- Paramètres :
-- 1 - un objet frame ou une table contenant les paramètre
-- 2, ... - une liste de nom de paramètre pour déterminé si les paramètres sont transmis par #invoke:
-- le premier paramètre sera systématiquement testé.
function Outil.extractArgs ( frame, ... )
if type( frame ) == 'table' then
if type( frame.getParent ) == 'function' then
if Outil.validArg( frame.args, 1, ...) then
return frame.args
else
return frame.getParent()
end
else
return frame
end
else
return { frame }
end
end
-- fonction abréviation, abréviation discrète
-- paramètres : 1 = abréviation, 2 = texte, 3 = langue, abrd = abréviation discrète
local function abr( frame )
local args = Outil.extractArgs( frame )
if args[2] == nil then
return args[1] or '' -- retoune l'abréviation ou au minimum une chaine vide s'il n'y a pas de texte
end
local wikiText = { '<abbr' }
if args.abrd then
table.insert( wikiText, ' class="abbr"' )
end
table.insert( wikiText, ' title="' )
table.insert( wikiText, args[2] )
if args[3] then
table.insert( wikiText, '" lang="' )
table.insert( wikiText, args[3] )
end
table.insert( wikiText, '">' )
table.insert( wikiText, args[1] )
table.insert( wikiText, '</abbr>' )
return table.concat( wikiText )
end
return Outil