TBFramework - v0.4
\

\Url

Classe Url, gérant le découpage des paramètres, leurs modification etc.

.. Traduction et conversion d'une classe (NET_Url2) issue de Pear

Summary

Methods
Properties
Constants
__construct()
getOption()
setOption()
setRequete()
fusionnerRequete()
normaliser()
getCanonique()
getDemande()
getURL()
No public properties found
OPTION_UTILISER_CROCHETS
OPTION_ENCODER_CLES
OPTION_ENCODER_VALEURS
OPTION_SEPARATEUR_ENTREE
OPTION_SEPARATEUR_SORTIE
No protected methods found
No protected properties found
N/A
getAutorite()
setAutorite()
etreAbsolue()
supprimerSegmentsAPoints()
$options
$schema
$infoUtilisateur
$hote
$port
$chemin
$requete
$fragment
$parametres_obligatoires
N/A

Constants

OPTION_UTILISER_CROCHETS

OPTION_UTILISER_CROCHETS

Répresenter les tableaux dans les requêtes en utilisant la notation php []. Par défaut à true.

OPTION_ENCODER_CLES

OPTION_ENCODER_CLES

URL-encoder les clés des variables dans les requêtes. Par défaut à true.

OPTION_ENCODER_VALEURS

OPTION_ENCODER_VALEURS

URL-encoder les valeurs des variables dans les requêtes. Par défaut à false.

OPTION_SEPARATEUR_ENTREE

OPTION_SEPARATEUR_ENTREE

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 "&").

OPTION_SEPARATEUR_SORTIE

OPTION_SEPARATEUR_SORTIE

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 "&").

Properties

$options

$options

Options par défaut correspondant au comportement de php vis à vis de $_GET

$schema

$schema : string|bool

Type

string|bool

$infoUtilisateur

$infoUtilisateur : string|bool

Type

string|bool

$hote

$hote : string|bool

Type

string|bool

$port

$port : int|bool

Type

int|bool

$chemin

$chemin : string

Type

string

$requete

$requete : string|bool

Type

string|bool

$fragment

$fragment : string|bool

Type

string|bool

$parametres_obligatoires

$parametres_obligatoires

Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.

Methods

__construct()

__construct(string $url, array $options)

Parameters

string $url

une URL relative ou absolue
array $options

getOption()

getOption(string $nomOption) : mixed

Renvoie la valeur de l'option specifiée.

Parameters

string $nomOption

Nom de l'option demandée

Returns

mixed

setOption()

setOption(string $nomOption, mixed $valeur) : void

Met à jour la valeur de l'option spécifiée.

Parameters

string $nomOption

une des constantes commençant par self::OPTION_
mixed $valeur

valeur de l'option

setRequete()

setRequete(array $parametres) : void

(Re-)Création de la partie requête de l'URL à partir des données du tableau (passé en paramètre).

Parameters

array $parametres

fusionnerRequete()

fusionnerRequete(array $parametres) : void

(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.

Parameters

array $parametres

normaliser()

normaliser() : void

Normalise les données de l'instance d'Url faisant appel à cette méthode.

getCanonique()

getCanonique() : \Url

Renvoie une instance d'objet Url representant l'URL canonique du script PHP en cours d'éxécution.

Returns

\Url —

retourne un objet Url ou null en cas d'erreur.

getDemande()

getDemande() : \Url

Renvoie une instance d'objet Url representant l'URL utilisée pour récupérer la requête en cours.

Returns

\Url —

retourne un objet Url ou null en cas d'erreur.

getURL()

getURL() : string

Renvoie un représentation sous forme de chaine de l'URL.

Returns

string —

l'url

getAutorite()

getAutorite() : string|bool

Renvoie la partie autorité, i.e. [ infoUtilisateur "@" ] hote [ ":" port ], ou false si celle-ci est absente.

Returns

string|bool

setAutorite()

setAutorite(string|false $autorite) : void

Parameters

string|false $autorite

etreAbsolue()

etreAbsolue() : bool

Renvoie vrai ou faux suivant que l'instance en cours représente une URL relative ou absolue.

Returns

bool

supprimerSegmentsAPoints()

supprimerSegmentsAPoints(string $chemin) : string

La suppression des segments à points est décrite dans la RFC 3986, section 5.2.4, e.g.

"/foo/../bar/baz" => "/bar/baz"

Parameters

string $chemin

un chemin

Returns

string —

un chemin