Ma cave sur eZ Publish : Les Templates (Partie 2)

• Publié le 16 Février 2009
• 9 commentaire(s)
• Catégorie : Technologies Web

Une fois les classes de contenus crées, il s'agit d'organiser et de développer les templates. Ma stratégie d'affichage fonctionne autour du principe suivant : "Comment être le plus fainéant possible, en générant un maximum de pages avec le moins de code possible".

Le principe utilisé est celui de l'entonnoir : C'est à dire que chaque niveau d'affichage contient l'affichage des sous niveaux, et ainsi dessuite.

Par exemple la page par région contient :

• La liste de tous les domaines de la région
• La liste de toutes les localisations Google maps de la région
• La liste des appellations de la région
• La liste de toutes les cuvées par appellations, etc.

Les pages intermédiaires des appellations, des domaines et des cuvées fonctionnent sur le même principe, et recyclent ainsi des blocs d'affichages identiques.

Les fichiers de templates et les overrides

Création des fichiers selon certaines conventions

Chaque template est personnalisé par overrides et respecte quelques conventions. Ce n'est pas obligatoire, mais cela facilite la compréhension du code et l'entretien du site :

• [class_identifier]_full.tpl : La vue complète du noeud
• [class_identifier]_line.tpl : La vue en ligne du noeud (pour une liste par exemple)
• [class_identifier]_XXX.tpl : Une vue particulière du noeud (résumé, résultat de recherche, etc.)

Cela donne dans mon cas, par exemple pour les templates des cuvées, créés dans le répertoire extension/[mon_extension]/design/[mon_design]/override/templates/cave/ :

• cave_cuvee_full.tpl : page d'une cuvée
• cave_cuvee_line.tpl : ligne représentant une cuvée, dans tous les tableaux de toutes les pages du site
• cave_cuvee_box.tpl : bloc d'affichage détaillée d'une cuvée (photo, description), dans tous les pages du site

Définition de overrides de templates

Le fichier extension/[mon_extension]/settings/siteaccess/[mon_siteaccess]/override.ini.append.php permet de déclarer toutes les correspondances entre les classes, les types de vues et les templates. Par exemple pour les 3 templates des cuvées :

[cave_cuvee_full]
Source=node/view/full.tpl
MatchFile=cave/cave_cuvee_full.tpl
Subdir=templates
Match[class_identifier]=cave_cuvee
 
[cave_cuvee_line]
Source=node/view/cave_cuvee_line.tpl
MatchFile=cave/cave_cuvee_line.tpl
Subdir=templates
Match[class_identifier]=cave_cuvee
 
[cave_cuvee_box]
Source=node/view/cave_cuvee_box.tpl
MatchFile=cave/cave_cuvee_box.tpl
Subdir=templates
Match[class_identifier]=cave_cuvee
 
 

Exploitation des vues dans le code des templates

Ainsi la fabrication des tableaux listant les cuvées fonctionne toujours sur le même principe :

<table class="cuvee_table">
 <tbody>
 {foreach $cuvees as $index => $cuvee}
  {node_view_gui content_node=$cuvee view=cave_cuvee_line}
 {/foreach}
 </tbody>
</table>
 
 

Le tableau $cuvees est le résultat d'un fetch, dont la composition varie en fonction des pages et des paramètres.

Pour aller jusqu'au bout de la description, voici un aperçu du template cave_cuvee_lien.tpl :

{def $stock = concat('stock_', $node.data_map.stock.content)
 $rating = $node.data_map.rating.content.data_map.rating.content
 $couleur = $node.data_map.couleur.content.data_map.css_identifier.content}
 
{def $prix = $node.data_map.prix.content|wash}
{if $prix|eq(0)}
 {set $prix = 'N.C.'}
{else}
 {set $prix = concat($prix, ' €')}
{/if}
 
{def $appelation = fetch( content, object, hash( object_id, $node.data_map.appelations.content.relation_list.0.contentobject_id ) )}
 
<tr class="{$stock}">
 <td class="td5"><div title="{$node.data_map.couleur.content.name} // " class="{$couleur} couleur"> </div></td>
 <td class="td400"><a title="{$appelation.main_node.parent.name|wash} // {$appelation.name|wash}" href={$node.parent.url_alias|ezurl}>{$node.parent.name|wash}</a> - <a class="cuvee_invert" href={$node.url_alias|ezurl}>{$node.name|wash}</a></td>
 <td class="td80 {$stock}"><a href={$node.url_alias|ezurl} title="{$node.data_map.stock.content|wash} bouteille(s) en cave // ">{$node.data_map.stock.content|wash}</a></td>
 <td class="td80"><div class="rating rating_{$rating}" title="Vin {$node.data_map.rating.content.name} // {if $rating|eq(0)}Pas encore bu ...{else}Cet avis est personnel et n'engage que moi !{/if}"></div></td>
 <td class="td80"><a title="Prix indicatif // Le prix varie selon le mode d'achat" href={$node.url_alias|ezurl}>{$prix}</a></td>
</tr>
 
{undef $stock $rating $couleur $prix $appelation}
 
 

On peut observer les quelques astuces pour gérer les notations (icônes des 5 bouteilles) en CSS, en modifiant dynamiquement le nom la classe CSS correspondante à chaque fond d'images.

Cas particulier : la liste des cuvées par appellation

La logique d'association des données rend l'opération un peu complexe. Il s'agit en quelques sorte d'effectuer la requête suivante :

• Listes moi toutes les cuvées de la région (noeud parent de l'appellation) associées (par un attribut de type Object relations) à l'appellation courante (le noeud courant)

Il est nécessaire dans ce cas de créer un Extended Attribute Filter permettant lors d'un fetch de filtrer les objets (ici les cuvées) par un objet associé (ici l'appellation courante). Ce mécanisme n'est pas très bien documenté, et il nécessite une bonne connaissance du modèle de données eZ Publish. Voici une extraction simplifiée du code :

Déclaration de l'Extended Attribute Filtre

Il faut créer le fichier extension/[mon_extension]/settings/extendedattributefilter.ini.append.php

<?php /* #?ini charset="utf-8"?
 
[relatedObject]
ExtensionName=myblog
ClassName=relatedObjectClass
MethodName=relatedObjectMethod
FileName=classes/relatedobject.php
*/ ?>
 
 

Implémentation du code

Il faut donc créer le fichier extension/[mon_extension]/classes/relatedobject.php. Cet exemple est simplifié pour rendre plus compréhensible la logique du code. Il est conseillé, à long terme, de factoriser ce genre de code pour gérer tous les types de situations (plusieurs object_id, autres types de relations, sélection de l'attribut...).

<?php
 
class relatedObjectClass
{
 function __construct()
 {
 }
 
 function relatedObjectMethod($params)
 {
  $sqlJoins = array();
  $sqlTables  = array();
 
  if(isset($params['relations'])){
   foreach ($params['relations'] as $key => $relation) {
    if ( isset($relation['related_object_id']) ) {
     $table = 'tab_'.$key;
     $sqlTables[] = 'ezcontentobject_link AS '.$table;
     $sqlJoins[] = 'ezcontentobject_tree.contentobject_id = '.$table.'.from_contentobject_id AND ezcontentobject_tree.contentobject_version = '.$table.'.from_contentobject_version';
     $sqlJoins[] = $table.'.to_contentobject_id='.(int)$relation['related_object_id'];
    }
   }
  }
 
  $sqlJoins = join(' AND ', $sqlJoins);
  $sqlTables = join(', ', $sqlTables);
  if (trim($sqlTables) != '') { $sqlTables = ', '.$sqlTables;}
  if (trim($sqlJoins) != '') {$sqlJoins .= ' AND ';}
   
  return array('tables' => $sqlTables, 'joins'  => $sqlJoins);
 }
}
 
?>
 
 

Appel dans le template

{def $vin_cuvees = fetch( 'content', 'tree', hash( 'parent_node_id', $node.parent.node_id,
 'class_filter_type',  'include',
 'class_filter_array', array('cave_cuvee'),
 'sort_by', array( array( 'path_string', true() ) ),
 'extended_attribute_filter',  hash(id, 'relatedObject',
  'params', hash( 'relations',
  array( hash('related_object_id',
   $node.object.id ) ) ) )
) )}
 
 

• Tags :
• Extended Attribute Filter
• eZ Publish
• Object Relations