Overview

Packages

  • Framework
  • PHP

Classes

  • Application
  • Chronometre
  • Config
  • Controleur
  • Debug
  • GestionnaireException
  • I18n
  • Log
  • Modele
  • Registre
  • SquelettePhp
  • Url

Functions

  • autoloadAppliDefaut
  • autoloadFw
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class 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

Package: Framework
Category: PHP 5.2
Copyright: Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
License: <http://www.gnu.org/licenses/gpl.html>
License: <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt>
Author: Christian SCHMIDT<schmidt@php.net>
Author: Aurélien PERONNET <aurelien@tela-botanica.org>
Author: Jean-Pascal MILCENT <jpm@tela-botanica.org>
Located at Url.php
Methods summary
public
# __construct( string $url, array $options = null )

Parameters

$url
string
$url une URL relative ou absolue
$options
array
$options
public string|boolean
# getSchema( )

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

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|boolean
public
# setSchema( string|boolean $schema )

Parameters

$schema
string|boolean
$schema

See

Url::getSchema()
public string|boolean
# getUtilisateur( )

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

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|boolean
public string|boolean
# getMotDePasse( )

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 ":".

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|boolean
public string|boolean
# getInfoUtilisateur( )

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

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

Returns

string|boolean
public
# setInfoUtilisateur( string|boolean $infoUtilisateur, string|boolean $motDePasse = false )

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

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

$infoUtilisateur
string|boolean
$infoUtilisateur infoUtilisateur ou username
$motDePasse
string|boolean
$motDePasse
public string|boolean
# getHote( )

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

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|boolean
public
# setHote( string|boolean $hote )

Parameters

$hote
string|boolean
$hote
public integer|boolean
# getPort( )

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

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

integer|boolean
public
# setPort( integer|boolean $port )

Parameters

$port
integer|boolean
$port
public string|boolean
# getAutorite( )

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

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

Returns

string|boolean
public
# setAutorite( string|false $autorite )

Parameters

$autorite
string|false
$autorite
public string
# getChemin( )

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

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

Returns

string
public
# setChemin( string $chemin )

Parameters

$chemin
string
$chemin
public string|boolean
# getRequete( )

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

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

Returns

string|boolean

See

Url::getVariablesRequete()
public
# setRequete( string|boolean $requete )

Parameters

$requete
string|boolean
$requete

See

Url::setVariablesRequete()
public string|boolean
# getFragment( )

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

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

Returns

string|boolean
public
# setFragment( string|boolean $fragment )

Parameters

$fragment
string|boolean
$fragment
public array
# getVariablesRequete( )

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

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

Returns

array
public
# setVariablesRequete( array $tableau )

Parameters

$tableau
array
$tableau (nom => valeur) tableau
public array
# setVariableRequete( string $nom, mixed $valeur )

Parameters

$nom
string
$nom
$valeur
mixed
$valeur

Returns

array
public
# unsetVariableRequete( string $nom )

Parameters

$nom
string
$nom
public
# unsetVariablesRequete( array $noms )

Parameters

$noms
array
$noms tableau des noms de variable à supprimer de l'url.
public string
# getURL( )

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

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

Returns

string
public string
# getURLNormalisee( )

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

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

Returns

string
public Url
# normaliser( )

Renvoie une instance normalisée de Url

Renvoie une instance normalisée de Url

Returns

Url
public boolean
# etreAbsolue( )

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

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

Returns

boolean
public Url
# resoudre( Url|string $reference )

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

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

Parameters

$reference
Url|string
$reference URL relative

Returns

Url
public static string
# getCanonique( )

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

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

Returns

string
public static string
# getURLDemande( )

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

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

Returns

string
public static Url
# getDemande( )

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

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

Returns

Url
public
# setOption( string $nomOption, mixed $valeur )

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

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

Parameters

$nomOption
string
$nomOption une des constantes commençant par self::OPTION_
$valeur
mixed
$valeur valeur de l'option

See

Url::OPTION_STRICTE
Url::OPTION_UTILISER_CROCHETS
Url::OPTION_ENCODER_CLES
public mixed
# getOption( string $nomOption )

Renvoie la valeur de l'option specifiée.

Renvoie la valeur de l'option specifiée.

Parameters

$nomOption
string
$nomOption Nom de l'option demandée

Returns

mixed
public
# __toString( )
Constants summary
string OPTION_STRICTE 'strict'
#

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

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

string OPTION_UTILISER_CROCHETS 'use_brackets'
#

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

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

string OPTION_ENCODER_CLES 'encode_keys'
#

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

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

string OPTION_SEPARATEUR_ENTREE 'input_separator'
#

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

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

string OPTION_SEPARATEUR_SORTIE 'output_separator'
#

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

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

TBFramework - v0.2 API documentation generated by ApiGen 2.8.0