Présentation

La classe CopixURLHandlerGetResponse décrit les composantes d'une URL lors de sa génération par les handlers spécifiques.

Lorsque vous développez un handler d'URL, vous pouvez renseigner différents paramètres, à savoir :

le chemin ($path)

Vous spécifiez le chemin via un tableau de chaines de caractères.

Par exemple, si vous souhaitez générer le chemin /module/et/son/chemin, alors vous initialiserez path avec array ('module', 'et', 'son', 'chemin').

Par défaut $path est initialisé tableau vide (array ()).

Note : Chaque élément du chemin subira un "urlencode" et verra ses espaces remplacés par des tirets "-".

les paramètres ($vars)

Vous pouvez spécifier les paramètres à envoyer à l'URL. Par exemple, si vous souhaitez avec les paramètres ?p1=v1&p2=v2, vous donnerez à $vars la valeur array ('p1'=>'v1', 'p2'=>'v2').

Par défaut $vars est initialisé à tableau vide (array ()).

Note : Chaque valeur des variables subira un "urlencode".

Spécifier le nom du script à utiliser ($scriptName)

Vous pouvez spécifier le script à appeler.

Par défaut le script est initialisé avec le script de l'url actuelle. (index.php par défaut dans les URL Copix)

Le chemin de base de l'URL ($basePath)

Vous pouvez spécifier le chemin qui mène à votre script, nom de domaine inclus.

Par exemple, si vous souhaitez que le chemin soit copix.org/monsite/, alors vous spécifierez 'copix.org/monsite/'.

Par défaut, ce chemin est initialisé au chemin de l'URL actuelle.

Note : Ce chemin doit comprendre tous les slashs et caractères spéciaux. (exemple chemin/de/base/)

Le protocole ($protocol)

Vous pouvez spécifier le protocole à utiliser, sous la forme d'une chaine de caractère. Par défaut, la valeur du protocole est le protocole utilisé par l'URL actuelle (http ou https).

Note : Le protocole doit comprendre les caractères spéciaux. (exemple: http://, https:, ftp:, ...)

Exemple complet

Si vous souhaitez générer l'URL http://www.copix.org/espace/index.php/le/chemin/complet?parametre=valeur, vous auriez retourné cette réponse dans votre handler :

$obj->protocol = 'http://';
$obj->basePath = 'www.copix.org/espace/';
$obj->scriptName = 'index.php';
$obj->path = array ('le', 'chemin', 'complet');
$obj->vars = array ('parametre'=>'valeur');