Voir la source de Module:Arguments/Documentation

<includeonly>{{Shared Template Warning|Module: Arguments|Module:Arguments}}</includeonly>

== Utilisation ==
Ce module fournit la fonction <code>getArgs(frame, options)</code> permettant un traitement simplifié des arguments reçus dans un frame lors d'une invocation de module avec <code><nowiki>{{#invoke:}}</nowiki></code>. Il est prévu pour un usage par d'autres modules et non pour une invocation directe dans un modèle.

=== Fonctions exportables ===
* <code>[[Module:Arguments#L-57|getArgs(frame, options)]]</code> – Met en forme les arguments reçus dans le frame dans un tableau, dont le traitement peut être modifier selon la valeur de option. Le tableau est nommé <code>args</code> dans la liste des options ci-dessous.

{| class="wikitable"
|+ Liste des options
! scope="col" width="10em" | Nom du paramètre !! scope="col" | Type !! scope="col" | Valeur par défaut !! scope="col" | Utilisation
|-
! colspan=4 | Gestion des espaces vides
|-
| <code>trim</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>true</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, enlève les espaces au début et à la fin de chaque argument du frame.
|-
| <code>removeBlanks</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>true</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, remplace les arguments constitués d'une chaîne de caractère vide ou d'une chaîne de caractère contenant uniquement des espaces par <syntaxhighlight lang="lua" inline>nil</syntaxhighlight>.
|-
| <code>valueFunc</code> || fonction : (key, value)<br>-> formattedValue || style="text-align:center;" | / || Fonction à appliquer à chaque argument du frame, où <code>frame[key] = value</code>.<br>'''Exemple :''' fonction enlevant les arguments vides et passant les arguments en minuscule :
<syntaxhighlight lang="lua">
valueFunc = function (key, value)
	if not value then
		return nil
	end
	value = mw.ustring.lower(value)
	if mw.ustring.find(value, '%S') then
		return value
	end
	return nil
end
</syntaxhighlight>
|-
! colspan=4 | Gestion frame / parent
|-
| colspan=4 | Par défaut, ce module, récupère d'abord les arguments donnés dans l'invocation du module, puis ceux parents, généralement ceux issus de l'appel de modèle, mais <span style="color:red;">les paramètres du parent sont effacés par ceux du frame</span>.<br>Concrètement, si un modèle ModèleExemple contient le code <code><nowiki>{{#invoke:ModuleExemple|fonction|ArgInvoke1}}</nowiki></code> et que ce modèle est lui-même appelé avec <code>{{m-|ModèleExemple|ArgModèle1|ArgModèle2}}</code>, les arguments renvoyé par la fonction <code>getArgs</code> seront <code>ArgInvoke1</code> et <code>ArgModèle2</code>. <code>ArgModèle1</code> n'est pas renvoyé. (nb.: Si l'appel de modèle est <code>{{m-|ModèleExemple}}</code> sans argument, la fonction <code>getArgs</code> renvoie quand même <code>ArgInvoke1</code>.)
|-
| <code>frameOnly</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>false</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, ce paramètre permet de ne prendre en compte que les arguments reçus du frame, c'est-à-dire généralement les arguments issus du <code><nowiki>{{#invoke:}}</nowiki></code> et non ceux issus de l'appel de modèle.
|-
| <code>parentOnly</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>false</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, ce paramètre permet de ne prendre en compte que les arguments reçus du parent, c'est-à-dire généralement les arguments issus de l'appel de modèle et non ceux issus du <code><nowiki>{{#invoke:}}</nowiki></code>.
|-
| <code>parentFirst</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>false</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, ce paramètre inverse l'ordre de priorité : les arguments reçus du parent écrasent les arguments reçus du frame.
|-
| <code>wrappers</code> || 'str' ou { 'str', 'str', ... }, || style="text-align:center;" | / || Ce paramètre permet de définir une liste de modèles sur lesquels appliquer <syntaxhighlight lang="lua" inline>parentOnly = true</syntaxhighlight> (permet de cibler, contrairement au paramètre <code>parentOnly</code> qui désactive la lecture des arguments donnés au <code><nowiki>{{#invoke:}}</nowiki></code> pour toutes les invocations).
|-
! colspan=4 | Modification du contenu de args au sein du module
|-
| <code>readOnly</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>false</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, empêche toute modification du contenu de <code>args</code>. (Par défaut, rien ne l'empêche.)
|-
| <code>noOverwrite</code> || booléen || style="text-align:center;" | <syntaxhighlight lang="lua" inline>false</syntaxhighlight> || Lorsque mis à <syntaxhighlight lang="lua" inline>true</syntaxhighlight>, l'ajout de valeurs à <code>args</code> reste autorisée, mais les modifications du contenu déjà présent sont bloquées.
|}

=== Modules externes et autres éléments dont ce module a besoin pour fonctionner ===
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#mw.title.new|mw.title.new]]</code> – Crée un nouvel [[mw:Extension:Scribunto/Lua reference manual/fr#Objet title|objet title]].

* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#frame:getParent|frame:getParent()]]</code> – Si le <code><nowiki>{{#invoke:}}</nowiki></code> est contenu dans un modèle, <code>frame</code> contient les arguments passés dans le <code><nowiki>{{#invoke:}}</nowiki></code> et <code>frame:getParent()</code> contient les paramètres donnés dans l'appel de modèle.
* <code>[[mw:Extension:Scribunto/Lua reference manual/fr#frame:getTitle|frame:getTitle()]]</code> – Renvoie le titre associé à l'[[mw:Extension:Scribunto/Lua reference manual/fr#L'objet Frame|objet ''frame'']] sous forme de chaine de caractères. Pour l'objet ''frame'' créé par <code><nowiki>{{#invoke:}}</nowiki></code>, c'est le titre du module invoqué.

Ce module fonctionne en utilisant des [[mw:Extension:Scribunto/Lua reference manual/fr#Méta-tables|méta-tables]] lua, dont notamment <code>__index</code> qui permet de modifier le fonctionnement de l'indexation sur une table. Cela permet la récupération des arguments issus du frame et du parent simultanément, sans utiliser <code>pairs()</code> qui pose parfois problème lorsqu'un argument contient des <code><nowiki><ref>...</ref></nowiki></code>.
En contrepartie, effectuer des opérations directement sur <code>args</code> ne fonctionnera pas correctement dans certains cas. Pour éviter toute surprise, il vaut mieux ne se servir d'<code>args</code> que comme d'un intermédiaire pour l'attribution de valeur à des variables locales.

== Exemples ==
=== Syntaxe minimale ===
<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs

local p = {}

function p.nomFonction(frame)
    local val = ''
	local args = getArgs(frame) -- Les données fournies au {{#invoke:}} sont traitées ici.

    if args[1] == 'nom' then -- Le code qui suit est un exemple, rien n'est obligatoire pour l'utilisation du module.
        val = args[2]
    else
        return nil
    end

    return val
end

return p
</syntaxhighlight>

=== Syntaxe complète ===
Dans le cas où la fonction est susceptible d'être appelée depuis un autre module, il est recommandé de créer deux fonctions. En plus de donner un exemple de syntaxe complète, l'exemple suivant donne un exemple de cette bonne pratique.

<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame, {
		trim = false,
		removeBlanks = false,
		valueFunc = function (key, value)
			-- Code de valueFunc
		end,
		frameOnly = true,
		parentOnly = true,
		parentFirst = true,
		wrappers = {
			'Modèle:A',
			'Modèle:B'
		},
		readOnly = true,
		noOverwrite = true
	})

	return p._main(args)
end

function p._main(args)
	-- Code principal du module.
end

return p
</syntaxhighlight>

=== Traitements supplémentaires des arguments ===
Le traitement des booléens n'est pas géré par défaut. Pour récupérer des booléens, il faut utiliser le <code>[[Module:yesno]]</code>. En outre, la conversion de str en nombres se fait via la fonction <code>[[mw:Extension:Scribunto/Lua reference manual/fr#tonumber|tonumber]]</code>.

<syntaxhighlight lang="lua">
local yesno = require('Module:yesno')
local getArgs = require('Module:Arguments').getArgs

local p = {}

function p.nomFonction(frame)
	local args = getArgs(frame) -- Les données fournies au {{#invoke:}} sont traitées ici.

    if yesno(args[1]) then -- Le changement de string en booléens est effectué à l'aide du module Yesno.
        return tonumber(args[2]) -- Le changement de string en nombre est effectué à l'aide de la fonction tonumber.
    end
end

return p
</syntaxhighlight>

== Voir aussi ==
* [[Module:Outils]] dont la fonction <code>[[Module:Outils#validTextArg|extractArgs(frame, options)]]</code> est une version simplifiée de <code>arguments.getArgs(frame, options)</code>.

{{Projet Scribunto}}

<includeonly>
[[Catégorie:Méta-module]]
[[Catégorie:Module appelé par un autre module]]
</includeonly>