dolibarr/dev/skeletons/modMyModule.class.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.
 *
 * $Id$
 */

/**     \defgroup   mymodule     Module MyModule
        \brief      Example of a module descriptor.
					Suche 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
*/

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','technic','other'
		// It is used to group modules in module setup page 
		$this->family = "projects";		
		// Module title used if translation string 'ModuleXXXName' not found (XXX is value MyModule)
		$this->name = "Webcalendar";	
		// Module description used if translation string 'ModuleXXXDesc' not found (XXX is value MyModule)
		$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 (XXX is value MyModule)
		$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();
		
		// 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
		
		// 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
		
		// Add here list of permission defined by an id, a label, a boolean and two constant strings.
		// Example:
		// $r++;
		// $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)

		// Main menu entries
		$this->menus = array();			// List of menus to add
		$r=0;

		// Example:
		// $r++;
		//  type					'top'				// Menu top or left
		// `mainmenu`,				'mymodule'			// Name family/module (home, companies, ...)
		// `fk_menu`,				0					// 0 or Id of mother menu line
		// `position`				100					// Order of entry
		// `url`,					'/myurl'	// Relative (or absolute) url to go
		// `target`,				''					// Target of Url link
		// `titre`,					'MyMenu'			// Key for menu translation 
		// `langs`,					'other'				// Lang file to load for translation
		// `leftmenu`,				''					// Condition to compare to $_REQUEST["leftmenu"] to show or hide menu entry
		// `right`,					''					// Condition to show enabled or disabled menu entry
		// `user`,					0					// 0 if menu for all users, 1 for external only, 2 for internal only

	}

	/**
     *		\brief      Function called when module is enabled.
     *					The init function add previous constants, boxes and permissions into Dolibarr database.
     *					It also creates data directories.
     */
	function init()
  	{
    	$sql = array();
    
    	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.
 	 */
	function remove()
	{
    	$sql = array();

    	return $this->_remove($sql);
  	}

}

?>