forked from Wavyzz/dolibarr
233 lines
8.2 KiB
PHP
233 lines
8.2 KiB
PHP
<?php
|
|
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
|
|
* Copyright (C) 2004-2008 Laurent Destailleur <eldy@users.sourceforge.net>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
/** \defgroup mymodule Module MyModule
|
|
\brief Example of a module descriptor.
|
|
Such a file must be copied into htdocs/includes/module directory.
|
|
*/
|
|
|
|
/**
|
|
\file htdocs/includes/modules/modMyModule.class.php
|
|
\ingroup mymodule
|
|
\brief Description and activation file for module MyModule
|
|
\version $Id$
|
|
*/
|
|
|
|
include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
|
|
|
|
|
|
/** \class modMyModule
|
|
\brief Description and activation class for module MyModule
|
|
*/
|
|
|
|
class modMyModule extends DolibarrModules
|
|
{
|
|
|
|
/**
|
|
* \brief Constructor. Define names, constants, directories, boxes, permissions
|
|
* \param DB Database handler
|
|
*/
|
|
function modMyModule($DB)
|
|
{
|
|
$this->db = $DB;
|
|
|
|
// Id for module (must be unique).
|
|
// Use here a free id (See in Home -> System information -> Dolibarr for list of used module id).
|
|
$this->numero = 10000;
|
|
// Key text used to identify module (for permission, menus, etc...)
|
|
$this->rights_class = 'mymodule';
|
|
|
|
// Family can be 'crm','financial','hr','projects','product','ecm','technic','other'
|
|
// It is used to group modules in module setup page
|
|
$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 = "MyModuleLabel";
|
|
// Module description used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
|
|
$this->description = "Description of module MyModule";
|
|
// Possible values for version are: 'development', 'experimental', 'dolibarr' or version
|
|
$this->version = '1.0';
|
|
// 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_MYMODULE';
|
|
// Where to store the module in setup page (0=common,1=interface,2=other)
|
|
$this->special = 1;
|
|
// Name of png file (without png) used for this module.
|
|
// Png file must be in theme/yourtheme/img directory under name object_pictovalue.png.
|
|
$this->picto='generic';
|
|
|
|
// Data directories to create when module is enabled.
|
|
$this->dirs = array();
|
|
//$this->dirs[0] = DOL_DATA_ROOT.'/mymodule;
|
|
//$this->dirs[1] = DOL_DATA_ROOT.'/mymodule/temp;
|
|
|
|
// Relative path to module style sheet if exists. Example: '/mymodule/mycss.css'.
|
|
$this->style_sheet = '';
|
|
|
|
// Config pages. Put here list of php page names stored in admmin directory used to setup module.
|
|
$this->config_page_url = array("mymodulesetuppage.php");
|
|
|
|
// Dependencies
|
|
$this->depends = array(); // List of modules id that must be enabled if this module is enabled
|
|
$this->requiredby = array(); // List of modules id to disable if this one is disabled
|
|
$this->phpmin = array(4,1); // Minimum version of PHP required by module
|
|
$this->need_dolibarr_version = array(2,4); // Minimum version of Dolibarr required by module
|
|
$this->langfiles = array("mymodule");
|
|
|
|
// Constants
|
|
$this->const = array(); // List of parameters
|
|
|
|
// Boxes
|
|
$this->boxes = array(); // List of boxes
|
|
$r=0;
|
|
|
|
// Add here list of php file(s) stored in includes/boxes that contains class to show a box.
|
|
// Example:
|
|
//$this->boxes[$r][1] = "myboxa.php";
|
|
//$r++;
|
|
//$this->boxes[$r][1] = "myboxb.php";
|
|
//$r++;
|
|
|
|
// Permissions
|
|
$this->rights = array(); // Permission array used by this module
|
|
$r=0;
|
|
|
|
// Add here list of permission defined by an id, a label, a boolean and two constant strings.
|
|
// Example:
|
|
// $this->rights[$r][0] = 2000; // Permission id (must not be already used)
|
|
// $this->rights[$r][1] = 'Permision label'; // Permission label
|
|
// $this->rights[$r][3] = 1; // Permission by default for new user (0/1)
|
|
// $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
|
|
// $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
|
|
// $r++;
|
|
|
|
// Main menu entries
|
|
$this->menus = array(); // List of menus to add
|
|
$r=0;
|
|
|
|
// Example:
|
|
// This is to declare the Top Menu entry:
|
|
// $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
|
|
// 'type'=>'top', // This is a Top menu entry
|
|
// 'titre'=>'Title top menu',
|
|
// 'mainmenu'=>'mymodule',
|
|
// 'leftmenu'=>'1', // Use 1 if you also want to add left menu entries using this descriptor. Use 0 if left menu entries are defined in a file pre.inc.php (old school).
|
|
// 'url'=>'/comm/action/index.php',
|
|
// 'langs'=>'mylangfile', // Lang file to use (without .lang) by module
|
|
// 'position'=>100,
|
|
// 'perms'=>'$user->rights->mymodule->level1->level2',
|
|
// 'target'=>'',
|
|
// 'user'=>0); // 0=menu for all users
|
|
// $r++;
|
|
//
|
|
// This is to declare a Left Menu entry:
|
|
// $this->menu[$r]=array( 'fk_menu'=>'r=0', // Use r=value where r is index key used for the top menu entry
|
|
// 'type'=>'left', // This is a Left menu entry
|
|
// 'titre'=>'Title left menu',
|
|
// 'mainmenu'=>'mymodule',
|
|
// 'url'=>'/comm/action/index2.php',
|
|
// 'langs'=>'mylangfile', // Lang file to use (without .lang) by module
|
|
// 'position'=>100,
|
|
// 'perms'=>'$user->rights->mymodule->level1->level2',
|
|
// 'target'=>'',
|
|
// 'user'=>0); // 0=menu for all users
|
|
// $r++;
|
|
|
|
}
|
|
|
|
/**
|
|
* \brief Function called when module is enabled.
|
|
* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
|
|
* It also creates data directories.
|
|
* \return int 1 if OK, 0 if KO
|
|
*/
|
|
function init()
|
|
{
|
|
$sql = array();
|
|
|
|
$result=$this->load_tables();
|
|
|
|
return $this->_init($sql);
|
|
}
|
|
|
|
/**
|
|
* \brief Function called when module is disabled.
|
|
* Remove from database constants, boxes and permissions from Dolibarr database.
|
|
* Data directories are not deleted.
|
|
* \return int 1 if OK, 0 if KO
|
|
*/
|
|
function remove()
|
|
{
|
|
$sql = array();
|
|
|
|
return $this->_remove($sql);
|
|
}
|
|
|
|
|
|
/**
|
|
* \brief Create tables and keys required by module
|
|
* Files mymodule.sql and mymodule.key.sql with create table and create keys
|
|
* commands must be stored in directory /mysql/tables/mymodule/.
|
|
* This function is called by this->init.
|
|
* \return int <=0 if KO, >0 if OK
|
|
*/
|
|
function load_tables()
|
|
{
|
|
include_once(DOL_DOCUMENT_ROOT ."/lib/admin.lib.php");
|
|
|
|
global $db;
|
|
|
|
$ok = 1;
|
|
if ($ok)
|
|
{
|
|
$dir = DOL_DOCUMENT_ROOT.'/mysql/tables/mymodule/';
|
|
$ok = 0;
|
|
|
|
// Run llx_mytable.sql files
|
|
$handle=opendir($dir);
|
|
while (($file = readdir($handle))!==false)
|
|
{
|
|
if (eregi('\.sql$',$file) && substr($file,0,4) == 'llx_' && substr($file, -8) <> '.key.sql')
|
|
{
|
|
$result=run_sql($file,1);
|
|
}
|
|
}
|
|
closedir($handle);
|
|
|
|
// Run llx_mytable.key.sql files
|
|
$handle=opendir($dir);
|
|
while (($file = readdir($handle))!==false)
|
|
{
|
|
if (eregi('\.sql$',$file) && substr($file,0,4) == 'llx_' && substr($file, -8) == '.key.sql')
|
|
{
|
|
$result=run_sql($file,1);
|
|
}
|
|
}
|
|
closedir($handle);
|
|
|
|
if ($error == 0)
|
|
{
|
|
$ok = 1;
|
|
}
|
|
}
|
|
|
|
return $ok;
|
|
}
|
|
}
|
|
|
|
?>
|