include

Date de publication: le jeudi 31 mars 2011 à 15h06
Dernière modification: par Pascal BOYER le jeudi 31 mars 2011 à 15h37

28/04/2005 3:55

toutes versions

Summary / Résumé

Includes a file.
Inclut un fichier.

Usage / Utilisation

{include uri='path_to_file' [ name='namespace' ] [ parameter(s)='value(s)' ]}

Parameters / Paramètres

Description

This function includes a file in the template from where the function was called. The "uri" parameter must be used to specify the target file. In most cases, the value of this parameter starts with a "design:", which tells the system to look for the desired template within the current (and fallback) design resources. The "name" parameter can be used to specify an alternative namespace for the included template, this is useful for avoiding variable name clashes when including other templates. All other parameters will be passed to the included template as template variables. This function makes it possible to share template code among different parts of the solution.
Cette fonction inclut un fichier dans le template depuis lequel la fonction est utilisée. La valeur du paramètre uri, qui permet de spécifier le fichier cible, commence dans la plupart des cas par design: indiquant ainsi au système de rechercher le template à inclure dans le répertoire du design courant (le système de repli automatique sera appliqué si le template n'est pas trouvé dans le design courant). Le paramètre name définit un (espace de) nom alternatif pour le template inclus permettant ainsi d'éviter les collisions de noms lors de l'inclusion d'autres templates. Tous les autres paramètres seront passés au template inclus en tant que variables de template. Cette fonction permet de partager du code de template entre différentes parties de la solution (???).

Exemple 1

{include uri='design:example/menu.tpl' something='Hello world'}

This example demonstrates how to include a template called "menu.tpl" (which is located within the "example" subdirectory of the "templates" directory. If eZ Publish is unable to find the template in the current design, it will automatically attempt to locate it in one of the fallback designs or the standard design. The value of the "something" parameter will be available through a variable called $something within the template that is included.
Cet exemple illustre la marche à suivre pour inclure un template nommé menu.tpl (situé dans le sous-répertoire example du répertoire templates). Si eZ Publish ne trouve pas le template menu.tpl dans le design courant, il essaie alors automatiquement de le trouver dans l'un des designs de repli puis dans le design standard. La valeur d'un paramètre quelquechose sera disponible dans le template inclus via une variable nommées $quelquechose.