ezurl

Date de publication: le jeudi 31 mars 2011 à 15h53
Dernière modification: par Pascal BOYER le vendredi 1 avril 2011 à 11h21

11/08/2006 01:00

toutes versions

Summary / Résumé

Returns a working version of an eZ Publish URL (provided as input).
Renvoie une version fonctionnelle/valide d'un URI eZ Publish (fourni en entrée).

Usage / Utilisation

input|ezurl( [ quote [, type ] ] )

Parameters / Paramètres

Returns / Renvoie

A quoted string containing a valid / working version of the input URL.
Une chaîne de caractères entre guillemets contenant une version valide/fonctionnelle de l'URI passée en entrée.

Description

This operator takes an eZ Publish URL as input (either a system URL or a virtual URL); based on the location of the eZ Publish folder, the access settings and the environment, it will produce a valid address. All eZ Publish URLs that are specified in templates should always be piped through this operator; it will make sure that the URLs work regardless where eZ Publish is installed, which access method is used, and so on.
Cet opérateur prend un URI eZ Publish en entrée (soit un URI system soit un URI virtuel ) puis, en fonction de l'emplacement du répertoire d'installation de eZ Publish, des paramètres de configuration et de l'environnement, produit une adresse valide. Les URI eZ Publish définis dans les templates devraient toujours être pipés (lire «paillepés» qui signifie «redirigés vers») vers cet opérateur afin de s'assurer qu'ils fonctionnent indépendamment de l'emplacement d'installation de eZ Publish, de la méthode d'accès utilisée, etc...
 
By default, this operator returns a relative URL as a double-quoted string. The optional "quote" parameter can be used to control the way the address is returned: "no" (no quotes), "single" (single quotes) or "double" (double quotes, the default). The optional "type" parameter controls whether relative or full URL is returned.
Par défaut, cet opérateur renvoie un URI «relatif» au format chaîne de caractères placée dans des guillemets doubles. Alors que le paramètre optionnel quote contrôle la manière dont l'adresse est retournée: no (aucun guillemet), single (guillemet simple) ou double (guillemet doubles - c'est la valeur par défaut), le paramètre optionnel type définit le type absolu ou relatif de l'URI renvoyé.

Exemple 1

Let's say that we're running a site called "my_company" (name of the siteaccess) and that we wish to create a link to the full view of node number 1024. Instead of specifying the entire URL (domain and all included) in the link tag, we pipe "/content/view/full/1024" or the virtual URL (for example "/test") through the "ezurl" operator:
Supposons que nous ayons un site nommé my_company (nom du siteaccess) et que nous souhaitions créer un lien vers une vue full du noeud numéro 1024. Plutôt que de spécifier l'URI en entier (nom de domaine et tout le reste) dans une balise link, nous allons rediriger /content/view/full/1024 ou l'URI virtuel (par exemple /test) vers l'opérateur ezurl:

<a href={'/content/view/full/1024'|ezurl(,'full')}>Test</a>
<a href={'/test'|ezurl(,'full')}>Test</a>

The operator will take care of translating the URLs into valid addresses depending on the setup and the environment eZ Publish is running in. If eZ Publish is running in a virtual host environment and uses the host access method, the following type of URLs will be produced:
L'opérateur s'assure de la traduction de l'URI en adresses valides en tenant compte de la configuration et de l'environnement dans lequel s'exécute eZ Publish. Si ce dernier tourne dans un environnement d'hôte virtuel et utilise la méthode d'accès par hôte , alors les URI suivants seront produits:

"http://www.example.com/content/view/full/1024"
"http://www.example.com/test"

The "index.php" part of the URL will be supressed by the virtual host configuration. The name of the siteaccess will not appear in the URL because eZ Publish will use the domain/host to figure out which siteaccess to use.
La partie index.php de l'URI est supprimée par la configuration d'un hôte virtuel et le nom du siteaccess n'apparaît pas non plus puisqu'eZ Publish utilise le domaine/l'hôte pour savoir quel siteaccess utiliser.
 
If eZ Publish is running in a non-virtual host environment and uses the uri access method, the following URLs will be produced:
Si eZ Publish ne s'exécute pas dans un environnement d'hôte virtuel et utilise la méthode d'accès par URI , alors les URI suivants seront produits:

"http://www.example.com/index.php/my_company/content/view/full/1024"
"http://www.example.com/index.php/my_company/test"

Exemple 2

<a href={'/content/view/full/1024'|ezurl()}>Test</a>
<a href={'/test'|ezurl()}>Test</a>

If eZ Publish is running in a virtual host environment and uses the host access method, the following type of URLs will be produced:
Si eZ Publish tourne dans environnement d'hôte virtuel et utilise la méthode d'accès par hôte, alors les URI suivants seront produits:

"/content/view/full/1024"
"/test"

The "index.php" part of the URL will be supressed by the virtual host configuration. The name of the siteaccess will not appear in the URL because eZ Publish will use the domain/host to figure out which siteaccess to use.
La partie index.php de l'URI est supprimée par la configuration d'un hôte virtuel et le nom du siteaccess n'apparaît pas non plus puisqu'eZ Publish utilise le domaine/l'hôte pour savoir quel siteaccess utiliser.
 
If eZ Publish is running in a non-virtual host environment and uses the uri access method, the following URLs will be produced:
Si eZ Publish ne s'exécute pas dans un environnement d'hôte virtuel et utilise la méthode d'accès par URI, alors les URI suivants seront produits:

"/index.php/my_company/content/view/full/1024"
"/index.php/my_company/test"

Commentaires