modApi::remove() - Code Metrics - Inspection of "Daily Inspection: Merge pull request #8326 from at..." - Dolibarr/dolibarr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (96aaeb)

unknown

created 2018-03-10 16:10 UTC

modApi::remove() A

↳ Parent: modApi

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php
/* Copyright (C) 2003		Rodolphe Quiedeville		<[email protected]>
 * Copyright (C) 2004-2012	Laurent Destailleur		<[email protected]>
 * Copyright (C) 2015		Jean-François Ferry		<[email protected]>
 * Copyright (C) 2018		Regis Houssin			<[email protected]>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * 	\defgroup   api     Module Api
 *  \brief      Descriptor file for Api modulee
 *  \file       htdocs/core/modules/modApi.class.php
 *  \ingroup    api
 *  \brief      Description and activation file for module Api
 */
include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';


/**
 *  Description and activation class for module Api
 */
class modApi extends DolibarrModules
{
	/**
	 *   Constructor. Define names, constants, directories, boxes, permissions
	 *
	 *   @param      DoliDB		$db      Database handler
	 */
	function __construct($db)
	{
        global $langs,$conf;

        $this->db = $db;

		// Id for module (must be unique).
		// Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
		$this->numero = 2610;
		// Key text used to identify module (for permissions, menus, etc...)
		$this->rights_class = 'api';

		// Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
		// It is used to group modules in module setup page
		$this->family = "interface";
		// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
		$this->name = preg_replace('/^mod/i','',get_class($this));
		// Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
		$this->description = "REST interface";
		// Possible values for version are: 'development', 'experimental', 'dolibarr' or 'dolibarr_deprecated' or version
		$this->version = 'dolibarr';
		// 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);
		// Can be enabled / disabled only in the main company with superadmin account
		$this->core_enabled = 1;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		// Name of image file used for this module.
		// If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
		// If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
		$this->picto='technic';

		$this->module_parts = array();

		// Data directories to create when module is enabled.
		// Example: this->dirs = array("/api/temp");
		$this->dirs = array('/api/temp');

		// Config pages. Put here list of php page, stored into api/admin directory, to use to setup module.
		$this->config_page_url = array("index.php@api");

		// Dependencies
		$this->hidden = false;			// A condition to hide module
		$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->conflictwith = array();	// List of modules id this module is in conflict with
		$this->phpmin = array(5,3);					// Minimum version of PHP required by module
		$this->langfiles = array("other");

		// Constants
		// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
		// Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
		//                             1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
		// );
		$this->const = array();

		// Array to add new pages in new tabs
		// Example: $this->tabs = array('objecttype:+tabname1:Title1:mylangfile@api:$user->rights->api->read:/api/mynewtab1.php?id=__ID__',  					// To add a new tab identified by code tabname1
        //                              'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@api:$user->rights->othermodule->read:/api/mynewtab2.php?id=__ID__',  	// To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
        //                              'objecttype:-tabname:NU:conditiontoremove');                                                     										// To remove an existing tab identified by code tabname
		// where objecttype can be
		// 'categories_x'	  to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
		// 'contact'          to add a tab in contact view
		// 'contract'         to add a tab in contract view
		// 'group'            to add a tab in group view
		// 'intervention'     to add a tab in intervention view
		// 'invoice'          to add a tab in customer invoice view
		// 'invoice_supplier' to add a tab in supplier invoice view
		// 'member'           to add a tab in fundation member view
		// 'opensurveypoll'	  to add a tab in opensurvey poll view
		// 'order'            to add a tab in customer order view
		// 'order_supplier'   to add a tab in supplier order view
		// 'payment'		  to add a tab in payment view
		// 'payment_supplier' to add a tab in supplier payment view
		// 'product'          to add a tab in product view
		// 'propal'           to add a tab in propal view
		// 'project'          to add a tab in project view
		// 'stock'            to add a tab in stock view
		// 'thirdparty'       to add a tab in third party view
		// 'user'             to add a tab in user view
        $this->tabs = array();

        // Dictionaries
	    if (! isset($conf->api->enabled))
        {
        	$conf->api=new stdClass();
        	$conf->api->enabled=0;
        }
		$this->dictionaries=array();
        /* Example:
        if (! isset($conf->api->enabled)) $conf->api->enabled=0;	// This is to avoid warnings
        $this->dictionaries=array(
            'langs'=>'mylangfile@api',
            'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"),		// List of tables we want to see into dictonnary editor
            'tablib'=>array("Table1","Table2","Table3"),													// Label of tables
            'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'),	// Request to select fields
            'tabsqlsort'=>array("label ASC","label ASC","label ASC"),																					// Sort order
            'tabfield'=>array("code,label","code,label","code,label"),																					// List of fields (result of select to show dictionary)
            'tabfieldvalue'=>array("code,label","code,label","code,label"),																				// List of fields (list of fields to edit a record)
            'tabfieldinsert'=>array("code,label","code,label","code,label"),																			// List of fields (list of fields for insert)
            'tabrowid'=>array("rowid","rowid","rowid"),																									// Name of columns with primary key (try to always name it 'rowid')
            'tabcond'=>array($conf->api->enabled,$conf->api->enabled,$conf->api->enabled)												// Condition to show each dictionary
        );
        */

        // Boxes
		// Add here list of php file(s) stored in core/boxes that contains class to show a box.
        $this->boxes = array();			// List of boxes
		// Example:
		//$this->boxes=array(array(0=>array('file'=>'myboxa.php','note'=>'','enabledbydefaulton'=>'Home'),1=>array('file'=>'myboxb.php','note'=>''),2=>array('file'=>'myboxc.php','note'=>'')););

		// 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] = $this->numero + $r;	// Permission id (must not be already used)
		// $this->rights[$r][1] = 'Permision label';	// Permission label
		// $this->rights[$r][3] = 0; 					// 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->menu = array();			// List of menus to add
		$r=0;

		// Add here entries to declare new menus
		//
		// Example to declare a new Top Menu entry and its Left 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'=>'Api top menu',
		//							'mainmenu'=>'api',
		//							'leftmenu'=>'api',
		//							'url'=>'/api/pagetop.php',
		//							'langs'=>'mylangfile@api',	        // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
		//							'position'=>100,
		//							'enabled'=>'$conf->api->enabled',	// Define condition to show or hide menu entry. Use '$conf->api->enabled' if entry must be visible if module is enabled.
		//							'perms'=>'1',			                // Use 'perms'=>'$user->rights->api->level1->level2' if you want your menu with a permission rules
		//							'target'=>'',
		//							'user'=>2);				                // 0=Menu for internal users, 1=external users, 2=both
		// $r++;
		//
		// Example to declare a Left Menu entry into an existing Top menu entry:
		// $this->menu[$r]=array(	'fk_menu'=>'fk_mainmenu=xxx',		    // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
		//							'type'=>'left',			                // This is a Left menu entry
		//							'titre'=>'Api left menu',
		//							'mainmenu'=>'xxx',
		//							'leftmenu'=>'api',
		//							'url'=>'/api/pagelevel2.php',
		//							'langs'=>'mylangfile@api',	        // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
		//							'position'=>100,
		//							'enabled'=>'$conf->api->enabled',  // Define condition to show or hide menu entry. Use '$conf->api->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
		//							'perms'=>'1',			                // Use 'perms'=>'$user->rights->api->level1->level2' if you want your menu with a permission rules
		//							'target'=>'',
		//							'user'=>2);				                // 0=Menu for internal users, 1=external users, 2=both
		// $r++;


		// Exports
		$r=1;

		// Example:
		// $this->export_code[$r]=$this->rights_class.'_'.$r;
		// $this->export_label[$r]='CustomersInvoicesAndInvoiceLines';	// Translation key (used only if key ExportDataset_xxx_z not found)
        // $this->export_enabled[$r]='1';                               // Condition to show export in list (ie: '$user->id==3'). Set to 1 to always show when module is enabled.
		// $this->export_permission[$r]=array(array("facture","facture","export"));
		// $this->export_fields_array[$r]=array('s.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone','s.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode','s.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus','f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef');
		// $this->export_entities_array[$r]=array('s.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company','s.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company','f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",'f.tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product');
		// $this->export_sql_start[$r]='SELECT DISTINCT ';
		// $this->export_sql_end[$r]  =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
		// $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
		// $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
		// $this->export_sql_order[$r] .=' ORDER BY s.nom';
		// $r++;
	}

	/**
	 *		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
	 *
     *      @param      string	$options    Options when enabling module ('', 'noboxes')
	 *      @return     int             	1 if OK, 0 if KO
	 */
	function init($options='')
	{
		$sql = array();

		$result=$this->_load_tables('/api/sql/');

		return $this->_init($sql, $options);
	}

	/**
	 *		Function called when module is disabled.
	 *      Remove from database constants, boxes and permissions from Dolibarr database.
	 *		Data directories are not deleted.
	 *
	 *      @param string $options Options when enabling module ('', 'noboxes')
	 *      @return int 1 if OK, 0 if KO
	 */
	function remove($options = '')
	{
		// Remove old constants with entity fields different of 0
		$sql = array(
			"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('MAIN_MODULE_API', 1),
			"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('API_PRODUCTION_MODE', 1)
		);

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



1			<?php
2			/* Copyright (C) 2003 Rodolphe Quiedeville <[email protected]>
3			* Copyright (C) 2004-2012 Laurent Destailleur <[email protected]>
4			* Copyright (C) 2015 Jean-François Ferry <[email protected]>
5			* Copyright (C) 2018 Regis Houssin <[email protected]>
6			*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 3 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program. If not, see <http://www.gnu.org/licenses/>.
19			*/
20
21			/**
22			* \defgroup api Module Api
23			* \brief Descriptor file for Api modulee
24			* \file htdocs/core/modules/modApi.class.php
25			* \ingroup api
26			* \brief Description and activation file for module Api
27			*/
28			include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
29
30
31			/**
32			* Description and activation class for module Api
33			*/
34			class modApi extends DolibarrModules
35			{
36			/**
37			* Constructor. Define names, constants, directories, boxes, permissions
38			*
39			* @param DoliDB $db Database handler
40			*/
41			function __construct($db)
42			{
43			global $langs,$conf;
44
45			$this->db = $db;
46
47			// Id for module (must be unique).
48			// Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
49			$this->numero = 2610;
50			// Key text used to identify module (for permissions, menus, etc...)
51			$this->rights_class = 'api';
52
53			// Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
54			// It is used to group modules in module setup page
55			$this->family = "interface";
56			// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
57			$this->name = preg_replace('/^mod/i','',get_class($this));
58			// Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
59			$this->description = "REST interface";
60			// Possible values for version are: 'development', 'experimental', 'dolibarr' or 'dolibarr_deprecated' or version
61			$this->version = 'dolibarr';
62			// Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
63			$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
64			// Can be enabled / disabled only in the main company with superadmin account
65			$this->core_enabled = 1;
			0 ignored issues – show Documentation Bug introduced 2018-03-10 16:40 UTC by Report Bug Copy Issue Report The property `$core_enabled` was declared of type `boolean`, but `1` is of type `integer`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
66			// Name of image file used for this module.
67			// If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
68			// If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
69			$this->picto='technic';
70
71			$this->module_parts = array();
72
73			// Data directories to create when module is enabled.
74			// Example: this->dirs = array("/api/temp");
75			$this->dirs = array('/api/temp');
76
77			// Config pages. Put here list of php page, stored into api/admin directory, to use to setup module.
78			$this->config_page_url = array("index.php@api");
79
80			// Dependencies
81			$this->hidden = false; // A condition to hide module
82			$this->depends = array(); // List of modules id that must be enabled if this module is enabled
83			$this->requiredby = array(); // List of modules id to disable if this one is disabled
84			$this->conflictwith = array(); // List of modules id this module is in conflict with
85			$this->phpmin = array(5,3); // Minimum version of PHP required by module
86			$this->langfiles = array("other");
87
88			// Constants
89			// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
90			// Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
91			// 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
92			// );
93			$this->const = array();
94
95			// Array to add new pages in new tabs
96			// Example: $this->tabs = array('objecttype:+tabname1:Title1:mylangfile@api:$user->rights->api->read:/api/mynewtab1.php?id=__ID__', // To add a new tab identified by code tabname1
97			// 'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@api:$user->rights->othermodule->read:/api/mynewtab2.php?id=__ID__', // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
98			// 'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
99			// where objecttype can be
100			// 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
101			// 'contact' to add a tab in contact view
102			// 'contract' to add a tab in contract view
103			// 'group' to add a tab in group view
104			// 'intervention' to add a tab in intervention view
105			// 'invoice' to add a tab in customer invoice view
106			// 'invoice_supplier' to add a tab in supplier invoice view
107			// 'member' to add a tab in fundation member view
108			// 'opensurveypoll' to add a tab in opensurvey poll view
109			// 'order' to add a tab in customer order view
110			// 'order_supplier' to add a tab in supplier order view
111			// 'payment' to add a tab in payment view
112			// 'payment_supplier' to add a tab in supplier payment view
113			// 'product' to add a tab in product view
114			// 'propal' to add a tab in propal view
115			// 'project' to add a tab in project view
116			// 'stock' to add a tab in stock view
117			// 'thirdparty' to add a tab in third party view
118			// 'user' to add a tab in user view
119			$this->tabs = array();
120
121			// Dictionaries
122			if (! isset($conf->api->enabled))
123			{
124			$conf->api=new stdClass();
125			$conf->api->enabled=0;
126			}
127			$this->dictionaries=array();
128			/* Example:
129			if (! isset($conf->api->enabled)) $conf->api->enabled=0; // This is to avoid warnings
130			$this->dictionaries=array(
131			'langs'=>'mylangfile@api',
132			'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"), // List of tables we want to see into dictonnary editor
133			'tablib'=>array("Table1","Table2","Table3"), // Label of tables
134			'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'), // Request to select fields
135			'tabsqlsort'=>array("label ASC","label ASC","label ASC"), // Sort order
136			'tabfield'=>array("code,label","code,label","code,label"), // List of fields (result of select to show dictionary)
137			'tabfieldvalue'=>array("code,label","code,label","code,label"), // List of fields (list of fields to edit a record)
138			'tabfieldinsert'=>array("code,label","code,label","code,label"), // List of fields (list of fields for insert)
139			'tabrowid'=>array("rowid","rowid","rowid"), // Name of columns with primary key (try to always name it 'rowid')
140			'tabcond'=>array($conf->api->enabled,$conf->api->enabled,$conf->api->enabled) // Condition to show each dictionary
141			);
142			*/
143
144			// Boxes
145			// Add here list of php file(s) stored in core/boxes that contains class to show a box.
146			$this->boxes = array(); // List of boxes
147			// Example:
148			//$this->boxes=array(array(0=>array('file'=>'myboxa.php','note'=>'','enabledbydefaulton'=>'Home'),1=>array('file'=>'myboxb.php','note'=>''),2=>array('file'=>'myboxc.php','note'=>'')););
149
150			// Permissions
151			$this->rights = array(); // Permission array used by this module
152			$r=0;
153
154			// Add here list of permission defined by an id, a label, a boolean and two constant strings.
155			// Example:
156			// $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
157			// $this->rights[$r][1] = 'Permision label'; // Permission label
158			// $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
159			// $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
160			// $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
161			// $r++;
162
163
164			// Main menu entries
165			$this->menu = array(); // List of menus to add
166			$r=0;
167
168			// Add here entries to declare new menus
169			//
170			// Example to declare a new Top Menu entry and its Left menu entry:
171			// $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
172			// 'type'=>'top', // This is a Top menu entry
173			// 'titre'=>'Api top menu',
174			// 'mainmenu'=>'api',
175			// 'leftmenu'=>'api',
176			// 'url'=>'/api/pagetop.php',
177			// 'langs'=>'mylangfile@api', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
178			// 'position'=>100,
179			// 'enabled'=>'$conf->api->enabled', // Define condition to show or hide menu entry. Use '$conf->api->enabled' if entry must be visible if module is enabled.
180			// 'perms'=>'1', // Use 'perms'=>'$user->rights->api->level1->level2' if you want your menu with a permission rules
181			// 'target'=>'',
182			// 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
183			// $r++;
184			//
185			// Example to declare a Left Menu entry into an existing Top menu entry:
186			// $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
187			// 'type'=>'left', // This is a Left menu entry
188			// 'titre'=>'Api left menu',
189			// 'mainmenu'=>'xxx',
190			// 'leftmenu'=>'api',
191			// 'url'=>'/api/pagelevel2.php',
192			// 'langs'=>'mylangfile@api', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
193			// 'position'=>100,
194			// 'enabled'=>'$conf->api->enabled', // Define condition to show or hide menu entry. Use '$conf->api->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
195			// 'perms'=>'1', // Use 'perms'=>'$user->rights->api->level1->level2' if you want your menu with a permission rules
196			// 'target'=>'',
197			// 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
198			// $r++;
199
200
201			// Exports
202			$r=1;
203
204			// Example:
205			// $this->export_code[$r]=$this->rights_class.'_'.$r;
206			// $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
207			// $this->export_enabled[$r]='1'; // Condition to show export in list (ie: '$user->id==3'). Set to 1 to always show when module is enabled.
208			// $this->export_permission[$r]=array(array("facture","facture","export"));
209			// $this->export_fields_array[$r]=array('s.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone','s.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode','s.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus','f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef');
210			// $this->export_entities_array[$r]=array('s.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company','s.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company','f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",'f.tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product');
211			// $this->export_sql_start[$r]='SELECT DISTINCT ';
212			// $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
213			// $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
214			// $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
215			// $this->export_sql_order[$r] .=' ORDER BY s.nom';
216			// $r++;
217			}
218
219			/**
220			* Function called when module is enabled.
221			* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
222			* It also creates data directories
223			*
224			* @param string $options Options when enabling module ('', 'noboxes')
225			* @return int 1 if OK, 0 if KO
226			*/
227			function init($options='')
228			{
229			$sql = array();
230
231			$result=$this->_load_tables('/api/sql/');
232
233			return $this->_init($sql, $options);
234			}
235
236			/**
237			* Function called when module is disabled.
238			* Remove from database constants, boxes and permissions from Dolibarr database.
239			* Data directories are not deleted.
240			*
241			* @param string $options Options when enabling module ('', 'noboxes')
242			* @return int 1 if OK, 0 if KO
243			*/
244			function remove($options = '')
245			{
246			// Remove old constants with entity fields different of 0
247			$sql = array(
248			"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('MAIN_MODULE_API', 1),
249			"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('API_PRODUCTION_MODE', 1)
250			);
251
252			return $this->_remove($sql, $options);
253			}
254			}
255
256

Dolibarr / dolibarr

Branch — develop (96aaeb)

modApi::remove() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like