Système de menu

**Benjamin GAGNEUX** · 23/03/2011, 16h37

Bonjour,

Afin de poursuivre mon auto-formation à symfony, j'ai tenté de créer un composant menu, l'objectif étant de bien comprendre le fonctionnement (l'utilisation d'un plugin pourrait facilité la chose mais ne m'aidera pas dans mon apprentissage

)

Voici ce que j'ai donc fait :

Code schema.yml :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Menu:
  connection: doctrine
  tableName: sfMenu
  columns:
    label:
      type: string(20)
    url:
      type: string(255)
    priority:
      type: integer
 
# label : libellé du menu. ex: "accueil"
# url : cible de l'item menu. ex: "http://localhost/frontend_dev.php/accueil"
# priority : indice permettant d'ordonner les menus. ex: 1

Code layout.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
 
[...]
<?php include_component("menu","index"); ?>
[...]

Le composant Menu et son template :

Code components.class.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
 
class menuComponents extends sfComponents
{
  public function executeIndex(sfWebRequest $request)
  {
    // getMenus renvoit la liste des menus ordonnés selon Priority (orderBy)
    $this->menus = Doctrine_Core::getTable('Menu')->getMenus();
 
    // affecte à currentMenu l'url demandé
    $this->currentMenu = $request->getUri();
  }
}

Code _index.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<div id="menu" class="float-right">
    <ul>
      <?php
      $last = count($menus)-1;
 
      foreach ($menus as $key=>$menu) {
        echo "<li>";
        if ($menu->getUrl()==$currentMenu) {
            echo "<span class=\"menuonpage\">".$menu->getLabel()."</span>";
        } else {
            echo link_to($menu->getLabel(),$menu->getUrl());
        }
        if ($key < $last) { echo " | " ;}
        echo "</li>";
      }  
      ?>
    </ul>
</div>

Mon menu fonctionne bien pour un contexte donné. Cependant, je ne suis pas certain que ma méthode soit "symfony-friendly" et, comme elle tient compte d'urls absolues, elle ne fonctionne pas en dehors de son contexte (frontend_dev.php/prod/etc).

Bref, je suis preneur de tout conseil

Merci d'avance.

PS: pour détailler le fonctionnement, mon menu se présente ainsi :
accueil | blog | contact

accueil est en gras car il s'agit de la page courante
les autres liens (soulignés) représente les liens vers les autres pages

**Michel Rotta** · 23/03/2011, 19h00

Salut,

J'ai cherché et abandonné...

Le mieux serait de partir non pas sur des url mais sur des routes (et uniquement des routes).

Tu peux récupérer la route utilisée par le parser depuis l'objet request et donc ne plus avoir le problèmes des paramètres.

Mais il reste des difficultés au niveau des "sous" liens, imagine un lien user qui envoie sur une liste d'user, là, ça marche. Puis tu parts vers un user en particulier (pas de liens dans le menu) et ... plouf, plus de menu en évidence...

**Benjamin GAGNEUX** · 24/03/2011, 17h33

Salut,

Merci pour ta réponse

J'ai constaté que je pouvais récupérer la route dans le template via :
$sf_context->getInstance()->getRouting()->getCurrentRouteName();
ou dans actions/components :
sfContext::getInstance()->getRouting()->getCurrentRouteName();

Cela fonctionne bien pour les routes de type list mais je ne sais pas comment m'y prendre pour des routes de type show.

Par exemple une des routes les plus utilisées est la suivante :

Code routing.yml :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
[...]
pagecontent_view:
  url: /:slugname
  class: sfDoctrineRoute
  options:
    model: Content
    type: object
  param:
    module: pagecontent
    action: show
  requirements:
    sf_method: [GET]
[...]

Les commandes ci-dessus me renvoie bien pagecontent_view mais je ne sais pas comment récupérer le slugname correspondant, ce dernier permettant d'identifier le contenu et donc de comparer avec ceux stocker dans mon menu.

Je me permets par la même occasion une question bonus. Si ma page d'accueil est sur la route pagecontent_view avec le slugname accueil (donc url : /accueil). Comment puis-je fais pour définir une nouvelle route qui permettrait d'afficher cette page à l'emplacement '/' (qui serait alors plus appropriée).

J'avais imaginer configurer la route suivante mais je ne sais pas comment fournir l'information slugname à cette dernière.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
homepage:
  url:   /
  param: { module: pagecontent, action: show }

Merci d'avance

**Michel Rotta** · 24/03/2011, 18h18

Récupérer le slug n'est pas plus difficile que le nom de la route.

Le mieux serait dans le contrôleur de le mettre à disposition du template.

Si non, par le même principe une fois que tu as l'instance, tu peux récupérer le sfRequest. De là, tu sais récupérer les paramètres et donc le slug.

Pour la deuxième question, j'ai un peu l'impression que tu veux le beurre et l'argent du beurre... l'url / avec rien pour la racine (ce qui est logique).

Et l'url /:slug pour d'autre choses, ce qui est dangereux.

Tu fais quoi si tu as une route /login et un slug = login ?

Bon, je ne suis pas sur d'avoir tout compris, mais si c'est ce que j'ai compris... faudrait envisager ce cas

**Benjamin GAGNEUX** · 30/03/2011, 20h26

Réponse un peu tardive mais vieux motard que jamais

Pour la première question, voici comment j'ai fait pour passer par les routes. L'important étant de générer les routes au niveau de chaque item du menu afin d'obtenir les urls associées, l'url de la page courrante étant déjà connue.
(suis pas sur que ce soit super optimisé mais faute de mieux...)

Code schema.yml :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Menu:
  connection: doctrine
  tableName: sfMenu
  columns:
    label:
      type: string(20)
    routename:
      type: string(255)
    paramarray:
      type: string(1024)
    priority:
      type: integer
 
# routename est le nom de la route (cf routing.yml)
# paramarray est le contenu du tableau de paramètre en chaine de caractèreq soit par exemple "mavar1"=>"toto"

Code components.class.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
  public function executeIndex(sfWebRequest $request)
  {
    $this->menus = Doctrine_Core::getTable('Menu')->getMenus();
 
    $this->currentPage = $request->getUri();
}

Code _index.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<div id="menu" class="float-right">
    <ul>
      <?php
      $last = count($menus)-1;
 
      foreach ($menus as $key=>$menu) {
        //cast de la chaine de caractère en array
        eval('$mymenuparam = array('.$menu->getParamarray(ESC_RAW).');');
 
        // génération de l'url en fonction de la route et des paramètres
        $mymenuurl = url_for($menu->getRoutename(),$mymenuparam,true);
 
        echo "<li>";
        if ($mymenuurl==$currentPage) {
            echo "<span class=\"menuonpage\">".$menu->getLabel()."</span>";
        } else {
            echo '<a href="'.$mymenuurl.'">'.$menu->getLabel().'</a>';
        }
        if ($key < $last) { echo " | " ;}
        echo "</li>";
      }  
      ?>
    </ul>
</div>

Maintenant, quelque soit le contexte, je suis capable d'identifier la page et donc son item dans le menu

Envoyé par Michel Rotta

Pour la deuxième question, j'ai un peu l'impression que tu veux le beurre et l'argent du beurre... l'url / avec rien pour la racine (ce qui est logique).

Et l'url /:slug pour d'autre choses, ce qui est dangereux.

Tu fais quoi si tu as une route /login et un slug = login ?

Bon, je ne suis pas sur d'avoir tout compris, mais si c'est ce que j'ai compris... faudrait envisager ce cas

En fait, je pensais que les routes étaient analysées par ordre de priorité, c'est à dire que la première route qui répond aux critères sera celle utilisée.
Après je fais peut être erreur.

Par contre je suis conscient du problème pour le cas de la route /login
le slug = login ne sera alors jamais pris en compte.

Mais ce projet est avant tout le moyen de connaitre les diverses possibilités de symfony (en réalisant un espèce de CMS à usage unique ^^) et bien entendu, cela ne me viendrait jamais à l'idée de livrer ce genre de chose à un client (même en lui interdisant certains slugs, je trouverais cela dangereux au niveau maintenabilité et pas très carré au niveau fonctionnel).

Concernant ma page d'accueil, en fait je cherche à savoir :
- si on peut re-router la racine vers une page (exemple / redirige vers /accueil) ? (en dehors d'un pseudo module avec redirection dans le executeIndex du controleur)
- si on peut charger une page avec le module en mode show pour un paramètre prédéfinit. par exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
homepage:
  url:   /
  param: { module: pagecontent, action: show, slugname: accueil }

Merci d'avance

**Michel Rotta** · 31/03/2011, 01h05

Concernant ma page d'accueil, en fait je cherche à savoir :
- si on peut re-router la racine vers une page (exemple / redirige vers /accueil) ? (en dehors d'un pseudo module avec redirection dans le executeIndex du controleur)

C'est la première idée qui m'est venue à l'esprit. Il n'y a pas de paramètres pour y arriver depuis les routes. Hors à trouver une astuce dans le .htaccess (et j'ai des doutes), il n'y a qu'une redirection qui pourrait marcher.

- si on peut charger une page avec le module en mode show pour un paramètre prédéfinit. par exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
homepage:
  url:   /
  param: { module: pagecontent, action: show, slugname: accueil }

Merci d'avance

Cette route ne peut marcher, pour que le paramètre slug soit passé il faudrait qu'il soit définit. Peut-être si on lui dit qu'il peut accepter des paramètres optionnels ?

On avait fait un truc dans le genre pour passer des paramètres à une action unique, l'idée était d'avoir deux url simple qui retournait un paramètre par défaut. Mais pour cela, il faut qu'il y ait au moins un paramètre dans la route.

J'ai inventé une machine à couper les cheveux en quatre, au cas où.

Encore une chose, il y a un plugin intéressant, que j'ai déjà utilisé : pmSuperfishMenuPlugin, il y a peut-être des trucs à récupérer ?

**Benjamin GAGNEUX** · 31/03/2011, 14h04

Merci pour ta réponse

Concernant les routages, je commence à comprendre la philosophie du truc...

Maintenant que mon menu est fonctionnel, je vais regarder de plus près ce plgin. Ce dernier pourrait m'être utile pour un prochain projet et, dans le pire des cas, cela restera tout de même très instructif

**Michel Rotta** · 31/03/2011, 14h22

En fait il a des avantages : le menu est modifiable dynamiquement, il peut être préparé en yaml.

Et des inconvénients : le menu en yaml est interprété à chaque fois (pas de mise en cache), impossible de limiter simplement une option aux personnes logguées ou pas, impossible de gérer des options style "cochée", impossible de mettre une aide (title), impossible de mettre une image pour une option de menu,... de quoi largement améliorer le truc !

**Benjamin GAGNEUX** · 31/03/2011, 15h34

Merci pour ces infos

Cela m'amène à la question suivante

:
Est-ce que mon composant menu peu, tel qu'il est structuré, gérer la mise en cache ?
(le système de cache sous symfony reste assez obscure pour moi malgré le tuto)

**Michel Rotta** · 31/03/2011, 16h09

Tu ne peux mettre en cache que des éléments qui durent.

Donc chez toi, tu ne pourrais cacher qu'un array résultant de la lecture de la table (une requête d’économisée). Le reste est la génération du html, qui est dynamique. Sauf à reporter en javascript la mise en évidence du lien actif... (ce qui serait peut-être moins lourd).

En relisant ton code, je me dis que tu aurais intérêt à le mettre dans un componnement. Et que le template n'est pas conforme, il embarque plus que du simple affichage (MVC...) il devrait être en partie préparé dans un tableau dans la contrôleur (avantage du componnement qui à son propre contrôleur), ainsi le code dans le template serait plus MVC et plus symfony template.

**Benjamin GAGNEUX** · 07/04/2011, 18h06

Je ne saisie pas trop, mon menu est déjà un composant je crois (components.class.php à la place de actions.class.php et appel dans le layout par la commande include_component). A moins que quelque chose m'échape ?

J'ai retouché mon menu afin qu'il puisse gérer le cache (enfin je pense)
En voici le détail :

Code components.class.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
class menuComponents extends sfComponents
{
  public function executeIndex(sfWebRequest $request)
  {
    $menus = Doctrine_Core::getTable('Menu')->getMenus();
    $currentPage = $request->getUri();
 
    $last = count($menus)-1;
 
    $linemenu = array();
 
    foreach ($menus as $menu) {
      //cast de la chaine de caractère en array
      eval('$menu_param = array('.$menu->getParamarray().');');
 
      // génération de l'url en fonction de la route et des paramètres
      $menu_url = url_for($menu->getRoutename(),$menu_param,true);
 
      $linemenu[] = array ($menu_url,$menu->getLabel());      
    }
 
    $this->menus = $linemenu;
  }
}

mon template :

Code _index.php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<div id="menu" class="float-right">
    <ul>
    <?php 
        $last = count($menus);
        for ($i = 0; $i < $last;$i++)
        {
            echo "<li>";
            echo '<a href="'.$menus[$i][0].'" class="menulink">'.$menus[$i][1].'</a>';
            echo '<span class="menuitem" data-url="'.$menus[$i][0].'">'.$menus[$i][1].'</span>';
            if ($i < $last -1) { echo " | " ;}
            echo "</li>";
        }  
    ?>
    </ul>
</div>

et mon js correspondant (les class menuitem sont cachés par défaut) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
$(document).ready(function() {
    var pcurrenturl = window.location.href;
 
    $(".menulink").each(function (index, url) {
        if (url == pcurrenturl) {
            $(this).hide();
        }
    }) 
 
    $(".menuitem").each(function (index, element) {
        if ($(this).data("url") == pcurrenturl) {
            $(this).show();
        }
    })
});

Qu'en pensez-vous ?

**Michel Rotta** · 08/04/2011, 08h08

Je ne vois pas trop où est le cache...

Vu qu'il est des plus statiques, il devrait pouvoir être caché au niveau du template.

Ton template n'est pas conforme à l'écriture préconisée par sensio pour les templates php.

**Benjamin GAGNEUX** · 08/04/2011, 16h35

Je ne vois pas trop où est le cache...

Effectivement, j'ai oublié de fournir le fichier correspondant

:
module/menu/config/cache.yml

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
_index:
  enabled: true
  with_layout: true

Ton template n'est pas conforme à l'écriture préconisée par sensio pour les templates php.

Je débute et je n'ai pas trouvé de référence concernant l'écriture des templates pour symfony (j'ai peut être mal cherché ?).
Cependant, je constate effectivement que les templates semblent s'appuyer essentiellement sur du HTML avec quelques lignes php.
Dois-je éviter les blocs php ?
Est-ce que ce template correspond mieux ?

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
<div id="menu" class="float-right">
    <ul>
        <?php $last = count($menus) ?>
        <?php for($i = 0; $i < $last;$i++): ?>
            <li>
                <a href="<?php echo $menus[$i][0] ?>"class="menulink"><?php echo $menus[$i][1] ?></a>
                <span class="menuitem" data-url="<?php echo $menus[$i][0] ?>"><?php echo $menus[$i][1] ?></span>
                <?php if ($i < $last -1) { echo " | " ;} ?>
            </li>
        <?php endfor; ?>
    </ul>
</div>

Merci d'avance

**Michel Rotta** · 10/04/2011, 13h12

En mode debug tu as la possibilité dans la barre de vérifier l'utilisation du cache, n'hésite pas à vérifier si ce que tu as paramétré est bien pris en compte.

Effectivement, cette version du template est conforme à la norme.

En gros, dans le template un minimum d'intelligence php, sauf pour faire une boucle de lecture d'un objet où une condition pour l'affichage. C'est le html qui prime.

Dans le contrôleur ou le modèle, c'est le php qui prime, le fichier commence par un

Code :

Sélectionner tout - Visualiser dans une fenêtre à part