Il est possible de profiter d'un système d'auto-chargement des classes reposant sur la fonction autoload de PHP (le fichier de la classe étant chargé automatiquement au moment de l'instanciation). Cela évite d'utiliser jClasses (voir ci-après). Le système d'autoload de Jelix supporte la spécification PSR0 et la spécification PSR-4.

Si vous utilisez Composer, il est possible de déclarer les espaces de noms dans le fichier composer.json de votre application, mais cela rend votre module moins portable. Toutefois, si le module en question est dans son propre dépôt et destiné à être installé par Composer, le composer.json du module est alors le bon endroit.

Une alternative est de faire les déclarations de classes et namespaces dans le fichier module.xml, dans une balise <autoload>.

Voici un exemple :

<module xmlns="http://jelix.org/ns/module/1.0">
   <info id="jelix_tests@testapp.jelix.org" name="jelix_tests"> ... </info>
   <dependencies> ... </dependencies>
   <autoload>
        <class name="myautoloadedclass" file="autoloadtest/autoloadtestclass.php" />
        <classPattern pattern="/^myalclass/" dir="autoloadtest/withpattern/" suffix=".cl.php" />
        <psr0 name="jelixTests\foo" dir="autoloadtest" />
        <psr4 name="jelixTests\bar" dir="autoloadtest/barns"/>
        <includePath dir="autoloadtest/incpath" suffix=".php" />
        <autoloader file="autoloadtest/myautoloader.php" />
   </autoload>
</module>

Comme vous le voyez, il y a plusieurs façon de déclarer une classe. Les chemins des fichiers ou répertoires à indiquer dans les balises doivent être relatif au répertoire du module.

Pour charger une classe spécifique, en indiquant son nom et son fichier :

   <class name="myautoloadedclass" file="autoloadtest/autoloadtestclass.php" />

Pour déclarer plusieurs classes à la fois qui ont des noms ressemblant, on peut utiliser une expression régulière, et indiquer le répertoire où les fichiers se trouvent ainsi qu'un suffixe de fichier :

   <!-- chargement automatique des classes dont le nom commençent par myalclasse -->
  <classPattern pattern="/^myalclass/" dir="autoloadtest/withpattern/" suffix=".cl.php" />

Pour déclarer un ensemble de classes qui sont dans un namespace particulier, on indique le namespace et le répertoire dans une balise <psr0> (Vous pouvez aussi utiliser l'ancienne balise <namespace>, elles sont équivalentes).

  <psr0 name="jelixTests\foo" dir="autoloadtest" />
  <!-- ou -->
  <namespace name="jelixTests\foo" dir="autoloadtest" />

Cette déclaration suit la spécification PSR0. Aussi le namespace de la classe doit correspondre à un chemin dans le répertoire indiqué. Par exemple, si Jelix doit charger la classe jelixTests\foo\bar\baz, il chargera le fichier autoloadtest/jelixTests/foo/bar/baz.php.

Jelix possède un autre moyen de prendre en charge les namespaces, qui suit la spécification PSR-4. Il faut utiliser la balise <psr4>. On peut aussi utiliser la balise obsolète <namespacePathMap>.

   <psr4 name="jelixTests\bar" dir="autoloadtest/barns" suffix=".class.php" />
   <!-- ou -->
   <namespacePathMap name="jelixTests\bar" dir="autoloadtest/barns" suffix=".class.php" />

Le chemin du fichier de la classe n'est pas un chemin reprenant le nom du namespace. Mais ici toute classes correspondant au namespace se trouvent dans des fichiers directement dans le répertoire indiqué. Ainsi, la classe jelixTests\foo\bar\baz n'est pas situé dans autoloadtest/jelixTests/foo/bar/baz.class.php mais dans autoloadtest/bar/baz.class.php.

Il est possible d'indiquer aussi un répertoire d'include classique : Jelix cherchera un fichier du même nom que la classe dans ce répertoire.

   <includePath dir="autoloadtest/incpath" suffix=".php" />

Enfin, on peut indiquer un fichier qui déclarera un autre autoloader. Cela peut être utile quand on utilise une bibliothèque externe qui possède son autoloader. Cet autoloader doit utiliser la fonction spl_autoload_register et ses amis.

   <autoloader file="autoloadtest/myautoloader.php" />

jClasses est un composant qui est responsable de trouver, charger et instancier des classes fournies par votre module. Elle vous évite d'avoir à faire un include et une instanciation par vous même.

Historiquement, ce composant a été créé dans Jelix avant l'existence des espaces de noms dans PHP. Comme jClasses demande un "sélecteur", vous n'avez pas à indiquer de chemin vers la classe. Cela est particulièrement pratique quand vous voulez appeler une classe d'un autre module, puisqu'en théorie, vous n'avez pas à savoir où se trouve ce module.

Cependant, depuis l'existance des espaces de noms et de l'auto-loading, l'utilisation de jClasses est moins pertinente. Pour le moment son intérêt est la gestion de singleton d'instances, ou de services.

Classes de services ¶

Création d'une classe utilisable par jClasses ¶

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

Instanciation d'une classe avec jClasses ¶

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

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

Inclure une classe avec jClasses ¶

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

Inclure une interface avec jClasses ¶

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

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

class StockUtil implements IStockUtil {
    […]
}

Il se peut que vous vouliez réutiliser des classes développées en dehors du projet. Il est bien entendu tout à fait possible de le faire dans Jelix.

Avec Composer ¶

Ancienne pratique ¶

   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');

   require(jApp::appPath('lib/foo/bar.php'));
   $maclasse = new bar();