TBFramework - v0.2
\

\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()
getSchema()
setSchema()
getUtilisateur()
getMotDePasse()
getInfoUtilisateur()
setInfoUtilisateur()
getHote()
setHote()
getPort()
setPort()
getAutorite()
setAutorite()
getChemin()
setChemin()
getRequete()
setRequete()
getFragment()
setFragment()
getVariablesRequete()
setVariablesRequete()
setVariableRequete()
unsetVariableRequete()
unsetVariablesRequete()
getURL()
getURLNormalisee()
normaliser()
etreAbsolue()
resoudre()
getCanonique()
getURLDemande()
getDemande()
setOption()
getOption()
__toString()
No public properties found
OPTION_STRICTE
OPTION_UTILISER_CROCHETS
OPTION_ENCODER_CLES
OPTION_SEPARATEUR_ENTREE
OPTION_SEPARATEUR_SORTIE
No protected methods found
No protected properties found
N/A
supprimerSegmentsAPoints()
$options
$schema
$infoUtilisateur
$hote
$port
$chemin
$requete
$fragment
N/A

Constants

OPTION_STRICTE

OPTION_STRICTE

Parsing strict dans resoudre() (voir RFC 3986, section 5.2.2). Par défaut à true.

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_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

Methods

__construct()

__construct(string $url, array $options)

Parameters

string $url

une URL relative ou absolue
array $options

getSchema()

getSchema() : string|bool

Retourne le schéma, c.a.d. "http" ou "urn", ou false si aucun schéma n'est spécifié, i.e. l'url est une url relative

Returns

string|bool

setSchema()

setSchema(string|bool $schema) : void

Parameters

string|bool $schema

getUtilisateur()

getUtilisateur() : string|bool

renvoie la partie user de la partie infoUtilisateur (partie précédant le premier ":"), ou false si aucune partie infoUtilisateur n'est définie.

Returns

string|bool

getMotDePasse()

getMotDePasse() : string|bool

renvoie la partie mot de passe de la partie infoUtilisateur (partie après le premier ":"), , ou false si aucune partie infoUtilisateur n'est définie (i.e. l'URL ne contient pas de "@" en face du nom d'hôte) ou si la partie infoUtilisateur ne contient pas de ":".

Returns

string|bool

getInfoUtilisateur()

getInfoUtilisateur() : string|bool

Renvoie la partie userinfio, ou false si celle-ci n'existe pas, i.e. si la partie autorité ne contient pas de "@"

Returns

string|bool

setInfoUtilisateur()

setInfoUtilisateur(string|bool $infoUtilisateur, string|bool $motDePasse) : void

Setteur pour la partie infoUtilisateur. Si deux argument sont passé, ils sont combinés dans la partie infoUtilisateur de cette manière username ":" password.

Parameters

string|bool $infoUtilisateur

infoUtilisateur ou username
string|bool $motDePasse

getHote()

getHote() : string|bool

Renvoie la partie hôte, ou false s'il n'y a pas de partie autorité, c.a.d.

l'URL est relative.

Returns

string|bool

setHote()

setHote(string|bool $hote) : void

Parameters

string|bool $hote

getPort()

getPort() : int|bool

Renvoie le numéro de port, ou false si aucun numéro de port n'est spécifié, i.e. le port par défaut doit utilisé.

Returns

int|bool

setPort()

setPort(int|bool $port) : void

Parameters

int|bool $port

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

getChemin()

getChemin() : string

Renvoie la partie chemin (chemin) (éventuellement vide).

Returns

string

setChemin()

setChemin(string $chemin) : void

Parameters

string $chemin

getRequete()

getRequete() : string|bool

renvoie la chaine de requête (requete string) (sans le premier "?"), ou false si "?" n'est pas présent dans l'url.

Returns

string|bool

setRequete()

setRequete(string|bool $requete) : void

Parameters

string|bool $requete

getFragment()

getFragment() : string|bool

Renvoie le nom du fragment, ou false si "#" n'est pas present dans l'URL.

Returns

string|bool

setFragment()

setFragment(string|bool $fragment) : void

Parameters

string|bool $fragment

getVariablesRequete()

getVariablesRequete() : array

Renvoie la requete string sous forme d'un tableau de variables telles qu'elles apparaitraient dans le $_GET d'un script PHP

Returns

array

setVariablesRequete()

setVariablesRequete(array $tableau) : void

Parameters

array $tableau

(nom => valeur) tableau

setVariableRequete()

setVariableRequete(string $nom, mixed $valeur) : array

Parameters

string $nom
mixed $valeur

Returns

array

unsetVariableRequete()

unsetVariableRequete(string $nom) : void

Parameters

string $nom

unsetVariablesRequete()

unsetVariablesRequete(array $noms) : void

Parameters

array $noms

tableau des noms de variable à supprimer de l'url.

getURL()

getURL() : string

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

Returns

string

getURLNormalisee()

getURLNormalisee() : string

Renvoie une représentation de cette URL sous forme de chaine normalisée. Utile pour la comparaison d'URLs

Returns

string

normaliser()

normaliser() : \Url

Renvoie une instance normalisée de Url

Returns

\Url

etreAbsolue()

etreAbsolue() : bool

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

Returns

bool

resoudre()

resoudre(\Url|string $reference) : \Url

Renvoie une instance de Url représentant une URL absolue relative à cette URL.

Parameters

\Url|string $reference

URL relative

Returns

\Url

getCanonique()

getCanonique() : string

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

Returns

string

getURLDemande()

getURLDemande() : string

Renvoie l'URL utilisée pour récupérer la requête en cours

Returns

string

getDemande()

getDemande() : \Url

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

Returns

\Url

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

getOption()

getOption(string $nomOption) : mixed

Renvoie la valeur de l'option specifiée.

Parameters

string $nomOption

Nom de l'option demandée

Returns

mixed

__toString()

__toString()

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