• <module~action> : Sélecteur de l'action qui doit être appelée par les liens de pages.
• <paramètres de l'action> : Tableau contenant les paramètres métiers à placer dans l'url des liens de pages. Ex : array("param1" => 1, "param2" => "deux")
• <nombre total de résultats> : Nombre entier représentant le nombre total des résultats répondant à votre requête. Vous devez donc l'avoir calculé au préalable.
• <index résultat courant> : Nombre entier représentant l'offset, c'est-à-dire l'index du résultat courant. En clair : le numéro d'ordre du premier enregistrement afficher sur la page. Pour la première page, vous mettrez 0. Pour les pages suivantes, il est calculé automatiquement et passé dans le paramètre dont vous indiquez le nom dans <nom du paramètre d'offset>.
• <nombre de résultats par page> : Nombre entier représentant le nombre de résultats contenus dans une page de résultats. Important : le plugin ne s'affichera pas s'il n'y a pas au moins 2 pages de résultats disponibles.

<propriétés d'affichage> est un tableau contenant les paramètres liés à l'affichage du plugin. Ce paramètre est optionnel. S'il est omis, le plugin utilise le comportement par défaut, à savoir qu'il affiche l'intégralité des liens avec leur intitulé par défaut.

Il est donc possible de personnaliser l'affichage, en définissant le nombre de liens à afficher ainsi que les intitulés des liens spéciaux (page suivante, page précédente, etc.). Pour cela on ajoute simplement un tableau de paramètres supplémentaires comme ci-dessous dans l'appel.

  <p>{pagelinks 'myModule~default_index', array(),  283, 60, 15, "offset", 
     array('start-label' => 'début', 
           'end-label' => 'fin', 
           'prev-label'  => 'précédent', 
           'next-label'  => 'suivant', 
           'area-size'  => 5)}</p>

Il est ainsi possible de renseigner une ou plusieurs des valeurs d'index suivantes qui viendront écraser le comportement défini par défaut.

• @@start-label@ : Libellé du lien de la première page de résultats disponible.
• prev-label : Libellé du lien de la page de résultats précédente.
• next-label : Libellé du lien de la page de résultats suivante.
• end-label : Libellé du lien de la dernière page de résultats disponible.
• area-size : Nombre de liens à afficher avant et après la page courante. Si la valeur est 0, tous les liens seront affichés.

Siun label est vide, le lien correspondant ne sera jamais affiché. Bien entendu, il est aussi possible de possible d'utiliser un tableau de paramètres déclaré dans le contrôleur.

  $properties = array('start-label' => '',
                      'prev-label'  => 'précédent',
                      'next-label'  => 'suivant',
                      'end-label'   => '',
                      'area-size'   => 5);
  
  $rep->body->assign('properties',$properties);

L'appel du template aura donc la forme suivante.

  <p>{pagelinks 'myModule~default_index', array(),  283, 80, 15, 
              "offset", $properties}</p>

Il est possible de localiser les intitulés des liens spéciaux en utilisant jLocale de la façon suivante.

  $properties = array('start-label' => jLocale::get("bar~foo.pagelinks.start"),
                      'prev-label'  => jLocale::get("bar~foo.pagelinks.prev"),
                      'next-label'  => jLocale::get("bar~foo.pagelinks.next"),
                      'end-label'   => jLocale::get("bar~foo.pagelinks.end"),
                      'area-size'   => 0);

Le plugin Pagelinks ajoute des classes CSS sur les elements html qu'il génère pour permettre de styler les liens de pagination comme désiré.

• ul.pagelinks : sélecteur css de la liste des pages disponibles
• li.pagelinks-start : sélecteur css du lien vers la première page de résultats
• li.pagelinks-prev : sélecteur css du lien vers la page de résultats précédente
• li.pagelinks-current : sélecteur css de la page de résultats courante
• li.pagelinks-disabled : sélecteur css des pages de résultats désactivées
• li.pagelinks-next : sélecteur css du lien vers la page de résultats suivante
• li.pagelinks-end : sélecteur css du lien vers la dernière page de résultats

Exemple de feuille de style minimaliste pour une utilisation de Pagelinks avec les propriétés d'affichage par défaut.

  ul.pagelinks>li {
      display: inline;
  }
  
  ul.pagelinks>li:before {
      content: ' | ';
  }
  
  ul.pagelinks>li.pagelinks-start:before {
      content: '';
  }

Mais vous pouvez aussi utiliser vos propres classes, en les indiquant dans les propriétés 'start-class', 'prev-class', etc, comme dans cet exemple :

  $properties = array(
      'start-class' => 'pagelinks-start',
      'prev-class' => 'pagelinks-prev',
      'next-class' => 'pagelinks-next',
      'end-class' => 'pagelinks-end',
      'list-class' => 'pagelinks',
      'current-page-class' => 'pagelinks-current',
      'page-class' => '',
      'disabled-class' => 'pagelinks-disabled'
  );

Il y a deux autres plugins à votre disposition pour mieux contrôler un cycle. cycle_init pour (ré)initialiser un cycle, et cycle_reset pour le repositionner au debut de la liste des valeurs.

  {cycle_init 'style1,style2,style3'}
  {foreach $liste as $item}
   <tr class="{cycle}">
      <td>...<td>
   </tr>
   {if $item == 'truc'}
      {cycle_reset}
   {/if}
  {/foreach}

Notez que cycle_init attend une chaine avec les valeurs séparées par des virgules, ou un tableau de valeurs.

Il se peut que dans une page web, vous voulez reutiliser le même cycle à plusieurs endroits, ou utiliser plusieurs cycles dans une même boucle. Il vous faut alors donner des noms à vos cycles. Le nom doit être indiqué en tant que premier argument.

  {foreach $liste as $item}
   <tr class="{cycle 'premier', array('impair','pair')}">
      <td class="{cycle 'styletd',array('style1,style2,style3')}">...<td>
   </tr>
  {/foreach}


  {cycle_init 'styles', 'style1,style2,style3'}
  {foreach $liste as $item}
   <tr>
      <td class="{cycle 'styles'}">...<td>
      <td class="{cycle 'styles'}">...<td>
   </tr>
  {/foreach}

Le résultat de la deuxième boucle sera

   <tr>
      <td class="style1">...<td>
      <td class="style2">...<td>
   </tr>
   <tr>
      <td class="style3">...<td>
      <td class="style1">...<td>
   </tr>
   <tr>
      <td class="style2">...<td>
      <td class="style3">...<td>
   </tr>
...

Module ¶

File ¶

Paramètres additionnels ¶

Ce modificateur, permet d'ajouter toutes les fonctionnalités de votre choix dans vos templates.

Pour exploiter les hooks vous écrirez dans votre template :

{hook 'eventname', $params}

où eventname est le nom de l'évènement déclenchant la récuperation de toutes les fonctionnalités et $params est un tableau de paramètres à passer au listener qui répondra à eventname.

Exemple dans le template main.tpl :

{hook 'SampleBannerAnnouncement'}

affichera une bannière d'annonce dans le template de votre choix, en répondant à l'évènement SampleBannerAnnouncement.

Ceci vous permettra de comprendre, en lisant le nom d'un évènement, à quel template il est lié. Ceci n'est pas une règle figée dans le marbre mais une façon de vous y retrouver dans vos futurs hooks.

• BeforeTemplateName
• TemplateName
• AfterTemplateName

où :

• TemplateName est le nom du template où le hook est utilisé
• BeforeTemplateName est le nom du hook appelé au début du template TemplateName
• TemplateName est le nom de l'évènement où le hook est appelé (en général au beau milieu du template)
• AfterTemplateName est le nom du hook appelé à la fin du template TemplateName

Il faut produire un module (ou mettre toute la mécanique suivante dans une module existant) avec :

• un listener
• une zone
• un template

Le Listener sera chargé de la réponse à l'évènement appelé dans la zone :

class hookListener extends jEventListener{
    
   function onhfbSampleBannerAnnouncement ($event) {
        $event->add( jZone::get('hook~samplebanner_accouncement') );
   } 
}

Le fichier events.xml définissant le listener qui répondra à l'évènement :

<?xml version="1.0" encoding="iso-8859-1"?>
<events xmlns="http://jelix.org/ns/events/1.0">
   <listener name="hook">
	    <event name="hfbSampleBannerAnnouncement" />
   </listener>
</events>

La zone qui exploitera les données de votre choix et fournira le template :

class samplebanner_accouncementZone extends jZone {
    protected $_tplname='zone.samplebanner_accouncement';
    
    protected function _prepareTpl(){    
        $this->_tpl->assign('text',jLocale::get('hook~main.welcome'));
    }        
}

Le template qui affichera les données retournées au template appelant :

<div class="grid_16">
    <div class="box">
    <h2>Banner</h2>
    {$text}
    </div>
</div>
<div class="clear"></div>

Tout ceci sera renvoyé automatiquement au template main.tpl (de notre exemple) à l'endroit voulu.