Voir la source de Initiation au Lua avec Scribunto/L'objet URI

{{Chapitre
  | idfaculté  = informatique
  | précédent  = [[../L'objet Title/]]
  | suivant    = [[../Librairie HTML/]]
  | page_liée  = Exercices/Sur l’objet URI
  | numéro     = 14
  | niveau     = 10
}}


== L'objet URI  ==

{{...}}

== Librairie Uri  ==

Nous commencerons par visualiser le contenu de cette librairie grâce au programme suivant :

<syntaxhighlight lang="lua">
local p = {}

function p.visualisation(frame)
	reponse = ""
	for index, objet in pairs(mw.uri) do
		reponse = reponse.."<br>À la clé "..index..", on trouve un objet de type : "..type(objet)
	end
	return reponse
end

return p
</syntaxhighlight>


'''<nowiki>{{#invoke:Uri|visualisation}}</nowiki>''' nous donne : {{#invoke:Uri|visualisation}}


Étudions ces fonctions dans l’ordre où elles sont sorties :


==== mw.uri.parseQueryString ====

{{...}}

<code style="white-space:nowrap">mw.uri.parseQueryString( s )</code>

Décode une chaine correspondant à une requête en une table. Les clés qui dans la chaîne n'ont aucune value prendront la valeur false ; les clés répétées de multiples fois auront pour valeur des séquences ; les autres auront pour valeur des chaînes.


==== mw.uri.encode ====

{{...}}

<code style="white-space:nowrap">mw.uri.encode( s, enctype )</code>

Encode la chaîne ''s'' au format URL. Le type par défaut "QUERY" encode les espaces en utilisant "+", "PATH" les encode en utilisant "%20" et "WIKI" les encode en utilisant "_".

Notez que le format "WIKI" n’est pas entièrement réversible puisque les espaces et les underscores ("_") sont encodés de la même façon.


==== mw.uri.fullUrl ====

{{...}}

<code style="white-space:nowrap">mw.uri.fullUrl( page, query )</code>

Retourne un [[#L'objet URI|objet URI]] pour l'URL complet de cette page, avec une requête optionnelle string/table.


==== mw.uri.canonicalUrl ====

{{...}}

<code style="white-space:nowrap">mw.uri.canonicalUrl( page, query )</code>

Retourne un [[#L'objet URI|objet URI]] for the canonical url for a page, with optional query string/table.


==== mw.uri.buildQueryString ====

{{...}}

<code style="white-space:nowrap">mw.uri.buildQueryString( table )</code>

Encode une table en tant que chaîne de requête. Les clés doivent être des chaînes. Les valeurs peuvent être des chaînes, des nombres, des séquences ou ''false''.


==== mw.uri.anchorEncode ====

{{...}}

<code style="white-space:nowrap">mw.uri.anchorEncode( s )</code>

Encode la chaîne pour être utilisée en tant que fragment MediaWiki.


==== mw.uri.validate ====

{{...}}

<code style="white-space:nowrap">mw.uri.validate( table )</code>

Validates the passed table (or URI object). Returns a boolean indicating whether the table was valid, and on failure a string explaining what problems were found.


==== mw.uri.localUrl ====

{{...}}

<code style="white-space:nowrap">mw.uri.localUrl( page, query )</code>

Retourne un [[#L'objet URI|objet URI]] for the local url for a page, with optional query string/table.


==== mw.uri.decode ====

{{...}}

<code style="white-space:nowrap">mw.uri.decode( s, enctype )</code>

Décode la chaîne "s". Le type par défaut "QUERY" décode les "+" en espaces, "PATH" décode les "%20" en espaces et "WIKI" décode les "_" en espaces.


==== mw.uri.new ====

{{...}}

<code style="white-space:nowrap">mw.uri.new( s )</code>

Construit un nouvel [[#L'objet URI|objet URI]] pour la chaîne ou la table passée en argument. Voir la description de l’objet URI pour les champs possibles de la table.

== Objets en relation avec l’objet URI  ==

Nous commencerons par visualiser le contenu d'un objet URI grâce au programme suivant :

<syntaxhighlight lang="lua">
local p = {}

function p.visualise(frame)
	reponse = ""
	Uri = mw.uri.new(essai)
	for index, objet in pairs(Uri) do
		reponse = reponse.."<br>À la clé "..index..", on trouve un objet de type : "..type(objet)
	end
	return reponse
end

return p
</syntaxhighlight>


'''<nowiki>{{#invoke:Uri|visualise}}</nowiki>''' nous donne : {{#invoke:Uri|visualise}}


Étudions ces fonctions dans l’ordre où elles sont sorties :


L'objet URI contient les champs suivants, dont certain ou tous peuvent valoir ''nil'' :

* '''protocol''' : chaîne du protocole
* '''user''' : nom de l'utilisateur
* '''password''' : mot de passe
* '''host''' : nom de la machine
* '''port''' : numéro du port (entier)
* '''path''' : chemin
* '''query''' : une table comme dans [[#mw.uri.parseQueryString|mw.uri.parseQueryString]]
* '''fragment''' : le fragment

Les propriétés suivantes sont également disponibles :
* '''userInfo''' : utilisateur et mot de passe
* '''hostPort''' : machine et numéro de port
* '''authority''' : les deux précédents ensembles
* '''queryString''' : version chaîne de la table de requête
* '''relativePath''' : chemin, requête et fragment

[[#tostring|<code>tostring()</code>]] retourne la chaîne de l'URI.

Les méthodes de l’objet URI sont :

==== mw.uri:parse ====

{{...}}

<code style="white-space:nowrap">uri:parse( s )</code>

Analyse une chaîne dans l’objet URI courant. Tout champ spécifié dans la chaîne sera remplacé dans l'objet, les champs non spécifiés gardent leur ancienne valeur.


==== mw.uri:clone ====

{{...}}

<code>uri:clone()</code>

Crée une copie de l’objet URI.


==== mw.uri:extend ====

{{...}}

<code style="white-space:nowrap">uri:extend( parameters )</code>

Intègre la table ''parameters'' dans la table de requête de l'objet.


{{Bas de page
  | idfaculté  = informatique
  | précédent  = [[../L'objet Title/]]
  | suivant    = [[../Librairie HTML/]]
}}