Les classes métiers et services dans Jelix sont des classes PHP classiques qui n'ont rien de spécifique. La seule chose à respecter est de les stocker dans un fichier nom_de_la_classe.class.php dans le répertoire classes/ du module, pour pouvoir être chargée par jClasses:

  
   class StockService {
      public function getListeProduits(){
          $stock = jDAO::get("products");
          
          $liste = $stock->findAll();
          
          // ici traitement sur la liste... par exemple
          
          return $liste;      
      }
   }

Cette classe devra être stockée dans classes/StockService.class.php.

La différence entre une classe service et les autres classes est qu'une classe service fournit, comme son nom l'indique, un service. Elle n'a pas besoin d'être instanciée à chaque utilisation car elle ne possède pas de propriétés "discriminantes". Une seule instance suffit pour toute l'application.

Par exemple une classe de type "factory", qui permet de récupérer des ensembles de données, est une classe service. Par contre une classe représentant un produit, qui possède donc des champs identifiants, est une classe non service.

Jelix propose la classe jClasses, qui vous évite d'avoir à faire un include et une instanciation par vous même.

jClasses fournit deux méthodes statiques, auxquelles vous indiquez un sélecteur :

• createInstance($selecteurDeClasse) (ou create($selecteurDeClasse) )
• getService($selecteurDeClasse)

La première créera à chaque appel une nouvelle instance. Par contre la deuxième renverra toujours une même instance de la classe. getService sera donc utilisé sur les classes services, et createInstance sur les autres.

Si notre classe StockService se trouve dans le module "shop", voici un exemple d'appel dans un contrôleur :

    $stocksrv = jClasses::getService("shop~stockservice");
    $rep->body->assign('liste_produits', $stocksrv->getListeProduits());

Notez que vous pouvez mettre des classes dans des sous-répertoires de classes/, ce qui donne, si on place StockService dans un répertoire classes/stocks/ :

   $stocksrv = jClasses::getService("shop~stocks/stockservice");

Dans certains cas, comme celui où le constructeur de la classe métier demande un paramètre, il faut inclure la classe métier puis l'instancier "manuellement".

Dans ce cas la classe jClasses propose la méthode statique inc($selecteurDeClasse). Comme son nom l'indique elle inclut (en fait effectue un require_once) la classe spécifiée par le sélecteur.

Exemple :

    jClasses::inc('shop~shoesProduct');
    $shoe = new shoesProduct('43', 'black');

Vous pouvez aussi profiter du système autoload de PHP. Voir plus bas.

jClasses fournit la méthode statique incIFace pour inclure des interfaces PHP définies dans le dossier classes d'un module.

Une interface doit être définie avec la syntaxe PHP (mot clé interface) dans un fichier à son nom suivi du suffixe .iface.php. Par exemple, on peut déclarer l'interface IStockUtil dans un fichier IStockUtil.iface.php dans un sous dossier interfaces/ du dossier classes/ :

<?php
interface IStockUtil {
    […]
}
?>

On utilisera ensuite la méthode jClasses::incIface() dans les fichiers qui en ont besoin :

jClasses::incIface('commons~interfaces/IStockUtil');

class StockUtil implements IStockUtil {
    […]
}

Parfois, vous voulez stockez en session des objets basés sur vos classes métiers. Mais pour cela, il faut inclure ces classes avant que jelix fasse un session_start(), pour que PHP puisse désérialiser correctement l'objet en session.

Avant le système d'auto-chargement dans les modules (voir la section suivante) Jelix fournissait un moyen d'indiquer les classes à charger avant ce start_session() : il suffisait d'indiquer la liste des sélecteurs de ces classes dans l'option loadClasses de la section sessions dans la configuration :

[sessions]

loadClasses = "mymodule~bar,mymodule~subdir/foo, shop~shoesProduct"

Le nom du module est obligatoire.

• *Note: ce paramètre loadClasses est désormais obsolète et vous devez plutôt**
• *déclarer les classes dans le fichier module.xml pour qu'elles soient autochargées.** Voir la suite.

N'utilisez le système autoload que pour les classes souvent utilisées. Déclarer une multitude de classes qui ne partagent pas le même namespace n'a pas trop de sens, et ralentira le système autoload de PHP (si tout les modules déclarent des dizaines de classes, cela fait au final beaucoup de chemin à vérifier...). Préférez donc l'utilisation de namespaces commun, ou encore de jClasses (surtout pour les classes peu utilisées ou utilisées uniquement par le module).

Composer est un gestionnaire de paquets et de dépendance pour PHP, de plus en plus utilisé. Il vous permet d'installer et de mettre à jour facilement des bibliothèques tierces. Nous vous recommandons de l'utiliser si les bibliothèques tierces que vous voulez utiliser peuvent être installées avec Composer. (Les prochaines versions de Jelix > 1.6 seront disponibles par Composer ;-) ).

Pour une intégration de paquets Composer, c'est très simple :

• Créez votre fichier composer.json dans le répertoire de votre application (voir la documentation de Composer)
• installez les paquets indiqués dans composer.json : php composer.phar install. Cela génère un répertoire vendor/ dans votre application
• Incluez le fichier vendor/autoload.php dans application.init.php

require (__DIR__.'/vendor/autoload.php');
require (__DIR__.'/../lib/jelix/init.php');
jApp::initPaths( /* ... */ );
jApp::setTempBasePath( /* ... */ );

Si vous ne voulez pas utiliser Composer, voici une autre manière d'intégrer des bibliothèques tierces dans votre application.

Bien que vous puissiez mettre ces classes où bon vous semble et faire un include classique, il y a toutefois trois emplacements préconisés :

• le répertoire lib/ de Jelix
• le répertoire classes/ d'un module
• le répertoire lib/ d'un module

installation globale ¶

   require(LIB_PATH.'foo/bar.php');
   $maclasse = new bar();

installation dans un module ¶

   require(jApp::getModulePath('main') . 'classes/bar.php');
   $maclasse = new bar();

   $maclasse = jClasses::create('bar');

   // ou si le constructeur attend des arguments
   jClasses::inc('bar');
   $maclasse = new bar('bla');