modMyModule.class.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  1. <?php
  2. /* Copyright (C) 2004-2018 Laurent Destailleur <eldy@users.sourceforge.net>
  3. * Copyright (C) 2018-2019 Nicolas ZABOURI <info@inovea-conseil.com>
  4. * Copyright (C) 2019-2020 Frédéric France <frederic.france@netlogic.fr>
  5. * Copyright (C) ---Put here your own copyright and developer email---
  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 <https://www.gnu.org/licenses/>.
  19. */
  20. /**
  21. * \defgroup mymodule Module MyModule
  22. * \brief MyModule module descriptor.
  23. *
  24. * \file htdocs/mymodule/core/modules/modMyModule.class.php
  25. * \ingroup mymodule
  26. * \brief Description and activation file for module MyModule
  27. */
  28. include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
  29. /**
  30. * Description and activation class for module MyModule
  31. */
  32. class modMyModule extends DolibarrModules
  33. {
  34. /**
  35. * Constructor. Define names, constants, directories, boxes, permissions
  36. *
  37. * @param DoliDB $db Database handler
  38. */
  39. public function __construct($db)
  40. {
  41. global $langs, $conf;
  42. $this->db = $db;
  43. // Id for module (must be unique).
  44. // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
  45. $this->numero = 500000; // TODO Go on page https://wiki.dolibarr.org/index.php/List_of_modules_id to reserve an id number for your module
  46. // Key text used to identify module (for permissions, menus, etc...)
  47. $this->rights_class = 'mymodule';
  48. // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
  49. // It is used to group modules by family in module setup page
  50. $this->family = "other";
  51. // Module position in the family on 2 digits ('01', '10', '20', ...)
  52. $this->module_position = '90';
  53. // Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
  54. //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
  55. // Module label (no space allowed), used if translation string 'ModuleMyModuleName' not found (MyModule is name of module).
  56. $this->name = preg_replace('/^mod/i', '', get_class($this));
  57. // Module description, used if translation string 'ModuleMyModuleDesc' not found (MyModule is name of module).
  58. $this->description = "MyModuleDescription";
  59. // Used only if file README.md and README-LL.md not found.
  60. $this->descriptionlong = "MyModuleDescription";
  61. // Author
  62. $this->editor_name = 'Editor name';
  63. $this->editor_url = 'https://www.example.com';
  64. // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated', 'experimental_deprecated' or a version string like 'x.y.z'
  65. $this->version = '1.0';
  66. // Url to the file with your last numberversion of this module
  67. //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
  68. // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
  69. $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
  70. // Name of image file used for this module.
  71. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
  72. // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
  73. // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
  74. $this->picto = 'generic';
  75. // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
  76. $this->module_parts = array(
  77. // Set this to 1 if module has its own trigger directory (core/triggers)
  78. 'triggers' => 0,
  79. // Set this to 1 if module has its own login method file (core/login)
  80. 'login' => 0,
  81. // Set this to 1 if module has its own substitution function file (core/substitutions)
  82. 'substitutions' => 0,
  83. // Set this to 1 if module has its own menus handler directory (core/menus)
  84. 'menus' => 0,
  85. // Set this to 1 if module overwrite template dir (core/tpl)
  86. 'tpl' => 0,
  87. // Set this to 1 if module has its own barcode directory (core/modules/barcode)
  88. 'barcode' => 0,
  89. // Set this to 1 if module has its own models directory (core/modules/xxx)
  90. 'models' => 0,
  91. // Set this to 1 if module has its own printing directory (core/modules/printing)
  92. 'printing' => 0,
  93. // Set this to 1 if module has its own theme directory (theme)
  94. 'theme' => 0,
  95. // Set this to relative path of css file if module has its own css file
  96. 'css' => array(
  97. // '/mymodule/css/mymodule.css.php',
  98. ),
  99. // Set this to relative path of js file if module must load a js on all pages
  100. 'js' => array(
  101. // '/mymodule/js/mymodule.js.php',
  102. ),
  103. // Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context to 'all'
  104. 'hooks' => array(
  105. // 'data' => array(
  106. // 'hookcontext1',
  107. // 'hookcontext2',
  108. // ),
  109. // 'entity' => '0',
  110. ),
  111. // Set this to 1 if features of module are opened to external users
  112. 'moduleforexternal' => 0,
  113. );
  114. // Data directories to create when module is enabled.
  115. // Example: this->dirs = array("/mymodule/temp","/mymodule/subdir");
  116. $this->dirs = array("/mymodule/temp");
  117. // Config pages. Put here list of php page, stored into mymodule/admin directory, to use to setup module.
  118. $this->config_page_url = array("setup.php@mymodule");
  119. // Dependencies
  120. // A condition to hide module
  121. $this->hidden = false;
  122. // List of module class names that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR')...)
  123. $this->depends = array();
  124. // List of module class names to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
  125. $this->requiredby = array();
  126. // List of module class names this module is in conflict with. Example: array('modModuleToDisable1', ...)
  127. $this->conflictwith = array();
  128. // The language file dedicated to your module
  129. $this->langfiles = array("mymodule@mymodule");
  130. // Prerequisites
  131. $this->phpmin = array(7, 0); // Minimum version of PHP required by module
  132. $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
  133. // Messages at activation
  134. $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
  135. $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
  136. //$this->automatic_activation = array('FR'=>'MyModuleWasAutomaticallyActivatedBecauseOfYourCountryChoice');
  137. //$this->always_enabled = true; // If true, can't be disabled
  138. // Constants
  139. // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
  140. // Example: $this->const=array(1 => array('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
  141. // 2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
  142. // );
  143. $this->const = array();
  144. // Some keys to add into the overwriting translation tables
  145. /*$this->overwrite_translation = array(
  146. 'en_US:ParentCompany'=>'Parent company or reseller',
  147. 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
  148. )*/
  149. if (!isset($conf->mymodule) || !isset($conf->mymodule->enabled)) {
  150. $conf->mymodule = new stdClass();
  151. $conf->mymodule->enabled = 0;
  152. }
  153. // Array to add new pages in new tabs
  154. $this->tabs = array();
  155. // Example:
  156. // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
  157. // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@mymodule:$user->rights->othermodule->read:/mymodule/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.
  158. // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
  159. //
  160. // Where objecttype can be
  161. // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
  162. // 'contact' to add a tab in contact view
  163. // 'contract' to add a tab in contract view
  164. // 'group' to add a tab in group view
  165. // 'intervention' to add a tab in intervention view
  166. // 'invoice' to add a tab in customer invoice view
  167. // 'invoice_supplier' to add a tab in supplier invoice view
  168. // 'member' to add a tab in fundation member view
  169. // 'opensurveypoll' to add a tab in opensurvey poll view
  170. // 'order' to add a tab in sale order view
  171. // 'order_supplier' to add a tab in supplier order view
  172. // 'payment' to add a tab in payment view
  173. // 'payment_supplier' to add a tab in supplier payment view
  174. // 'product' to add a tab in product view
  175. // 'propal' to add a tab in propal view
  176. // 'project' to add a tab in project view
  177. // 'stock' to add a tab in stock view
  178. // 'thirdparty' to add a tab in third party view
  179. // 'user' to add a tab in user view
  180. // Dictionaries
  181. $this->dictionaries = array();
  182. /* Example:
  183. $this->dictionaries=array(
  184. 'langs'=>'mymodule@mymodule',
  185. // List of tables we want to see into dictonnary editor
  186. 'tabname'=>array("table1", "table2", "table3"),
  187. // Label of tables
  188. 'tablib'=>array("Table1", "Table2", "Table3"),
  189. // Request to select fields
  190. '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'),
  191. // Sort order
  192. 'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
  193. // List of fields (result of select to show dictionary)
  194. 'tabfield'=>array("code,label", "code,label", "code,label"),
  195. // List of fields (list of fields to edit a record)
  196. 'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
  197. // List of fields (list of fields for insert)
  198. 'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
  199. // Name of columns with primary key (try to always name it 'rowid')
  200. 'tabrowid'=>array("rowid", "rowid", "rowid"),
  201. // Condition to show each dictionary
  202. 'tabcond'=>array(isModEnabled('mymodule'), isModEnabled('mymodule'), isModEnabled('mymodule')),
  203. // Tooltip for every fields of dictionaries: DO NOT PUT AN EMPTY ARRAY
  204. 'tabhelp'=>array(array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), ...),
  205. );
  206. */
  207. // Boxes/Widgets
  208. // Add here list of php file(s) stored in mymodule/core/boxes that contains a class to show a widget.
  209. $this->boxes = array(
  210. // 0 => array(
  211. // 'file' => 'mymodulewidget1.php@mymodule',
  212. // 'note' => 'Widget provided by MyModule',
  213. // 'enabledbydefaulton' => 'Home',
  214. // ),
  215. // ...
  216. );
  217. // Cronjobs (List of cron jobs entries to add when module is enabled)
  218. // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
  219. $this->cronjobs = array(
  220. // 0 => array(
  221. // 'label' => 'MyJob label',
  222. // 'jobtype' => 'method',
  223. // 'class' => '/mymodule/class/myobject.class.php',
  224. // 'objectname' => 'MyObject',
  225. // 'method' => 'doScheduledJob',
  226. // 'parameters' => '',
  227. // 'comment' => 'Comment',
  228. // 'frequency' => 2,
  229. // 'unitfrequency' => 3600,
  230. // 'status' => 0,
  231. // 'test' => 'isModEnabled("mymodule")',
  232. // 'priority' => 50,
  233. // ),
  234. );
  235. // Example: $this->cronjobs=array(
  236. // 0=>array('label'=>'My label', 'jobtype'=>'method', 'class'=>'/dir/class/file.class.php', 'objectname'=>'MyClass', 'method'=>'myMethod', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>'isModEnabled("mymodule")', 'priority'=>50),
  237. // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'isModEnabled("mymodule")', 'priority'=>50)
  238. // );
  239. // Permissions provided by this module
  240. $this->rights = array();
  241. $r = 0;
  242. // Add here entries to declare new permissions
  243. /* BEGIN MODULEBUILDER PERMISSIONS */
  244. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  245. $this->rights[$r][1] = 'Read objects of MyModule'; // Permission label
  246. $this->rights[$r][4] = 'myobject';
  247. $this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->mymodule->myobject->read)
  248. $r++;
  249. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  250. $this->rights[$r][1] = 'Create/Update objects of MyModule'; // Permission label
  251. $this->rights[$r][4] = 'myobject';
  252. $this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->mymodule->myobject->write)
  253. $r++;
  254. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  255. $this->rights[$r][1] = 'Delete objects of MyModule'; // Permission label
  256. $this->rights[$r][4] = 'myobject';
  257. $this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->mymodule->myobject->delete)
  258. $r++;
  259. /* END MODULEBUILDER PERMISSIONS */
  260. // Main menu entries to add
  261. $this->menu = array();
  262. $r = 0;
  263. // Add here entries to declare new menus
  264. /* BEGIN MODULEBUILDER TOPMENU */
  265. $this->menu[$r++] = array(
  266. 'fk_menu'=>'', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  267. 'type'=>'top', // This is a Top menu entry
  268. 'titre'=>'ModuleMyModuleName',
  269. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
  270. 'mainmenu'=>'mymodule',
  271. 'leftmenu'=>'',
  272. 'url'=>'/mymodule/mymoduleindex.php',
  273. 'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  274. 'position'=>1000 + $r,
  275. 'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
  276. 'perms'=>'1', // Use 'perms'=>'$user->hasRight("mymodule", "myobject", "read")' if you want your menu with a permission rules
  277. 'target'=>'',
  278. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  279. );
  280. /* END MODULEBUILDER TOPMENU */
  281. /* BEGIN MODULEBUILDER LEFTMENU MYOBJECT
  282. $this->menu[$r++]=array(
  283. 'fk_menu'=>'fk_mainmenu=mymodule', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  284. 'type'=>'left', // This is a Left menu entry
  285. 'titre'=>'MyObject',
  286. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
  287. 'mainmenu'=>'mymodule',
  288. 'leftmenu'=>'myobject',
  289. 'url'=>'/mymodule/mymoduleindex.php',
  290. 'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  291. 'position'=>1000+$r,
  292. 'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
  293. 'perms'=>'$user->hasRight("mymodule", "myobject", "read")',
  294. 'target'=>'',
  295. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  296. );
  297. $this->menu[$r++]=array(
  298. 'fk_menu'=>'fk_mainmenu=mymodule,fk_leftmenu=myobject', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  299. 'type'=>'left', // This is a Left menu entry
  300. 'titre'=>'List_MyObject',
  301. 'mainmenu'=>'mymodule',
  302. 'leftmenu'=>'mymodule_myobject_list',
  303. 'url'=>'/mymodule/myobject_list.php',
  304. 'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  305. 'position'=>1000+$r,
  306. 'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
  307. 'perms'=>'$user->hasRight("mymodule", "myobject", "read")'
  308. 'target'=>'',
  309. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  310. );
  311. $this->menu[$r++]=array(
  312. 'fk_menu'=>'fk_mainmenu=mymodule,fk_leftmenu=myobject', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  313. 'type'=>'left', // This is a Left menu entry
  314. 'titre'=>'New_MyObject',
  315. 'mainmenu'=>'mymodule',
  316. 'leftmenu'=>'mymodule_myobject_new',
  317. 'url'=>'/mymodule/myobject_card.php?action=create',
  318. 'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  319. 'position'=>1000+$r,
  320. 'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  321. 'perms'=>'$user->hasRight("mymodule", "myobject", "write")'
  322. 'target'=>'',
  323. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  324. );
  325. /* END MODULEBUILDER LEFTMENU MYOBJECT */
  326. // Exports profiles provided by this module
  327. $r = 1;
  328. /* BEGIN MODULEBUILDER EXPORT MYOBJECT */
  329. /*
  330. $langs->load("mymodule@mymodule");
  331. $this->export_code[$r]=$this->rights_class.'_'.$r;
  332. $this->export_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  333. $this->export_icon[$r]='myobject@mymodule';
  334. // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
  335. $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
  336. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  337. //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
  338. //unset($this->export_fields_array[$r]['t.fieldtoremove']);
  339. //$keyforclass = 'MyObjectLine'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobjectline@mymodule'; $keyforalias='tl';
  340. //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  341. $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
  342. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  343. //$keyforselect='myobjectline'; $keyforaliasextra='extraline'; $keyforelement='myobjectline@mymodule';
  344. //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  345. //$this->export_dependencies_array[$r] = array('myobjectline'=>array('tl.rowid','tl.ref')); // To force to activate one or several fields if we select some fields that need same (like to select a unique key if we ask a field of a child to avoid the DISTINCT to discard them, or for computed field than need several other fields)
  346. //$this->export_special_array[$r] = array('t.field'=>'...');
  347. //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
  348. //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
  349. $this->export_sql_start[$r]='SELECT DISTINCT ';
  350. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'myobject as t';
  351. //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'myobject_line as tl ON tl.fk_myobject = t.rowid';
  352. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  353. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('myobject').')';
  354. $r++; */
  355. /* END MODULEBUILDER EXPORT MYOBJECT */
  356. // Imports profiles provided by this module
  357. $r = 1;
  358. /* BEGIN MODULEBUILDER IMPORT MYOBJECT */
  359. /*
  360. $langs->load("mymodule@mymodule");
  361. $this->import_code[$r]=$this->rights_class.'_'.$r;
  362. $this->import_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  363. $this->import_icon[$r]='myobject@mymodule';
  364. $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'mymodule_myobject', 'extra' => MAIN_DB_PREFIX.'mymodule_myobject_extrafields');
  365. $this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
  366. $import_sample = array();
  367. $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
  368. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
  369. $import_extrafield_sample = array();
  370. $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
  371. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
  372. $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'mymodule_myobject');
  373. $this->import_regex_array[$r] = array();
  374. $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
  375. $this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
  376. $this->import_convertvalue_array[$r] = array(
  377. 't.ref' => array(
  378. 'rule'=>'getrefifauto',
  379. 'class'=>(empty($conf->global->MYMODULE_MYOBJECT_ADDON) ? 'mod_myobject_standard' : $conf->global->MYMODULE_MYOBJECT_ADDON),
  380. 'path'=>"/core/modules/commande/".(empty($conf->global->MYMODULE_MYOBJECT_ADDON) ? 'mod_myobject_standard' : $conf->global->MYMODULE_MYOBJECT_ADDON).'.php'
  381. 'classobject'=>'MyObject',
  382. 'pathobject'=>'/mymodule/class/myobject.class.php',
  383. ),
  384. 't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
  385. 't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
  386. 't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
  387. );
  388. $r++; */
  389. /* END MODULEBUILDER IMPORT MYOBJECT */
  390. }
  391. /**
  392. * Function called when module is enabled.
  393. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
  394. * It also creates data directories
  395. *
  396. * @param string $options Options when enabling module ('', 'noboxes')
  397. * @return int 1 if OK, 0 if KO
  398. */
  399. public function init($options = '')
  400. {
  401. global $conf, $langs;
  402. //$result = $this->_load_tables('/install/mysql/', 'mymodule');
  403. $result = $this->_load_tables('/mymodule/sql/');
  404. if ($result < 0) {
  405. return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
  406. }
  407. // Create extrafields during init
  408. //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
  409. //$extrafields = new ExtraFields($this->db);
  410. //$result1=$extrafields->addExtraField('mymodule_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
  411. //$result2=$extrafields->addExtraField('mymodule_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
  412. //$result3=$extrafields->addExtraField('mymodule_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
  413. //$result4=$extrafields->addExtraField('mymodule_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
  414. //$result5=$extrafields->addExtraField('mymodule_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
  415. // Permissions
  416. $this->remove($options);
  417. $sql = array();
  418. // Document templates
  419. $moduledir = dol_sanitizeFileName('mymodule');
  420. $myTmpObjects = array();
  421. $myTmpObjects['MyObject'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
  422. foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
  423. if ($myTmpObjectKey == 'MyObject') {
  424. continue;
  425. }
  426. if ($myTmpObjectArray['includerefgeneration']) {
  427. $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_myobjects.odt';
  428. $dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
  429. $dest = $dirodt.'/template_myobjects.odt';
  430. if (file_exists($src) && !file_exists($dest)) {
  431. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  432. dol_mkdir($dirodt);
  433. $result = dol_copy($src, $dest, 0, 0);
  434. if ($result < 0) {
  435. $langs->load("errors");
  436. $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
  437. return 0;
  438. }
  439. }
  440. $sql = array_merge($sql, array(
  441. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
  442. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
  443. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
  444. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
  445. ));
  446. }
  447. }
  448. return $this->_init($sql, $options);
  449. }
  450. /**
  451. * Function called when module is disabled.
  452. * Remove from database constants, boxes and permissions from Dolibarr database.
  453. * Data directories are not deleted
  454. *
  455. * @param string $options Options when enabling module ('', 'noboxes')
  456. * @return int 1 if OK, 0 if KO
  457. */
  458. public function remove($options = '')
  459. {
  460. $sql = array();
  461. return $this->_remove($sql, $options);
  462. }
  463. }