Développer une nouvelle application pour eGroupWare

L'arborescence d'une application

Une application eGroupWare doit suivre une arborescence particulière :

• NomApplication (rep)
  • index.php (fic)
  • setup (rep)
    • setup.inc.php (fic)
    • tables_current.inc.php (fic)
    • phpgw_??.lang (fic)
  • inc (rep)
    • class.????.inc.php (fic)
    • hook.????.inc.php (fic)
  • templates (rep)
    • default (rep)
      • ????.tpl (fic)
      • app.css (fic)
      • images (rep)
        • navbar.png (fic)

Le répertoire setup contient :

• setup.inc.php : fichier permettant de définir les paramètres utilisés lors de l'installation de l'application.
• tables_current.inc.php : fichier contenant la définition des tables devant être ajoutées à la base de données.
• phpgw_??.lang : fichier contenant les traductions. ?? = en pour anglais, fr pour français.

Le répertoire inc contient :

• class.???.inc.php : fichier contenant le code de l'application. Les noms doivent être définis comme suit :
  • class.uiNomApplication.inc.php : contient le code gérant l'interface avec l'utilisateur.
  • class.boNomApplication.inc.php : contient le code qui traite les données provenant de la base de données.
  • class.soNomApplication.inc.php : contient le code communiquant avec la base de données.
• hook.???.inc.php : fichier contenant le code des divers menus (préférences, administration, configuration, ...)

Le répertoire templates contient divers répertoires correspondant aux styles d'affichage utilisés. Le répertoire par défaut se nomme default et est composé de :

• ???.tpl : fichier contenant un template d'affichage.
• app.css : fichier contenant la css utilisée
• un répertoire images contient les images utilisées dans l'application. L'icône devant être affichée dans la barre des applications doit se nommer navbar.png.

Le fichier de configuration

La création d'une application commence par la définition du fichier de configuration. Ce fichier doit s'appeler setup.inc.php et doit se trouver dans le répertoire setup de l'application. Il s'agit alors de compléter les champs du tableau setup définissant les paramètres de l'application.

• setup['NomApplication']['name'] : nom de l'application.
• setup['NomApplication']['title'] : titre de l'application.
• setup['NomApplication']['version'] : version de l'application.
• setup['NomApplication']['app_order'] : position de l'application dans la barre de menu.
• setup['NomApplication']['enable'] : '1' permet de spécifier que l'application doit être active, '0' permet de spécifier que l'application ne doit pas être active.
• setup['NomApplication']['author'] : nom de l'auteur de l'application.
• setup['NomApplication']['licence'] : la licence sous laquelle est l'application (par exemple GPL).
• setup['NomApplication']['description'] : description de l'application.
• setup['NomApplication']['maintener'] : nom du développeur qui maintient l'application.
• setup['NomApplication']['maintener_email'] : adresse mail du développeur qui maintient l'application.

• setup['NomApplication']['tables'] : tabeau contenant les noms des tables devant être créées dans la base de données (par exemple : array(egw_table1,egw_tables2)).

• setup['NomApplication']['hooks'][] : nom de la classe définissant les menu (par exemple pour hook.nomMenu.inc.php mettre nomMenu).
• setup['NomApplication']['hooks']['settings'] : chemin vers la définition des préférences NomApplication.NomClassePreference.fonctionPreference (Voir le chapitre concerné pour plus de détails)

Définir les tables devant être intégrées à la base de données

La création des tables de la base de données se fait automatiquement lors de l'installation de l'application dans eGroupWare. Pour cela, il faut définir les tables dans le fichier tables_current.inc.php qui doit se trouver dans le répertoire setup. Ce fichier contient un tableau phpgw_baseline qui contient la définition des différentes tables. Par principe, les tables doivent être définies de la manière suivante : egw_NomTable. Les paramètres sont disposés dans un tableau contenant les champs suivant :

• fd : (field definition) tableau contenant la définition des champs de la table.

'fd' => array(
           'NomChamp1' => array(
                            'propriété1' => valeur1,
                            'propriété2' => valeur2,
                                  ......
                          );             
           'NomChamp2' => array(
                              ......
                          );
);

Voici une liste non exhaustive des propriétés des champs :

• 'type' :
  • auto : indice auto-incrémental
  • varchar : chaine de caractères, indiquer la longueur avec la propriété 'precision'
  • text : texte
  • int : entier, indiquer la longueur avec la propriété 'précision'
  • char : caractère
• 'nullable' : (True,False) indique si le champ peut être null
• 'default' : permet de préciser une valeur par défaut

• pk : (primary key) tableau contenant la définition de la clé primaire.

'pk' => array(
          'NomChamp1',
          'NomChamp2',
             .....
        );
);

• fk : (foreign key) tableau contenant la définition des clés étrangères.

'fk' => array(
           'NomChamp1',
           'NomChamp2',
              .....
        );
);        

• ix
• uc

Exemple de fichier tables_current.inc.php

<?
  phpgw_baseline = array(
         'egw_personne' => array(
                       'fd' => array(
                                  'personne_id' => array('type' => 'auto', 'nullable' => False),
                                  'personne_nom' => array('type' => 'varchar', 'precision' => '64'),
                                  'personne_prenom' => array('type' => 'varchar', 'precision' => '64'), 
                        ),
                       'pk' => array(personne_id),
                       'fk' => array(),
                       'ix' => array(),
                       'uc' => array(),
          ),
  );         
?>