Archives mensuelles : avril 2014

Aide de vue dans les layouts de Zendframework 2 : Exemple

Présentation de l'exemple

Une aide de vue, ou ViewHelper, sert à factoriser des bouts de code pour nos views ou layouts.

L'appel à notre aide de vue se fera très simplement. Prenons par exemple le cas où on a besoin de déclarer des feuilles de style dont les noms sont contenus dans un tableau :

$base_path = $this->basePath(); 
echo $this->getHeadLinks($base_path, $favicon_file = null, $this->config['css']);

Dans cet exemple, on utilise deux aides de vue, basePath() qui est fournie dans le package Zendframework 2 et getHeadLinks() que je vais développer ci-dessous.

Pour mon aide de vue je passe trois paramètres :

  • $base_path : la racine du service fournie par l'aide de vue de ZendFramework
  • $favicon_file : le favicon à utiliser pour cette page
  • $config['css'] : le tableau provenant du config/module.config.php

Dans config/module.config.php, je décris les feuilles de style à charger de la façon suivante :

return array(
    ...
    'css' => array(
        'css/style.css',
        'css/nav.css',
        array(
            'href' => 'css/ie7.css',
            'media' => 'screen',
            'conditionalStylesheet' => 'lt ie7',
            'extras' => array('id' => 'dafap',) 
        ),
    ),
    ...

cela devra donner dans le code de la page :

<!--[if lt ie7]> <link href="/css/ie7.css" media="screen" rel="stylesheet" type="text/css" id="dafap" /><![endif]-->
<link href="/css/nav.css" media="screen" rel="stylesheet" type="text/css">
<link href="/css/style.css" media="screen" rel="stylesheet" type="text/css">
<link href="/img/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon">

Implémentation de notre aide de vue

Une aide de vue, ou ViewHelper, est une classe dérivée de Zend\View\Helper\AbstractHelper. Pour mon cas, je l'appelerai HeadLinks et elle sera placée dans le src du module, dossier View/Helper :

module
  └ MonModule
          └ src
               └ MonModule
                        └ View
                             └ Helper

Sa méthode _invoke() retournera le résultat en invoquant son nom déclaré dans module.php dans la méthode getViewHelperConfig().

public function getViewHelperConfig()
{
    return array(
        'invokables' => array(
            'getHeadLinks' => __NAMESPACE__ .'\View\Helper\HeadLinks',
        ),
    );
}

Dans mon aide de vue, j'ai besoin d'utiliser l'aide de vue headLink de Zendframework. Or, je ne peux pas utiliser l'alias headLink qui n'est pas invokable. Je vais donc utiliser la classe directement.

namespace MonModule\View\Helper;
use Zend\View\Helper\AbstractHelper;
use Zend\View\Helper\HeadLink;

class HeadLinks extends AbstractHelper
{
   public function __invoke($base_path, $favicon_file = null, $cssFilesArray = array())
   {
     $headLink = new HeadLink();
     if (! is_null($favicon_file) && is_string($favicon_file)) {
         $headLink = $headLink(array(
             'rel' => 'shortcut icon',
             'type' => 'image/vnd.microsoft.icon',
             'href' => $this->concatPath($base_path, $favicon_file)
         ));
     } else {
         $headLink = $headLink();
     }
     foreach ($cssFilesArray as $css_file) {
         if (is_string($css_file)) {
             $headLink = $headLink->prependStylesheet($this->concatPath($base_path, $css_file));
         } elseif (is_array($css_file)) {
             $href = $this->getParam('href', $css_file);
             $media = $this->getParam('media', $css_file);
             $conditionalStylesheet = $this->getParam('conditionalStylesheet', $css_file);
             $extras = $this->getParam('extras', $css_file);
             if (!is_null($href)) {
                 $headLink = $headLink->prependStylesheet($this->concatPath($base_path, $href), $media, $conditionalStylesheet, $extras);
             }
         } else {
             throw new \Exception('Erreur de structure pour la définition des fichiers css.');
         }
     }
     return $headLink;
   }
   private function getParam($nom, $tableau)
   {
       if (array_key_exists($nom, $tableau)) {
           return $tableau[$nom];
       } else {
           return null;
       }
   }
   private function concatPath($base_path, $file = null)
   {
       if (! is_null($file)) {
           $file = '/' . ltrim($file, '/');
       }
       $base_path = rtrim(str_replace('\\', '/', $base_path), '/');
       return $base_path . $file;
   }
}

Utilisation de mon aide de vue dans un layout

Pour utiliser mon aide de vue dans un layout, je dois disposer d'une variable $this->config qui contient notamment la clé 'css' donnant la structure à monter (en fait, je passe également dans ce tableau tous les éléments constitutifs du layout comme les composants du header, du footer, etc.).

Comment passer une variable à un layout ?

Première façon : depuis un contrôleur

Dans un contrôleur, on a accès au layout par la méthode layout(). On crée donc les variables directement :

$this->layout()->ma_variable = $valeur;

En particulier pour mon cas, je trouverai la valeur de ma variable de configuration de la façon suivante :

$sm = $this->getServiceLocator();
$config = $sm->get('config');
$this->layout()->config = $config['layout'];

Deuxième façon : depuis la classe Module

Etant donné que la configuration est disponible dans la classe Module, on peut créer la variable depuis la méthode onBootstrap() de cette classe :

 public function onBootstrap(MvcEvent $e)
 {
     $eventManager = $e->getApplication()->getEventManager();
     $config = $this->getApplication()->getServiceManager()->get('config');
     $config_layout = $config['layout'];
     $eventManager->attach(MvcEvent::EVENT_RENDER, function($e) use ($config_layout) {
         $e->getViewModel()->setVariable('config', $config_layout);
   });
   $moduleRouteListener = new ModuleRouteListener();
   $moduleRouteListener->attach($eventManager);
 }

Troisième façon : en dérivant la classe Module de ZfcBase\Module\AbstractModule

On devra alors restructurer le fichier module.config.php de la façon suivante :

return array(
    'MonModule' => array(
        'layout' => array(
            'css' => array(
                'css/style.css',
                'css/nav.css',
                array(
                    'href' => 'css/ie7.css',
                    'media' => 'screen',
                    'conditionalStylesheet' => 'lt ie7',
                    'extras' => array('id' => 'dafap',)
                ),
            ),
            ...
        ),
    ),
    ...
);

Ainsi, on pourra utiliser dans le module la méthode getOptions() :

namespace MonModule;
use ZfcBase\Module\AbstractModule;
class Module extends AbstractModule
{
 public function onBootstrap(MvcEvent $e)
 {
     $eventManager = $e->getApplication()->getEventManager();
     $config_layout = $this->getOptions('layout');
     $eventManager->attach(MvcEvent::EVENT_RENDER, function($e) use ($config_layout) {
         $e->getViewModel()->setVariable('config', $config_layout);
   });
   $moduleRouteListener = new ModuleRouteListener();
   $moduleRouteListener->attach($eventManager);
 }
 public function getDir()
 {
     return __DIR__;
 }
 public function getNamespace()
 {
     return __NAMESPACE__;
 }
}

Cela va permettre d'utiliser une configuration particulière pour chaque module de l'application. Mais ça, ce sera l'objet d'un prochain article.

Voir aussi un article complet sur la création d'un ViewHelper dans ZF2.

Utilisation de composer.phar

Le fichier composer.phar doit être présent à la racine du projet qu'il va gérer.

S'il n'est pas présent, on peut l'installer par la commande :

shell\mon_projet>curl -s http://getcomposer.org/installer | php

S'il est présent, on peut lancer une recherche pour obtenir sa dernière version stable :

shell\mon_projet>php composer.phar self-update

Ensuite, il faut créer un fichier composer.json qui va décrire le projet. On peut utiliser la commande :

shell\mon_projet>php composer.phar init

Cette commande va demander d'indiquer les renseignements décrivant le projet :

  • package name : le nom se donne sous la forme <vendor>/<name><vendor> est le nom de votre organisation et <name> est le nom de votre projet
  • description : description de votre projet
  • author : votre nom et adresse email
  • minimum stability : les valeurs possibles sont stable, RC, beta, alpha, dev
  • license : nom de la licence indiquant les droits sur ce logiciel
  • dependencies : indiquer ici les noms et versions des bibliothèques nécessaires au projet en production comme par exemple zendframework 2.3.* (require)
  • dev dependencies : indiquer ici les noms et versions des bibliothèques nécessaires uniquement au développement comme par exemple zendframework/zftool ou bjyoungblood/bjy-profiler, etc. (require-dev)

Pour trouver plus facilement les bibliothèques (dependencies et dev dependencies), répondez yes à la question : Would you like to define your dependencies (require) interactively [yes]?

Ensuite, voici un exemple pour ajouter bjyoungblood/bjy-profiler

Search for a package []: bjyoungblood
Found 9 packages matching bjyoungblood
 [0] bjyoungblood/BjyProfiler
 [1] bjyoungblood/bjy-authorize
 [2] bjyoungblood/bjy-profiler
 [3] saeven/circlical-acl-admin
 [4] bjyoungblood/bjy-cache-storage
 [5] bjyoungblood/bjy-modulus
 [6] shashikant/circlical-acl-admin
 [7] shashikant/circlical-acl-admin-1
 [8] bjyoungblood/rpc-tester
Enter package # to add, or the complete package name if it is not listed []: 2
Enter the version constraint to require []:dev-master

Puis on lance le téléchargement des bibliothèques indiquées par

shell\mon_projet>php composer.phar install

Par la suite, on peut rajouter une bibliothèque en lançant la commande :

shell\mon_projet>php composer.phar require  [paquet1] ... [paquetN]
ou
shell\mon_projet>php composer.phar require  --dev [paquet1] ... [paquetN]

[paquet1] ... [paquetN] sont les noms des bibliothèques à installer séparés par un espace
et --dev indique qu'il faut ajouter la bibliothèque à la liste des dev dependencies

La mise à jour des bibliothèque se fait en lançant la commande :

shell\mon_projet>php composer.phar update

WampServer et ZendFramework

Je développe plusieurs projets sous Zendframework 1 et 2. Par commodité j'ai choisi de mettre en place un virtualhost par projet afin ce coller au mieux à la configuration de production propre à chacun de mes clients.

Jusqu'à maintenant, j'utilisais pour le développement un Zend Server Community Edition 5.6 (licence gratuite) mais je n'ai pas trouvé comment faire évoluer gratuitement les versions de Php. Aussi je viens d'installer WampServer 2.4 comme serveur de développement, sous Windows 7. Il est composé de :

  • Apache 2.4.4
  • MySql 5.6.12
  • Php 5.4.12
  • PhpMyAdmin 4.0.4
  • SqlBuddy 1.3.3
  • XDebug 2.2.3

Si les mises à jour de WampServer semblent plus faciles à gérer, ce service semble légèrement plus lent (pas grave en développement) et sa configuration diffère sensiblement de celle de Zend Server.

Cet article détaille les configurations que j'ai faites.

Configuration de MySql

Avant d'installer WampServer, il faut s'assurer que le service MySql n'est pas démarré, sinon l'installation risque à bloquer au moment de la mise en place de MySql.

Un dump des bases de données est fait avant l'arrêt du service MySql précédent.

Une fois l'installation de WampServer terminée, je constate que le service MySql fonctionne :

 

shell>mysql -uroot
Welcome to the MySQL monitor. Commands end with ; or g.
Your MySQL connection id is 6
Server version: 5.6.12-log MySQL Community Server (GPL)

Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. 
Other names may be trademarks of their respective owners.
Type 'help;' or 'h' for help. Type 'c' to clear the current input statement.

shell>

Reste quelques opérations à faire :

  • créer un mot de passe pour root. J'utilise la console pour plus de facilité :
    shell> mysqladmin -u root password [votre mot de passe]
  • s'assurer que le path de l'ordinateur pointe bien sur le répertoire bin de la bonne version de MySql (chez moi, il pointait toujours sur la version précédente ce qui fait que mysqladmin et mysqldump ne correspondaient pas à la bonne version).
    variables-d-environnement
    (On en profite aussi pour rajouter le chemin de php.exe qui sera utile par la suite)
  • recharger en premier le dump de la base mysql et ensuite ceux des autres bases.

 Configuration d'apache

Comme toujours, la configuration d'apache se trouve dans son répertoire conf, dans le fichier httpd.conf. On aura besoin de charger le module rewrite et de faciliter la création des virtualhosts. Pour cela, j'apporte les modifications suivantes :

  • décommenter la ligne suivante :
    LoadModule rewrite_module modules/mod_rewrite.so
  • ajouter la ligne suivante :
    # Virtual hosts
    #Include conf/extra/httpd-vhosts.conf
    Include "C:/Program Files/wamp/vhosts/vhost_*.conf"

    Ainsi, chaque virtualhost sera configuré dans un fichier indépendant du répertoire vhosts de wamp et il n'y aura plus à retoucher ce fichier httpd.conf. Le nom du fichier doit commencer par vhost_ et l'extension est .conf.

  • créer un virtualhost pour localhost.
    En effet, lorsqu'on crée un virtualhost, l'alias localhost ne fonctionne plus. Pour régler ce problème, je crée le fichier vhosts/vhost_localhost.conf suivant :

    # Virtual Hosts
    #
    # Required modules: mod_log_config
    
    
        ServerAdmin webmaster@localhost
        DocumentRoot "C:/Program Files/wamp/www"
        ServerName localhost
        ServerAlias 127.0.0.1
        ErrorLog "C:/Program Files/wamp/logs/apache_error.log"
        CustomLog "C:/Program Files/wamp/logs/access.log" common
    

    La définition des droits de ce répertoire est contenue dans httpd.conf donc on n'a pas besoin d'y retoucher.

  • exemple d'un virtualhost pour un projet jobeet utilisant Zendframework 2 :
    # Virtual Hosts
    #
    # Required modules: mod_log_config
    
    
    ServerAdmin webmaster@jobeet.dev
    DocumentRoot "D:dafapDeveloppements Eclipseexemple_jobeetpublic"
    ServerName www.jobeet.dev
    ServerAlias jobeet.dev
    ErrorLog "C:/Program Files/wamp/logs/jobeet_error.log"
    CustomLog "C:/Program Files/wamp/logs/jobeet_access.log" common
    SetEnv APPLICATION_ENV "development"
    
    DirectoryIndex index.php
    AllowOverride All
    Require all granted
    
    

importantPassant de la version 2.2 à la version 2.4 d'apache, on notera ici la nécessité de se référer à la documentation d'Apache pour remplacer les directives Order, Allow et Deny par la directive Require.

Il peut être intéressant pour les projets qui n'utilisent pas Zendframework de rajouter dans le bloc <Directory> la ligne :

Options Indexes Multiviews

afin de pouvoir lister le contenu des répertoires (nous sommes sur un serveur de développement). Cela n'a pas d'utilité avec Zendframework puisque tout démarre de public/index.php.

Configuration de PHP

La spécificité de WampServer  est d'utiliser deux fichiers php.ini, l'un  pour la console (pour moi dans le dossier phpphp5.4.12) et l'autre pour le serveur web (pour moi dans apacheApache2.4.4bin). Or l'activation d'une extension par l'outil d'administration de wamp n'intervient que sur le fichier php.ini d'apache ... et encore, de façon imparfaite.

Pour activer une extension, il faut décommenter la ligne de cette extension dans les deux fichiers php.ini.
importantPour l'extension intl, il faut en outre copier les fichiers icu*.dll du dossier phpphp5.4.12 dans le dossier apacheApache2.4.4bin. Sans cela, apache ne charge pas cette extension dans php.

Ne pas oublier de redémarrer les services après toute modification de php.ini.

Installation de PEAR

Bien évidemment, on aura besoin de pear, ne serait-ce que pour effectuer des tests unitaires avec PhpUnit... et pear n'est pas dans le paquet d'installation de WampServer.

Voici la procédure à suivre :

  • télécharger go-pear.phar et l'enregistrer dans le répertoire de la version de php (celui qui contient php.exe - ici, j'ai le dossier php5.4.12 au moment où je rédige cet article).
  • ouvrir une console (démarrer / cmd) et se placer dans ce répertoire et lancer la commande :
    php go-pear.phar

    console-dossier-php Répondre local et valider.

  • Il y a maintenant 12 paramètres à fournir pour l'installation. Valider tous les répertoires proposés par défaut (chez moi de 1 à 11). Compléter éventuellement (pour le 12e paramètre - Path to CLI php.exe - j'indique le chemin C:Program Fileswampbinphpphp5.4.12).
  • Autoriser la modification de php.ini pour prendre en compte le chemin des extensions de pear (ici, C:Program Fileswampbinphpphp5.4.12pear) dans la variable include_path.
  • Il semble qu'il y ait 2 fichiers php.ini, l'un dans le dossier de la version de php (ici php5.4.12) et l'autre dans le dossier d'Apache. Le gestionnaire de WampServeur propose de modifier le fichier php.ini. Il s'agit de celui contenu dans le dossier d'Apache, alors que la procédure d'installation de pear modifie celui du dossier de la version de php. On va donc rapporter la modification réalisée dans le php.ini d'Apache :
    ;***** Added by go-pear
    include_path=".;C:Program Fileswampbinphpphp5.4.12pear"
    ;*****
  • Il reste à surcharger les variables d'environnement de l'ancienne installation de pear avec Zend Server :
    • PHP_PEAR_BIN = C:Program Fileswampbinphpphp5.4.12
    • PHP_PEAR_DAT = C:Program Fileswampbinphpphp5.4.12data
    • PHP_PEAR_DOC = C:Program Fileswampbinphpphp5.4.12docs
    • PHP_PEAR_INSTALL_DIR = C:Program Fileswampbinphpphp5.4.12pear
    • PHP_PEAR_PHP_BIN = C:Program Fileswampbinphpphp5.4.12php.exe
    • PHP_PEAR_SYSCONF_DIR = C:Program Fileswampbinphpphp5.4.12
    • PHP_PEAR_TEST_DIR = C:Program Fileswampbinphpphp5.4.12tests
  • Maintenant on vérifie que pear fonctionne. console-pear-list

 Installation de PhpUnit

  • Ajout des channels nécessaires :
    pear channel-discover pear.phpunit.de
    pear channel-discover components.ez.no
    pear channel-discover pear.symfony.com
  • Installer PhpUnit :
    pear install --alldeps phpunit/PHPUnit
  • Pour le bon fonctionnement de PhpUnit, notamment phpunit --self-update, on doit pouvoir charger l'extension openssl. L'outil d'administration qui permet de charger les extension ne suffit pas parcequ'il n'intervient que sur le fichier php.ini d'Apache alors que phpunit sera lancé en console. Il faut donc modifier manuellement le fichier php.ini du répertoire de la version de php (ici wamp/bin/php/php5.4.12/php.ini).
    Dans ce fichier, décommenter la ligne :

    extension=php_openssl.dll

    puis redémarrer les services de wamp. On vérifiera à partir d'une console (cmd) que l'extension openssl est chargée en lançant la commande :

    php -m

console-phpunit-channels

 Installation de Zendframework 1

Etant donné que ces projets évolueront peu, j'ai choisi de placer la librairie de Zendframework 1 dans un seul répertoire qui sera disponible pour tous les projets. J'y ai rajouté la documentation.

ZF1
  └ZendFramework-1.12.6
    ├bin
    ├demos
    ├documentation
    ├externals
    ├extras
    ├library
    ├puppet
    ├resources
    └tests

 

Cela nécessitera de référencer ce dossier library dans l'include_path de php. Toutefois, afin de pouvoir facilement faire évoluer les versions de Zendframework et de rester indépendant de le configuration, j'ai décidé de placer cette référence dans le .htaccess du projet et de modifier le fichier public/index.php des projets.

Voici le .htaccess :

SetEnv ZEND_PATH "C:Program Files (x86)ZendZF1ZendFramework-1.12.6library"
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]

A noter qu'il sera sans doute nécessaire de supprimer de l'affichage les alertes de compatibilité que PHP 5.4 envoie. Pour cela, il faut rajouter dans .htaccess la ligne :

php_value error_reporting 30711

Voici l'entête de mes fichiers index.php :

Installation de Zendframework 2

Pour ZF2, j'utilise composer.phar qui installe une librairie ZF2 dans chaque projet et met à jour les fichiers autoloader. Je n'ai donc pas trouvé utile d'installer la librairie du framework.

Soit on part du projet Zend Skeleton, soit on installe composer.phar dans le dossier racine du projet par la commande :

shell>curl -s http://getcomposer.org/installer | php

à condition que curl soit installé, bien évidemment.