wiki:ArborescenceDeCopix

Arborescence principale

Lors du désarchivage de Copix, vous avez les répertoires principaux suivants :

  • project/
    • config/
    • modules/
    • project.inc.php
  • temp/
    • cache/
  • utils/
    • copix/
    • htmlMimeMail/
    • smarty/
  • var/
  • www/
    • index.php
    • default/
    • img/
    • js/
    • styles/

project/

C'est le répertoire de travail où sont stockés tous les composants relatifs au projet. C’est donc ici que vous allez placer vos développements.

project/config/

Les fichiers de configuration du projet Copix, en particulier copix.conf.php.

project/modules/

Ce répertoire contient par défaut tous les modules de votre projet. (vous pouvez configurer d'autres emplacements de modules dans copix.conf.php).

Vous pouvez également consulter la documentation sur l'arborescence des modules.

temp/

Contient tout les fichiers temporaires générés par Copix. Il devra être configuré afin que Copix puisse y écrire des informations.

temp/cache/

Tous les fichiers de caches, notamment ceux des templates.

temp/log/

Fichiers des journaux (logs) de Copix : debug, erreurs.

utils/

Répertoire contenant tous les utilitaires nécessaires au projet, notemment Copix. Si vous utilisez une bibliothèque spécifique à votre application, c’est le bon endroit pour la placer.

utils/copix/

Tous les fichiers propres à copix, classes du noyau etc...

  • classes/ : des classes utiles pour le fonctionnement interne de Copix, notamment les DAO du système de profil ;
  • auth/ : les classes de base pour les objets d’authentification (CopixUser, CopixDBUser, CopixLdapUser?, CopixAdUser?, ...) ;
  • core/ : classes du noyau de copix ;
  • dao/ : les classes qui prennent en charge le système de DAO de Copix ;
  • db/ : ensemble de classes CopixDb? pour accéder aux bases de données ;
  • events/ : classes du système événementiel ;
  • ldap/ : classes CopixLdap? pour accèder aux annuaires ;
  • profiles/ : classes du système de profils CopixProfile?;
  • resources/ : fichiers de langue propre au noyau de Copix (messages d’erreurs etc..) voir CopixI18N;
  • smarty_plugins/ : plugins smarty additionnels ;
  • templates/ : les templates utilisés en interne par Copix ;
  • utils/ : classes utilitaires.

utils/htmlMimeMail/

Le composant d’envoi de mails utilisé par CopixEMailer.

utils/smarty/

Fichiers du moteur de template Smarty utilisé par CopixTpl?.

var/

Contient les fichiers et documents que Copix peut être amené à manipuler : documents ou images uploadées, fichiers de configuration, ... Il devra être configuré afin que Copix puisse y écrire des informations.

www/

C'est la racine du site (documentRoot), il contient le point d'entrée du site : index.php. C'est le seul répertoire qui doit être directement accessible par le navigateur web (publié sous apache)

www/themes/

Répertoire par défaut dans lequel seront placées toutes les ressources (images, feuilles de styles, ...) organisées par thèmes.

www/js/

Répertoire par défaut dans lequel seront placées les fichiers Javascript.