New file |
0,0 → 1,592 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
<head> |
<!-- template designed by Marco Von Ballmoos --> |
<title>Docs For Class Url</title> |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<script src="../media/lib/classTree.js"></script> |
<script language="javascript" type="text/javascript"> |
var imgPlus = new Image(); |
var imgMinus = new Image(); |
imgPlus.src = "../media/images/plus.png"; |
imgMinus.src = "../media/images/minus.png"; |
|
function showNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgMinus.src; |
oTable.style.display = "block"; |
} |
|
function hideNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgPlus.src; |
oTable.style.display = "none"; |
} |
|
function nodeIsVisible(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
break; |
} |
return (oTable && oTable.style.display == "block"); |
} |
|
function toggleNodeVisibility(Node){ |
if (nodeIsVisible(Node)){ |
hideNode(Node); |
}else{ |
showNode(Node); |
} |
} |
</script> |
</head> |
<body> |
<div class="page-body"> |
<h2 class="class-name">Class Url</h2> |
|
<a name="sec-description"></a> |
<div class="info-box"> |
<div class="info-box-title">Description</div> |
<div class="nav-bar"> |
<span class="disabled">Description</span> | |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
</div> |
<div class="info-box-body"> |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Classe Url, gérant le découpage des paramètres, leurs modification etc...</p> |
<p class="description"><p>Traduction et conversion d'une classe (NET_Url2) issue de Pear</p></p> |
<ul class="tags"> |
<li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li> |
<li><span class="field">author:</span> Christian SCHMIDT <<a href="mailto:schmidt@php.net">schmidt@php.net</a>> (Auteur classe originale)</li> |
<li><span class="field">author:</span> Aurélien PERONNET <<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>></li> |
<li><span class="field">version:</span> SVN: $Id: Url.php 286 2011-01-05 11:37:57Z jpm $</li> |
<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li> |
<li><span class="field">link:</span> /doc/framework/</li> |
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li> |
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li> |
</ul> |
<p class="notes"> |
Located in <a class="field" href="_Url.php.html">/Url.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Url.php.html#a18">18</a></span>) |
</p> |
|
|
<pre></pre> |
|
</div> |
</div> |
|
|
<a name="sec-const-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Class Constant Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>) |
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<div class="const-summary"> |
<div class="const-title"> |
<img src="../media/images/Constant.png" alt=" " /> |
<a href="#OPTION_ENCODER_CLES" title="details" class="const-name">OPTION_ENCODER_CLES</a> = <span class="var-type"> 'encoder_cles'</span> |
|
</div> |
<div class="const-title"> |
<img src="../media/images/Constant.png" alt=" " /> |
<a href="#OPTION_SEPARATEUR_ENTREE" title="details" class="const-name">OPTION_SEPARATEUR_ENTREE</a> = <span class="var-type"> 'separateur_entree'</span> |
|
</div> |
<div class="const-title"> |
<img src="../media/images/Constant.png" alt=" " /> |
<a href="#OPTION_SEPARATEUR_SORTIE" title="details" class="const-name">OPTION_SEPARATEUR_SORTIE</a> = <span class="var-type"> 'separateur_sortie'</span> |
|
</div> |
<div class="const-title"> |
<img src="../media/images/Constant.png" alt=" " /> |
<a href="#OPTION_UTILISER_CROCHETS" title="details" class="const-name">OPTION_UTILISER_CROCHETS</a> = <span class="var-type"> 'utiliser_crochets'</span> |
|
</div> |
</div> |
</div> |
</div> |
|
|
<a name="sec-method-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Method Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
</div> |
<div class="info-box-body"> |
<div class="method-summary"> |
|
<div class="method-definition"> |
static <span class="method-result"><a href="../Framework/Url.html">Url</a></span> |
<a href="#getCanonique" title="details" class="method-name">getCanonique</a> |
() |
</div> |
|
<div class="method-definition"> |
static <span class="method-result"><a href="../Framework/Url.html">Url</a></span> |
<a href="#getDemande" title="details" class="method-name">getDemande</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">Url</span> |
<a href="#__construct" title="details" class="method-name">__construct</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#fusionnerRequete" title="details" class="method-name">fusionnerRequete</a> |
(<span class="var-type"></span> <span class="var-name">$parametres</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">mixed</span> |
<a href="#getOption" title="details" class="method-name">getOption</a> |
(<span class="var-type">string</span> <span class="var-name">$nomOption</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">string</span> |
<a href="#getURL" title="details" class="method-name">getURL</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#normaliser" title="details" class="method-name">normaliser</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#setOption" title="details" class="method-name">setOption</a> |
(<span class="var-type">string</span> <span class="var-name">$nomOption</span>, <span class="var-type">mixed</span> <span class="var-name">$valeur</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#setRequete" title="details" class="method-name">setRequete</a> |
(<span class="var-type"></span> <span class="var-name">$parametres</span>) |
</div> |
</div> |
</div> |
</div> |
|
|
<a name="sec-methods"></a> |
<div class="info-box"> |
<div class="info-box-title">Methods</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|
</div> |
<div class="info-box-body"> |
<A NAME='method_detail'></A> |
<a name="methodgetCanonique" id="getCanonique"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">static getCanonique</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a349">349</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Renvoie une instance d'objet Url representant l'URL canonique du script PHP en cours d'éxécution.</p> |
<ul class="tags"> |
<li><span class="field">return:</span> retourne un objet Url ou null en cas d'erreur.</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
static <span class="method-result"><a href="../Framework/Url.html">Url</a></span> |
<span class="method-name"> |
getCanonique |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodgetDemande" id="getDemande"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">static getDemande</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a371">371</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Renvoie une instance d'objet Url representant l'URL utilisée pour récupérer la requête en cours.</p> |
<ul class="tags"> |
<li><span class="field">return:</span> retourne un objet Url ou null en cas d'erreur.</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
static <span class="method-result"><a href="../Framework/Url.html">Url</a></span> |
<span class="method-name"> |
getDemande |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="method__construct" id="__construct"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a95">95</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">Url</span> |
<span class="method-name"> |
__construct |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: une URL relative ou absolue</span> </li> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$options</span> </li> |
</ul> |
|
|
</div> |
<a name="methodfusionnerRequete" id="fusionnerRequete"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">fusionnerRequete</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a298">298</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">(Re-)Création de la partie requête de l'URL à partir de la fusion du tableau (passé en paramètre) et les valeurs présentes dans $_GET.</p> |
<ul class="tags"> |
<li><span class="field">return:</span> (Re-)Création de la partie requête.</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
fusionnerRequete |
</span> |
(<span class="var-type"></span> <span class="var-name">$parametres</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$parametres</span><span class="var-description">: (nom => valeur) tableau de clés & valeurs pour la partie requête de l'url.</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetOption" id="getOption"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">getOption</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a137">137</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Renvoie la valeur de l'option specifiée.</p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">mixed</span> |
<span class="method-name"> |
getOption |
</span> |
(<span class="var-type">string</span> <span class="var-name">$nomOption</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$nomOption</span><span class="var-description">: Nom de l'option demandée</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetURL" id="getURL"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">getURL</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a391">391</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Renvoie un représentation sous forme de chaine de l'URL.</p> |
<ul class="tags"> |
<li><span class="field">return:</span> l'url</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">string</span> |
<span class="method-name"> |
getURL |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodnormaliser" id="normaliser"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">normaliser</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a310">310</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Normalise les données de l'instance d'Url faisant appel à cette méthode.</p> |
<ul class="tags"> |
<li><span class="field">return:</span> l'instance d'Url courrante est normalisée.</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
normaliser |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodsetOption" id="setOption"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">setOption</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a152">152</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Met à jour la valeur de l'option spécifiée.</p> |
<ul class="tags"> |
<li><span class="field">see:</span> self::OPTION_ENCODER_CLES</li> |
<li><span class="field">see:</span> self::OPTION_UTILISER_CROCHETS</li> |
<li><span class="field">see:</span> self::OPTION_STRICTE</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
setOption |
</span> |
(<span class="var-type">string</span> <span class="var-name">$nomOption</span>, <span class="var-type">mixed</span> <span class="var-name">$valeur</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$nomOption</span><span class="var-description">: une des constantes commençant par self::OPTION_</span> </li> |
<li> |
<span class="var-type">mixed</span> |
<span class="var-name">$valeur</span><span class="var-description">: valeur de l'option</span> </li> |
</ul> |
|
|
</div> |
<a name="methodsetRequete" id="setRequete"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">setRequete</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a264">264</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">(Re-)Création de la partie requête de l'URL à partir des données du tableau (passé en paramètre).</p> |
<ul class="tags"> |
<li><span class="field">return:</span> (Re-)Création de la partie requête.</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
setRequete |
</span> |
(<span class="var-type"></span> <span class="var-name">$parametres</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$parametres</span><span class="var-description">: (nom => valeur) tableau de clés & valeurs pour la partie requête de l'url.</span> </li> |
</ul> |
|
|
</div> |
|
</div> |
</div> |
|
<a name="sec-consts"></a> |
<div class="info-box"> |
<div class="info-box-title">Class Constants</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>) |
|
|
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<a name="constOPTION_ENCODER_CLES" id="OPTION_ENCODER_CLES"><!-- --></A> |
<div class="evenrow"> |
|
<div class="const-header"> |
<img src="../media/images/Variable.png" /> |
<span class="const-title"> |
<span class="const-name">OPTION_ENCODER_CLES</span> |
= <span class="const-default"> 'encoder_cles'</span> |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a28">28</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">URL-encoder les clés des variables dans les requêtes. Par défaut à true.</p> |
|
|
</div> |
<a name="constOPTION_SEPARATEUR_ENTREE" id="OPTION_SEPARATEUR_ENTREE"><!-- --></A> |
<div class="oddrow"> |
|
<div class="const-header"> |
<img src="../media/images/Variable.png" /> |
<span class="const-title"> |
<span class="const-name">OPTION_SEPARATEUR_ENTREE</span> |
= <span class="const-default"> 'separateur_entree'</span> |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a35">35</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Séparateurs de variables lors du parsing de la requête. Chaque caractère est considéré comme un séparateur. Par défaut, spécifié par le paramêtre arg_separator.input dans php.ini (par défaut "&").</p> |
|
|
</div> |
<a name="constOPTION_SEPARATEUR_SORTIE" id="OPTION_SEPARATEUR_SORTIE"><!-- --></A> |
<div class="evenrow"> |
|
<div class="const-header"> |
<img src="../media/images/Variable.png" /> |
<span class="const-title"> |
<span class="const-name">OPTION_SEPARATEUR_SORTIE</span> |
= <span class="const-default"> 'separateur_sortie'</span> |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a41">41</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Séparateur de variables lors de la génération de la requête. Par défaut, spécifié par le paramètre arg_separator.output dans php.ini (par défaut "&").</p> |
|
|
</div> |
<a name="constOPTION_UTILISER_CROCHETS" id="OPTION_UTILISER_CROCHETS"><!-- --></A> |
<div class="oddrow"> |
|
<div class="const-header"> |
<img src="../media/images/Variable.png" /> |
<span class="const-title"> |
<span class="const-name">OPTION_UTILISER_CROCHETS</span> |
= <span class="const-default"> 'utiliser_crochets'</span> |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Url.php.html#a23">23</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Répresenter les tableaux dans les requêtes en utilisant la notation php []. Par défaut à true.</p> |
|
|
</div> |
|
</div> |
</div> |
|
<p class="notes" id="credit"> |
Documentation generated on Tue, 18 Jan 2011 15:31:03 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
</p> |
</div></body> |
</html> |