Raccourcis : Contenu - rubriques - sous rubriques
FR

Piste: 1.1.x

Wiki: Index - Derniers changements - Back link

Mini Tutoriel pour Jelix 1.1

Ce tutoriel a pour but de vous montrer succinctement comment on réalise une application avec la série 1.1 de Jelix. Il n'est en aucun cas exhaustif quant aux possibilités de Jelix, celui-ci ayant énormément de possibilités dans la création et la configuration d'une application.

Téléchargement et installation

Pour commencer, téléchargez l'édition "Developer" de Jelix 1.1. Jelix 1.1 nécessite au moins PHP 5.2.

Décompressez ensuite l'archive obtenue avec des logiciels comme winzip, unzip ou tar. Par exemple, avec tar :

tar xvzf jelix-1.1-dev.tar.gz

Vous obtenez un répertoire jelix-1.1/lib/ dans lequel vous avez plusieurs répertoires contenant toutes les bibliothèques utilisées par jelix, ainsi que les fichiers propres à jelix dans jelix-1.1/lib/jelix/.

Pour ce tutoriel, déplacez le répertoire jelix-1.1 dans le répertoire de votre site web, de manière à ce qu'il soit accessible par une URL du genre http://localhost/jelix-1.1/. (vous pouvez renommer jelix-1.1 comme vous le souhaitez).

Scripts de Jelix

L'édition Developer de Jelix est fournie avec un script jelix.php, qui permet de créer et modifier facilement les fichiers d'une application. Ce script est situé dans jelix-1.1/lib/jelix-scripts/.

Il faut invoquer jelix.php avec la version ligne de commande de PHP, depuis une console sous Linux ou l'invite de commandes sous Windows.

La syntaxe de cette commande est la suivante :

php jelix.php --nom_application nom_commande [options] [paramètres]

Sous windows, il faut indiquer php.exe au lieu de php bien sûr. Assurez vous d'avoir installé et configuré correctement php-cli.

Création d'une application

Créons l'arborescence de notre application au moyen de la commande createapp. Nous choisissons d'appeler cette application “exemple”.

php jelix.php --exemple createapp

Vous obtenez alors un répertoire exemple/ situé au même niveau que le répertoire lib/. Son contenu est le suivant :

exemple/
   modules/      les modules propres à votre application
   plugins/      les plugins propres à votre application
   responses/    réponses personnalisées pour l'application (views)
   var/
       config/   les fichiers de configuration de votre application
       log/      les éventuels fichiers journaux
       themes/   les différents thèmes possibles dans votre application
       overloads/  contiendra les différents fichiers que vous aurez redéfinis, issus de modules tiers.
   www/          la racine du site

Création d'un module

Un module “exemple” est automatiquement créé dans le répertoire modules/ lorsque l'on utilise createapp. Un module représente une partie de votre application. Il en faut au moins un dans une application.

Voici le répertoire créé automatiquement :

 exemple/modules/
           exemple/                       le répertoire du module
               module.xml               fichier décrivant l'identité du module
               controllers/             les classes de traitement des actions
                   default.classic.php  un contrôleur par défaut
               classes/                 vos classes métiers et services
               daos/                    les fichiers de mappings relationnel-objet
               forms/                   les formulaires
               locales/                 fichiers de langues (fichiers "properties")
                   en_EN/
                   fr_FR/
               templates/               templates du module
               zones/                   objets traitant des zones spécifiques dans une page

Si vous voulez créer d'autres modules, vous pouvez utiliser la commande createmodule :

php jelix.php --exemple createmodule cms

Créer un module de nom “cms”.

Premier affichage

Première chose avant d'afficher la page de démarrage de l'application : mettre les droits en écriture pour l'utilisateur du serveur web, en particulier sous Linux ou Mac OS, sur les répertoires temp/exemple et exemple/var/log créé par la commande createapp.

Par exemple, sous Ubuntu ou Debian :

   chown -R www-data:www-data ../../temp/exemple ../../exemple/var/log
   chmod 755 -R ../../temp/exemple ../../exemple/var/log

Nous sommes maintenant prêts à afficher notre page. Votre application est accessible normalement via l'URL http://localhost/jelix-1.1/exemple/www/. Tapez donc cette URL dans votre navigateur. Vous devriez donc voir s'afficher cette page :

Vous avez remarqué ce message disant que la feuille de style CSS n'est pas accessible. Copiez le répertoire jelix-1.1/lib/jelix-www dans jelix-1.1/exemple/www en le renommant “jelix” (sur un serveur dédié apache, il est plutôt recommandé de créer un alias). Ce répertoire est important car il contient des fichiers javascripts indispensables. Vous devriez alors voir la page affichée avec la feuille de style :

Si il y a des messages d'erreurs dans la section “Vérification de l'installation”, corrigez les.

Implémentation d'une action

Implémentons l'action par défaut. Une action est un traitement affecté à une URL précise de votre application. Ouvrez le fichier exemple/modules/exemple/controllers/default.classic.php, il contient :

class defaultCtrl extends jController {
 
   function index () {
      $rep = $this->getResponse('html');
 
       // this is a call for the 'welcome' zone after creating a new application
       // remove this line !
       $rep->body->assignZone('MAIN', 'jelix~check_install');
 
      return $rep;
   }
}

Nous récupérons ici, avec la méthode getResponse, un objet jResponseHtml identifié par le type “html”, et nous le retournons pour que son contenu soit renvoyé au navigateur.

L'objet jResponseHtml a dans sa propriété body un objet jtpl, le moteur de template fourni dans Jelix. Dans le contrôleur, nous utilisons sa méthode assignZone qui veut dire : “récupère le contenu de la zone check_install qui est stockée dans le module jelix, et mets ce contenu dans la variable de template 'MAIN'”. Vous verrez plus tard ce qu'est exactement une zone.

Supprimons cette ligne qui ne nous est plus utile, de manière à obtenir :

class defaultCtrl extends jController {
 
   function index () {
      $rep = $this->getResponse('html');
 
      return $rep;
   }
}

Objet réponse

L'objet jResponseHtml s'occupe de générer une réponse en HTML (donc une page en HTML). C'est ce qui correspond à la “vue” dans [le modèle MVC|http://fr.wikipedia.org/wiki/Mod%C3%A8le-Vue-Contr%C3%B4leur] en programmation web. Il génère automatiquement la partie <head> du HTML, à partir de certaines de ses propriétés.

Voyons par exemple comment modifier le titre de la page (balise HTML <title> dans <head>) :

   function index() {
        $rep = $this->getResponse('html');
 
        $rep->title = 'Hello World !';
 
        return $rep;
    }

Affichez à nouveau la page. Le titre de la page affiché par votre navigateur (dans sa barre de titre) est bien “hello world”, mais la page elle même contient ceci :

Comment est-ce possible, alors que nous n'avons rien indiqué dans l'action ?

Nous avons vu que getResponse('html') est censé renvoyer un objet jResponseHtml. On peut utiliser cet objet directement, mais en général il est plus pratique de redéfinir une nouvelle réponse HTML qui sera utilisée pour toutes les actions, et définissant des choses communes à toutes les pages. C'est pourquoi la commande createapp créé un objet héritant de jResponseHtml, placé dans le fichier exemple/responses/myHtmlResponse.class.php. Cette réponse sera utilisée pour toutes les actions de votre application (comportement modifiable bien entendu) qui appelleront getResponse('html'). En particulier, dans cet objet, on définit généralement les feuilles de styles CSS générales du site, le fichier de template principal (définissant par exemple l'en-tête, le menu principal et le pied de page de votre site), l'inclusion de zones communes etc. Bref toutes les choses que l'on n'aura pas à répéter dans les actions.

Voici le contenu de myHtmlResponse.class.php tel qu'il est généré par createapp :

class myHtmlResponse extends jResponseHtml {
 
    public $bodyTpl = 'exemple~main';
 
    function __construct() {
        parent::__construct();
 
        // Include your common CSS and JS files here
    }
 
    protected function doAfterActions() {
        // Include all process in common for all actions, like the settings of the
        // main template, the settings of the response etc..
        $this->body->assignIfNone('MAIN','<p>no content</p>');
    }
}

Nous voyons que cette réponse personnalisée indique (dans bodyTpl) d'utiliser le fichier de template main.tpl situé dans le module “exemple”, pour générer le contenu de la balise <body> de la page. Notez la notation spécifique utilisée. Cette chaîne est en fait un sélecteur Jelix. Un sélecteur est un raccourci pour désigner une ressource d'un module. Voici ce template main.tpl généré automatiquement par la commande createapp :

   <h1 class="apptitle">example<br/><span class="welcome">{@jelix~jelix.newapp.h1@}</span></h1>
   {$MAIN}

{$MAIN} désigne l'affichage de la variable de template “MAIN”. {@jelix~jelix.newapp.h1@} désigne l'affichage d'une chaîne localisée (sa valeur dépend de la langue) qui a pour clé “jelix.newapp.h1” et stockée dans le module jelix.

La propriété body contient un objet jTpl qui permet de transmettre au template les données à utiliser. L'instruction dans la méthode doAfterActions indique que si il n'y a pas de variable de template MAIN définie, on y place alors ”<p>no content</p>”.

Voilà pourquoi toutes ces choses s'affichent dans votre page de démarrage.

Changeons le contenu du template principal main.tpl dans le module exemple :

<h1 class="apptitle">Mon site web</h1>
 
<div id="page">
{$MAIN}
</div>

Et dans le constructeur de l'objet réponse, nous allons rajouter une instruction qui indique une feuille de style CSS, en l'occurrence celle fournie par jelix par défaut :

class myHtmlResponse extends jResponseHtml {
 
    public $bodyTpl = 'exemple~main';
 
    public function __construct() {
        parent::__construct();
        global $gJConfig;
        $this->addCSSLink($gJConfig->urlengine['jelixWWWPath'].'design/jelix.css');
 
    }
 
    protected function doAfterActions() {
        $this->body->assignIfNone('MAIN','<p>no content</p>');
    }
}

Nous obtenons maintenant :

Premier contenu

Définissons maintenant le contenu de notre page de démarrage :

class defaultCtrl extends jController {
 
   function index () {
      $rep = $this->getResponse('html');
      $rep->title = 'Hello World !';
 
      $rep->body->assign('MAIN',"<p>Bonjour !</p>");
 
      return $rep;
   }
}

Nous mettons dans $MAIN ce bout de HTML ”<p>Bonjour !</p>”. En réaffichant la page, on obtient :

Template d'action

Il serait plus pratique de mettre le contenu de $MAIN dans un deuxième template, exemple/modules/exemple/templates/bonjour.tpl par exemple. On a ainsi deux templates : main.tpl qui définit la structure des pages de tout le site, et bonjour.tpl qui correspond à une page spécifique, et dont le contenu sera inclus dans main.tpl.

Créez le fichier bonjour.tpl dans le répertoire templates du module. Et mettez-y ce contenu, plus structuré :

<div class="monbloc">
<h2>Message</h2>
 
<div class="blockcontent">Bonjour {$nom} !</div>
</div>

”{$nom}” est une variable de template : elle sera remplacée par la valeur que vous donnerez. Apportons maintenant les modifications nécessaires dans le contrôleur :

   function index () {
      $rep = $this->getResponse('html');
      $rep->title = 'Hello World !';
 
      $tpl = new jTpl();
      $tpl->assign('nom','Moi');
      $rep->body->assign('MAIN', $tpl->fetch('bonjour'));
 
      return $rep;
   }

Vous obtenez alors la page suivante :

Récupération de paramètres

Maintenant, il serait intéressant de pouvoir indiquer en paramètre de l'URL le nom que l'on affiche dans le template. Par exemple pouvoir indiquer “Robert” :

 http://localhost/jelix-1.1/exemple/www/index.php?nom=Robert

Remplaçons alors dans le contrôleur cette ligne :

 $tpl->assign('nom','Moi');

par ceci :

   $nom = $this->param('nom');
   $tpl->assign('nom',$nom);

Et rechargez la page. vous devriez voir afficher :

URLs

En temps normal, vous devez indiquer dans l'url le nom du module et de l'action. Pour le contrôleur de notre exemple, on peut taper ceci :

  http://localhost/jelix-1.1/exemple/www/index.php/exemple/default/index/

Mais cette action a été définie comme étant celle qui affiche la page d'accueil. Cela est spécifié dans le fichier exemple/var/config/index/config.ini.php, dans les paramètres startModule et startAction :

startModule="exemple"
startAction="default:index"

Vous pouvez changez ces paramètres à votre convenance.

En ce qui concerne les urls, il est tout à fait possible de les personnaliser, en utilisant un autre moteur d'url. Vous pouvez aussi configurer le serveur de manière à spécifier le “DocumentRoot” du site sur le répertoire jelix-1.1/exemple/www (et donc éviter d'avoir à taper le chemin jelix-1.1/exemple/www), ou si vous ne pouvez faire une telle manipulation, déplacer le contenu de exemple/www à la racine de votre site.

Conclusion

Ce mini tutoriel vous a fait découvrir les premiers concepts de base de Jelix. Vous pouvez continuer à découvrir les possibilités du framework en lisant le tutoriel jelixnews.


fr/tutoriels/minitutoriel/1.1.x.txt · Dernière modification: 2012/04/14 22:08 par laurent
Fils rss des changements récents dans le wiki Creative Commons License