New file |
0,0 → 1,694 |
<!DOCTYPE html> |
<html> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta name="generator" content="ApiGen 2.8.0"> |
|
<title>Class Url | TBFramework - v0.3</title> |
|
<script type="text/javascript" src="resources/combined.js?4205936287"></script> |
<script type="text/javascript" src="elementlist.js?4111837732"></script> |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"> |
|
</head> |
|
<body> |
<div id="left"> |
<div id="menu"> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
|
|
<div id="groups"> |
<h3>Packages</h3> |
<ul> |
<li class="active"><a href="package-Framework.html">Framework</a> |
</li> |
<li><a href="package-None.html">None</a> |
</li> |
<li><a href="package-PHP.html">PHP</a> |
</li> |
<li><a href="package-Utilitaire.html">Utilitaire</a> |
</li> |
</ul> |
</div> |
|
<hr> |
|
|
<div id="elements"> |
<h3>Classes</h3> |
<ul> |
<li><a href="class-Bdd.html">Bdd</a></li> |
<li><a href="class-Cache.html">Cache</a></li> |
<li><a href="class-CacheSimple.html">CacheSimple</a></li> |
<li><a href="class-Chronometre.html">Chronometre</a></li> |
<li><a href="class-Cli.html">Cli</a></li> |
<li><a href="class-Config.html">Config</a></li> |
<li><a href="class-Controleur.html">Controleur</a></li> |
<li><a href="class-Debug.html">Debug</a></li> |
<li><a href="class-Framework.html">Framework</a></li> |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li> |
<li><a href="class-I18n.html">I18n</a></li> |
<li><a href="class-Log.html">Log</a></li> |
<li><a href="class-Registre.html">Registre</a></li> |
<li><a href="class-RestClient.html">RestClient</a></li> |
<li><a href="class-RestServeur.html">RestServeur</a></li> |
<li><a href="class-RestService.html">RestService</a></li> |
<li><a href="class-Script.html">Script</a></li> |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li> |
<li class="active"><a href="class-Url.html">Url</a></li> |
</ul> |
|
|
|
|
|
</div> |
</div> |
</div> |
|
<div id="splitter"></div> |
|
<div id="right"> |
<div id="rightInner"> |
<form id="search"> |
<input type="hidden" name="cx" value=""> |
<input type="hidden" name="ie" value="UTF-8"> |
<input type="text" name="q" class="text"> |
<input type="submit" value="Search"> |
</form> |
|
<div id="navigation"> |
<ul> |
<li> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
</li> |
<li> |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a> |
</li> |
<li class="active"> |
<span>Class</span> </li> |
</ul> |
<ul> |
<li> |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
</li> |
<li> |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a> |
</li> |
<li> |
<a href="todo.html" title="Todo list"><span>Todo</span></a> |
</li> |
</ul> |
<ul> |
</ul> |
</div> |
|
<div id="content" class="class"> |
<h1>Class Url</h1> |
|
|
<div class="description"> |
|
<p>Classe Url, gérant le découpage des paramètres, leurs modification etc... |
Traduction et conversion d'une classe (NET_Url2) issue de Pear</p> |
|
</div> |
|
|
|
|
|
|
|
|
|
<div class="info"> |
|
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
Php 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2010, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br> |
<b>Author:</b> |
Christian SCHMIDT <<a |
href="mailto:schmidt@php.net">schmidt@<!-- -->php.net</a>> (Auteur |
classe originale)<br> |
<b>Author:</b> |
Aurélien PERONNET <<a |
href="mailto:aurelien@tela-botanica.org">aurelien@<!-- -->tela-botanica.org</a>><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
SVN: $Id: Url.php 404 2012-02-22 15:44:24Z gduche $<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Url.html#3-425" title="Go to source code">Url.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="__construct" id="___construct"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#___construct">#</a> |
<code><a href="source-class-Url.html#97-134" title="Go to source code">__construct</a>( <span>string <var>$url</var></span>, <span>array <var>$options</var> = <span class="php-keyword1">null</span></span> )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$url</var></dt> |
<dd><code>string</code><br>$url une URL relative ou absolue</dd> |
<dt><var>$options</var></dt> |
<dd><code>array</code><br>$options</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getOption" id="_getOption"> |
|
<td class="attributes"><code> |
public |
mixed |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getOption">#</a> |
<code><a href="source-class-Url.html#136-145" title="Go to source code">getOption</a>( <span>string <var>$nomOption</var></span> )</code> |
|
<div class="description short"> |
|
<p>Renvoie la valeur de l'option specifiée.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Renvoie la valeur de l'option specifiée.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$nomOption</var></dt> |
<dd><code>string</code><br>$nomOption Nom de l'option demandée</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>mixed</code><br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="setOption" id="_setOption"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_setOption">#</a> |
<code><a href="source-class-Url.html#147-163" title="Go to source code">setOption</a>( <span>string <var>$nomOption</var></span>, <span>mixed <var>$valeur</var></span> )</code> |
|
<div class="description short"> |
|
<p>Met à jour la valeur de l'option spécifiée.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Met à jour la valeur de l'option spécifiée.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$nomOption</var></dt> |
<dd><code>string</code><br>$nomOption une des constantes commençant par self::OPTION_</dd> |
<dt><var>$valeur</var></dt> |
<dd><code>mixed</code><br>$valeur valeur de l'option</dd> |
</dl></div> |
|
|
|
<h4>See</h4> |
<div class="list"> |
self::OPTION_STRICTE<br> |
<code><code><a href="class-Url.html#OPTION_UTILISER_CROCHETS">Url::<b>OPTION_UTILISER_CROCHETS</b></a></code></code><br> |
<code><code><a href="class-Url.html#OPTION_ENCODER_CLES">Url::<b>OPTION_ENCODER_CLES</b></a></code></code><br> |
</div> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="setRequete" id="_setRequete"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_setRequete">#</a> |
<code><a href="source-class-Url.html#264-299" title="Go to source code">setRequete</a>( <span>array <var>$parametres</var></span> )</code> |
|
<div class="description short"> |
|
<p>(Re-)Création de la partie requête de l'URL à partir des données du |
tableau (passé en paramètre).</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>(Re-)Création de la partie requête de l'URL à partir des données du |
tableau (passé en paramètre).</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$parametres</var></dt> |
<dd><code>array</code><br>(nom => valeur) tableau de clés & valeurs pour la partie requête de |
l'url.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code></code><br>(Re-)Création de la partie requête.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="fusionnerRequete" id="_fusionnerRequete"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_fusionnerRequete">#</a> |
<code><a href="source-class-Url.html#301-313" title="Go to source code">fusionnerRequete</a>( <span>array <var>$parametres</var></span> )</code> |
|
<div class="description short"> |
|
<p>(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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>(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> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$parametres</var></dt> |
<dd><code>array</code><br>(nom => valeur) tableau de clés & valeurs pour la partie requête de |
l'url.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code></code><br>(Re-)Création de la partie requête.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="normaliser" id="_normaliser"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_normaliser">#</a> |
<code><a href="source-class-Url.html#315-352" title="Go to source code">normaliser</a>( )</code> |
|
<div class="description short"> |
|
<p>Normalise les données de l'instance d'Url faisant appel à cette |
méthode.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Normalise les données de l'instance d'Url faisant appel à cette |
méthode.</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code></code><br>l'instance d'Url courrante est normalisée.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getCanonique" id="_getCanonique"> |
|
<td class="attributes"><code> |
public static |
<code><a href="class-Url.html">Url</a></code> |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getCanonique">#</a> |
<code><a href="source-class-Url.html#354-374" title="Go to source code">getCanonique</a>( )</code> |
|
<div class="description short"> |
|
<p>Renvoie une instance d'objet Url representant l'URL canonique du script PHP |
en cours d'éxécution.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Renvoie une instance d'objet Url representant l'URL canonique du script PHP |
en cours d'éxécution.</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code><code><a href="class-Url.html">Url</a></code></code><br>retourne un objet Url ou null en cas d'erreur.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getDemande" id="_getDemande"> |
|
<td class="attributes"><code> |
public static |
<code><a href="class-Url.html">Url</a></code> |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getDemande">#</a> |
<code><a href="source-class-Url.html#376-393" title="Go to source code">getDemande</a>( )</code> |
|
<div class="description short"> |
|
<p>Renvoie une instance d'objet Url representant l'URL utilisée pour |
récupérer la requête en cours.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Renvoie une instance d'objet Url representant l'URL utilisée pour |
récupérer la requête en cours.</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code><code><a href="class-Url.html">Url</a></code></code><br>retourne un objet Url ou null en cas d'erreur.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getURL" id="_getURL"> |
|
<td class="attributes"><code> |
public |
string |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getURL">#</a> |
<code><a href="source-class-Url.html#396-424" title="Go to source code">getURL</a>( )</code> |
|
<div class="description short"> |
|
<p>Renvoie un représentation sous forme de chaine de l'URL.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Renvoie un représentation sous forme de chaine de l'URL.</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>string</code><br>l'url<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
<table class="summary" id="constants"> |
<caption>Constants summary</caption> |
<tr data-order="OPTION_UTILISER_CROCHETS" id="OPTION_UTILISER_CROCHETS"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Url.html#20-23" title="Go to source code"><b>OPTION_UTILISER_CROCHETS</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">'utiliser_crochets'</span></code></td> |
<td class="description"><div> |
<a href="#OPTION_UTILISER_CROCHETS" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Répresenter les tableaux dans les requêtes en utilisant la notation php []. |
Par défaut à true.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Répresenter les tableaux dans les requêtes en utilisant la notation php []. |
Par défaut à true.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="OPTION_ENCODER_CLES" id="OPTION_ENCODER_CLES"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Url.html#25-28" title="Go to source code"><b>OPTION_ENCODER_CLES</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">'encoder_cles'</span></code></td> |
<td class="description"><div> |
<a href="#OPTION_ENCODER_CLES" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>URL-encoder les clés des variables dans les requêtes. Par défaut à |
true.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>URL-encoder les clés des variables dans les requêtes. Par défaut à |
true.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="OPTION_ENCODER_VALEURS" id="OPTION_ENCODER_VALEURS"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Url.html#30-33" title="Go to source code"><b>OPTION_ENCODER_VALEURS</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">'encoder_valeurs'</span></code></td> |
<td class="description"><div> |
<a href="#OPTION_ENCODER_VALEURS" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>URL-encoder les valeurs des variables dans les requêtes. Par défaut à |
false.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>URL-encoder les valeurs des variables dans les requêtes. Par défaut à |
false.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="OPTION_SEPARATEUR_ENTREE" id="OPTION_SEPARATEUR_ENTREE"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Url.html#35-40" title="Go to source code"><b>OPTION_SEPARATEUR_ENTREE</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">'separateur_entree'</span></code></td> |
<td class="description"><div> |
<a href="#OPTION_SEPARATEUR_ENTREE" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>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> |
|
<div class="description detailed hidden"> |
|
<p>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> |
</div></td> |
</tr> |
<tr data-order="OPTION_SEPARATEUR_SORTIE" id="OPTION_SEPARATEUR_SORTIE"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Url.html#42-46" title="Go to source code"><b>OPTION_SEPARATEUR_SORTIE</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">'separateur_sortie'</span></code></td> |
<td class="description"><div> |
<a href="#OPTION_SEPARATEUR_SORTIE" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>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> |
|
<div class="description detailed hidden"> |
|
<p>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> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
|
|
</div> |
|
<div id="footer"> |
TBFramework - v0.3 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
</div> |
</div> |
</div> |
</body> |
</html> |