From 41b1f422b24e68f44f5d1ee22e4d069189974664 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Wed, 22 Jul 2009 20:42:31 +0000 Subject: [PATCH] Doc --- htdocs/includes/modules/modAgenda.class.php | 212 ++++++++++---------- 1 file changed, 105 insertions(+), 107 deletions(-) diff --git a/htdocs/includes/modules/modAgenda.class.php b/htdocs/includes/modules/modAgenda.class.php index 492b9abff64..79a98f43064 100644 --- a/htdocs/includes/modules/modAgenda.class.php +++ b/htdocs/includes/modules/modAgenda.class.php @@ -22,119 +22,117 @@ */ /** - \defgroup agenda Module agenda - \brief Module pour gerer l'agenda et actions - \brief $Id$ -*/ + * \defgroup agenda Module agenda + * \brief Module pour gerer l'agenda et actions + * \brief $Id$ + */ /** - \file htdocs/includes/modules/modAgenda.class.php - \ingroup agenda - \brief Fichier de description et activation du module agenda -*/ - + * \file htdocs/includes/modules/modAgenda.class.php + * \ingroup agenda + * \brief Fichier de description et activation du module agenda + */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); /** - \class modAdherent - \brief Classe de description et activation du module Adherent -*/ - + * \class modAdherent + * \brief Classe de description et activation du module Adherent + */ class modAgenda extends DolibarrModules { - /** - * \brief Constructeur. Definit les noms, constantes et boites - * \param DB handler d'acces base - */ - function modAgenda($DB) - { - $this->db = $DB; - $this->numero = 2400; + /** + * \brief Constructeur. Definit les noms, constantes et boites + * \param DB handler d'acces base + */ + function modAgenda($DB) + { + $this->db = $DB; + $this->numero = 2400; - $this->family = "projects"; + $this->family = "projects"; // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module) $this->name = eregi_replace('^mod','',get_class($this)); - $this->description = "Gestion de l'agenda et des actions"; - $this->version = 'dolibarr'; // 'experimental' or 'dolibarr' or version + $this->description = "Gestion de l'agenda et des actions"; + $this->version = 'dolibarr'; // 'experimental' or 'dolibarr' or version // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase) $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name); - $this->special = 0; - $this->picto='calendar'; + $this->special = 0; + $this->picto='calendar'; - // Data directories to create when module is enabled - $this->dirs = array("/agenda/temp"); + // Data directories to create when module is enabled + $this->dirs = array("/agenda/temp"); - // Config pages - //------------- - $this->config_page_url = array("agenda.php"); + // Config pages + //------------- + $this->config_page_url = array("agenda.php"); - // Dependancies - //------------- - $this->depends = array(); - $this->requiredby = array(); - $this->langfiles = array("companies"); + // Dependancies + //------------- + $this->depends = array(); + $this->requiredby = array(); + $this->langfiles = array("companies"); - // Constantes - //----------- - $this->const = array(); + // Constantes + //----------- + $this->const = array(); // New pages on tabs // ----------------- - $this->tabs = array(); + $this->tabs = array(); // Boxes - //------ - $this->boxes = array(); - $this->boxes[0][1] = "box_actions.php"; + //------ + $this->boxes = array(); + $this->boxes[0][1] = "box_actions.php"; - // Permissions - //------------ - $this->rights = array(); - $this->rights_class = 'agenda'; - $r=0; + // Permissions + //------------ + $this->rights = array(); + $this->rights_class = 'agenda'; + $r=0; - // $this->rights[$r][0] Id permission (unique tous modules confondus) - // $this->rights[$r][1] Libelle par defaut si traduction de cle "PermissionXXX" non trouvee (XXX = Id permission) - // $this->rights[$r][2] Non utilise - // $this->rights[$r][3] 1=Permis par defaut, 0=Non permis par defaut - // $this->rights[$r][4] Niveau 1 pour nommer permission dans code - // $this->rights[$r][5] Niveau 2 pour nommer permission dans code + // $this->rights[$r][0] Id permission (unique tous modules confondus) + // $this->rights[$r][1] Libelle par defaut si traduction de cle "PermissionXXX" non trouvee (XXX = Id permission) + // $this->rights[$r][2] Non utilise + // $this->rights[$r][3] 1=Permis par defaut, 0=Non permis par defaut + // $this->rights[$r][4] Niveau 1 pour nommer permission dans code + // $this->rights[$r][5] Niveau 2 pour nommer permission dans code // $r++; - $this->rights[$r][0] = 2401; - $this->rights[$r][1] = 'Read actions/tasks linked to his account'; - $this->rights[$r][2] = 'r'; - $this->rights[$r][3] = 1; - $this->rights[$r][4] = 'myactions'; - $this->rights[$r][5] = 'read'; - $r++; + $this->rights[$r][0] = 2401; + $this->rights[$r][1] = 'Read actions/tasks linked to his account'; + $this->rights[$r][2] = 'r'; + $this->rights[$r][3] = 1; + $this->rights[$r][4] = 'myactions'; + $this->rights[$r][5] = 'read'; + $r++; - $this->rights[$r][0] = 2402; - $this->rights[$r][1] = 'Create/modify/delete actions/tasks linked to his account'; - $this->rights[$r][2] = 'w'; - $this->rights[$r][3] = 0; - $this->rights[$r][4] = 'myactions'; - $this->rights[$r][5] = 'create'; - $r++; + $this->rights[$r][0] = 2402; + $this->rights[$r][1] = 'Create/modify/delete actions/tasks linked to his account'; + $this->rights[$r][2] = 'w'; + $this->rights[$r][3] = 0; + $this->rights[$r][4] = 'myactions'; + $this->rights[$r][5] = 'create'; + $r++; - $this->rights[$r][0] = 2403; - $this->rights[$r][1] = 'Read actions/tasks of others'; - $this->rights[$r][2] = 'r'; - $this->rights[$r][3] = 0; - $this->rights[$r][4] = 'allactions'; - $this->rights[$r][5] = 'read'; - $r++; + $this->rights[$r][0] = 2403; + $this->rights[$r][1] = 'Read actions/tasks of others'; + $this->rights[$r][2] = 'r'; + $this->rights[$r][3] = 0; + $this->rights[$r][4] = 'allactions'; + $this->rights[$r][5] = 'read'; + $r++; - $this->rights[$r][0] = 2405; - $this->rights[$r][1] = 'Create/modify/delete actions/tasks of others'; - $this->rights[$r][2] = 'w'; - $this->rights[$r][3] = 0; - $this->rights[$r][4] = 'allactions'; - $this->rights[$r][5] = 'create'; - $r++; + $this->rights[$r][0] = 2405; + $this->rights[$r][1] = 'Create/modify/delete actions/tasks of others'; + $this->rights[$r][2] = 'w'; + $this->rights[$r][3] = 0; + $this->rights[$r][4] = 'allactions'; + $this->rights[$r][5] = 'create'; + $r++; - // Menus + // Menus //------ $r=0; @@ -153,44 +151,44 @@ class modAgenda extends DolibarrModules $r++; // Exports - //-------- - $r=0; + //-------- + $r=0; - // $this->export_code[$r] Code unique identifiant l'export (tous modules confondus) - // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) - // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export - // $this->export_fields_sql[$r] Liste des champs exportables en codif sql - // $this->export_fields_name[$r] Liste des champs exportables en codif traduction - // $this->export_sql[$r] Requete sql qui offre les donnees a l'export - } + // $this->export_code[$r] Code unique identifiant l'export (tous modules confondus) + // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) + // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export + // $this->export_fields_sql[$r] Liste des champs exportables en codif sql + // $this->export_fields_name[$r] Liste des champs exportables en codif traduction + // $this->export_sql[$r] Requete sql qui offre les donnees a l'export + } - /** - * \brief Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. - * Definit egalement les repertoires de donnees a creer pour ce module. + /** + * \brief Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. + * Definit egalement les repertoires de donnees a creer pour ce module. * \param options Options when enabling module - */ - function init($options='') - { + */ + function init($options='') + { // Prevent pb of modules not correctly disabled //$this->remove($options); $sql = array(); - return $this->_init($sql,$options); - } + return $this->_init($sql,$options); + } - /** - * \brief Fonction appelee lors de la desactivation d'un module. - * Supprime de la base les constantes, boites et permissions du module. + /** + * \brief Fonction appelee lors de la desactivation d'un module. + * Supprime de la base les constantes, boites et permissions du module. * \param options Options when disabling module - */ - function remove($options='') - { + */ + function remove($options='') + { $sql = array(); return $this->_remove($sql,$options); - } + } } ?>