modKnowledgeManagement.class.php 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  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-2021 Frédéric France <frederic.france@netlogic.fr>
  5. * Copyright (C) 2021 SuperAdmin
  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 knowledgemanagement Module KnowledgeManagement
  22. * \brief KnowledgeManagement module descriptor.
  23. *
  24. * \file htdocs/core/modules/modKnowledgeManagement.class.php
  25. * \ingroup knowledgemanagement
  26. * \brief Description and activation file for module KnowledgeManagement
  27. */
  28. include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
  29. /**
  30. * Description and activation class for module KnowledgeManagement
  31. */
  32. class modKnowledgeManagement 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 = 57000;
  46. // Key text used to identify module (for permissions, menus, etc...)
  47. $this->rights_class = 'knowledgemanagement';
  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 = "crm";
  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 'ModuleKnowledgeManagementName' not found (KnowledgeManagement is name of module).
  56. $this->name = preg_replace('/^mod/i', '', get_class($this));
  57. // Module description, used if translation string 'ModuleKnowledgeManagementDesc' not found (KnowledgeManagement is name of module).
  58. $this->description = "Knowledge Management (KM)";
  59. // Used only if file README.md and README-LL.md not found.
  60. $this->descriptionlong = "Manage a Knowledge Management (KM) or Help-Desk base";
  61. // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
  62. $this->version = 'dolibarr';
  63. // Url to the file with your last numberversion of this module
  64. //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
  65. // Key used in llx_const table to save module status enabled/disabled (where KNOWLEDGEMANAGEMENT is value of property name of module in uppercase)
  66. $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
  67. // Name of image file used for this module.
  68. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
  69. // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
  70. // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
  71. $this->picto = 'knowledgemanagement';
  72. // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
  73. $this->module_parts = array(
  74. // Set this to 1 if module has its own trigger directory (core/triggers)
  75. 'triggers' => 0,
  76. // Set this to 1 if module has its own login method file (core/login)
  77. 'login' => 0,
  78. // Set this to 1 if module has its own substitution function file (core/substitutions)
  79. 'substitutions' => 0,
  80. // Set this to 1 if module has its own menus handler directory (core/menus)
  81. 'menus' => 0,
  82. // Set this to 1 if module overwrite template dir (core/tpl)
  83. 'tpl' => 0,
  84. // Set this to 1 if module has its own barcode directory (core/modules/barcode)
  85. 'barcode' => 0,
  86. // Set this to 1 if module has its own models directory (core/modules/xxx)
  87. 'models' => 1,
  88. // Set this to 1 if module has its own printing directory (core/modules/printing)
  89. 'printing' => 0,
  90. // Set this to 1 if module has its own theme directory (theme)
  91. 'theme' => 0,
  92. // Set this to relative path of css file if module has its own css file
  93. 'css' => array(
  94. // '/knowledgemanagement/css/knowledgemanagement.css.php',
  95. ),
  96. // Set this to relative path of js file if module must load a js on all pages
  97. 'js' => array(
  98. // '/knowledgemanagement/js/knowledgemanagement.js.php',
  99. ),
  100. // 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'
  101. 'hooks' => array(
  102. // 'data' => array(
  103. // 'hookcontext1',
  104. // 'hookcontext2',
  105. // ),
  106. // 'entity' => '0',
  107. ),
  108. // Set this to 1 if features of module are opened to external users
  109. 'moduleforexternal' => 0,
  110. );
  111. // Data directories to create when module is enabled.
  112. // Example: this->dirs = array("/knowledgemanagement/temp","/knowledgemanagement/subdir");
  113. $this->dirs = array("/knowledgemanagement/temp");
  114. // Config pages. Put here list of php page, stored into knowledgemanagement/admin directory, to use to setup module.
  115. $this->config_page_url = array("knowledgemanagement.php");
  116. // Dependencies
  117. // A condition to hide module
  118. $this->hidden = false;
  119. // List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
  120. $this->depends = array();
  121. $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
  122. $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
  123. // The language file dedicated to your module
  124. $this->langfiles = array("knowledgemanagement");
  125. // Prerequisites
  126. $this->phpmin = array(5, 6); // Minimum version of PHP required by module
  127. $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
  128. // Messages at activation
  129. $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  130. $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  131. //$this->automatic_activation = array('FR'=>'KnowledgeManagementWasAutomaticallyActivatedBecauseOfYourCountryChoice');
  132. //$this->always_enabled = true; // If true, can't be disabled
  133. // Constants
  134. // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
  135. // Example: $this->const=array(1 => array('KNOWLEDGEMANAGEMENT_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
  136. // 2 => array('KNOWLEDGEMANAGEMENT_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
  137. // );
  138. $this->const = array();
  139. // Some keys to add into the overwriting translation tables
  140. /*$this->overwrite_translation = array(
  141. 'en_US:ParentCompany'=>'Parent company or reseller',
  142. 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
  143. )*/
  144. if (!isset($conf->knowledgemanagement) || !isset($conf->knowledgemanagement->enabled)) {
  145. $conf->knowledgemanagement = new stdClass();
  146. $conf->knowledgemanagement->enabled = 0;
  147. }
  148. // Array to add new pages in new tabs
  149. $this->tabs = array();
  150. // Example:
  151. // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@knowledgemanagement:$user->rights->knowledgemanagement->read:/knowledgemanagement/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
  152. // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@knowledgemanagement:$user->rights->othermodule->read:/knowledgemanagement/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.
  153. // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
  154. //
  155. // Where objecttype can be
  156. // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
  157. // 'contact' to add a tab in contact view
  158. // 'contract' to add a tab in contract view
  159. // 'group' to add a tab in group view
  160. // 'intervention' to add a tab in intervention view
  161. // 'invoice' to add a tab in customer invoice view
  162. // 'invoice_supplier' to add a tab in supplier invoice view
  163. // 'member' to add a tab in fundation member view
  164. // 'opensurveypoll' to add a tab in opensurvey poll view
  165. // 'order' to add a tab in customer order view
  166. // 'order_supplier' to add a tab in supplier order view
  167. // 'payment' to add a tab in payment view
  168. // 'payment_supplier' to add a tab in supplier payment view
  169. // 'product' to add a tab in product view
  170. // 'propal' to add a tab in propal view
  171. // 'project' to add a tab in project view
  172. // 'stock' to add a tab in stock view
  173. // 'thirdparty' to add a tab in third party view
  174. // 'user' to add a tab in user view
  175. // Dictionaries
  176. $this->dictionaries = array();
  177. /* Example:
  178. $this->dictionaries=array(
  179. 'langs'=>'knowledgemanagement@knowledgemanagement',
  180. // List of tables we want to see into dictonnary editor
  181. 'tabname'=>array(MAIN_DB_PREFIX."table1", MAIN_DB_PREFIX."table2", MAIN_DB_PREFIX."table3"),
  182. // Label of tables
  183. 'tablib'=>array("Table1", "Table2", "Table3"),
  184. // Request to select fields
  185. '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'),
  186. // Sort order
  187. 'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
  188. // List of fields (result of select to show dictionary)
  189. 'tabfield'=>array("code,label", "code,label", "code,label"),
  190. // List of fields (list of fields to edit a record)
  191. 'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
  192. // List of fields (list of fields for insert)
  193. 'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
  194. // Name of columns with primary key (try to always name it 'rowid')
  195. 'tabrowid'=>array("rowid", "rowid", "rowid"),
  196. // Condition to show each dictionary
  197. 'tabcond'=>array($conf->knowledgemanagement->enabled, $conf->knowledgemanagement->enabled, $conf->knowledgemanagement->enabled)
  198. );
  199. */
  200. // Boxes/Widgets
  201. // Add here list of php file(s) stored in knowledgemanagement/core/boxes that contains a class to show a widget.
  202. $this->boxes = array(
  203. // 0 => array(
  204. // 'file' => 'knowledgemanagementwidget1.php@knowledgemanagement',
  205. // 'note' => 'Widget provided by KnowledgeManagement',
  206. // 'enabledbydefaulton' => 'Home',
  207. // ),
  208. // ...
  209. );
  210. // Cronjobs (List of cron jobs entries to add when module is enabled)
  211. // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
  212. $this->cronjobs = array(
  213. // 0 => array(
  214. // 'label' => 'MyJob label',
  215. // 'jobtype' => 'method',
  216. // 'class' => '/knowledgemanagement/class/knowledgerecord.class.php',
  217. // 'objectname' => 'KnowledgeRecord',
  218. // 'method' => 'doScheduledJob',
  219. // 'parameters' => '',
  220. // 'comment' => 'Comment',
  221. // 'frequency' => 2,
  222. // 'unitfrequency' => 3600,
  223. // 'status' => 0,
  224. // 'test' => '$conf->knowledgemanagement->enabled',
  225. // 'priority' => 50,
  226. // ),
  227. );
  228. // Example: $this->cronjobs=array(
  229. // 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'=>'$conf->knowledgemanagement->enabled', 'priority'=>50),
  230. // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->knowledgemanagement->enabled', 'priority'=>50)
  231. // );
  232. // Permissions provided by this module
  233. $this->rights = array();
  234. $r = 0;
  235. // Add here entries to declare new permissions
  236. /* BEGIN MODULEBUILDER PERMISSIONS */
  237. $this->rights[$r][0] = $this->numero + $r + 1; // Permission id (must not be already used)
  238. $this->rights[$r][1] = 'Read articles'; // Permission label
  239. $this->rights[$r][4] = 'knowledgerecord'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  240. $this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  241. $r++;
  242. $this->rights[$r][0] = $this->numero + $r + 1; // Permission id (must not be already used)
  243. $this->rights[$r][1] = 'Create/Update articles'; // Permission label
  244. $this->rights[$r][4] = 'knowledgerecord'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  245. $this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  246. $r++;
  247. $this->rights[$r][0] = $this->numero + $r + 1; // Permission id (must not be already used)
  248. $this->rights[$r][1] = 'Delete articles'; // Permission label
  249. $this->rights[$r][4] = 'knowledgerecord'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  250. $this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->knowledgemanagement->level1->level2)
  251. $r++;
  252. /* END MODULEBUILDER PERMISSIONS */
  253. // Main menu entries to add
  254. $this->menu = array();
  255. $r = 0;
  256. // Add here entries to declare new menus
  257. /* BEGIN MODULEBUILDER TOPMENU */
  258. /*
  259. $this->menu[$r++] = array(
  260. '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
  261. 'type'=>'top', // This is a Top menu entry
  262. 'titre'=>'ModuleKnowledgeManagementName',
  263. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em092"'),
  264. 'mainmenu'=>'knowledgemanagement',
  265. 'leftmenu'=>'',
  266. 'url'=>'/knowledgemanagement/knowledgerecord_list.php',
  267. 'langs'=>'knowledgemanagement', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  268. 'position'=>1000 + $r,
  269. 'enabled'=>'$conf->knowledgemanagement->enabled', // Define condition to show or hide menu entry. Use '$conf->knowledgemanagement->enabled' if entry must be visible if module is enabled.
  270. 'perms'=>'1', // Use 'perms'=>'$user->rights->knowledgemanagement->knowledgerecord->read' if you want your menu with a permission rules
  271. 'target'=>'',
  272. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  273. );
  274. */
  275. /* END MODULEBUILDER TOPMENU */
  276. $this->menu[$r++]=array(
  277. // '' 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
  278. 'fk_menu'=>'fk_mainmenu=ticket',
  279. // This is a Left menu entry
  280. 'type'=>'left',
  281. 'titre'=>'MenuKnowledgeRecord',
  282. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em092"'),
  283. 'mainmenu'=>'ticket',
  284. 'leftmenu'=>'knowledgemanagement_knowledgerecord',
  285. 'url'=>'/knowledgemanagement/knowledgerecord_list.php',
  286. // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  287. 'langs'=>'knowledgemanagement',
  288. 'position'=>101,
  289. // Define condition to show or hide menu entry. Use '$conf->knowledgemanagement->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  290. 'enabled'=>'$conf->knowledgemanagement->enabled',
  291. // Use 'perms'=>'$user->rights->knowledgemanagement->level1->level2' if you want your menu with a permission rules
  292. 'perms'=>'$user->rights->knowledgemanagement->knowledgerecord->read',
  293. 'target'=>'',
  294. // 0=Menu for internal users, 1=external users, 2=both
  295. 'user'=>2,
  296. );
  297. $this->menu[$r++]=array(
  298. // '' 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. 'fk_menu'=>'fk_mainmenu=ticket,fk_leftmenu=knowledgemanagement_knowledgerecord',
  300. // This is a Left menu entry
  301. 'type'=>'left',
  302. 'titre'=>'ListKnowledgeRecord',
  303. 'mainmenu'=>'ticket',
  304. 'leftmenu'=>'knowledgemanagement_list',
  305. 'url'=>'/knowledgemanagement/knowledgerecord_list.php',
  306. // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  307. 'langs'=>'knowledgemanagement',
  308. 'position'=>111,
  309. // Define condition to show or hide menu entry. Use '$conf->knowledgemanagement->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  310. 'enabled'=>'$conf->knowledgemanagement->enabled',
  311. // Use 'perms'=>'$user->rights->knowledgemanagement->level1->level2' if you want your menu with a permission rules
  312. 'perms'=>'$user->rights->knowledgemanagement->knowledgerecord->read',
  313. 'target'=>'',
  314. // 0=Menu for internal users, 1=external users, 2=both
  315. 'user'=>2,
  316. );
  317. $this->menu[$r++]=array(
  318. // '' 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
  319. 'fk_menu'=>'fk_mainmenu=ticket,fk_leftmenu=knowledgemanagement_knowledgerecord',
  320. // This is a Left menu entry
  321. 'type'=>'left',
  322. 'titre'=>'NewKnowledgeRecord',
  323. 'mainmenu'=>'ticket',
  324. 'leftmenu'=>'knowledgemanagement_new',
  325. 'url'=>'/knowledgemanagement/knowledgerecord_card.php?action=create',
  326. // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  327. 'langs'=>'knowledgemanagement',
  328. 'position'=>110,
  329. // Define condition to show or hide menu entry. Use '$conf->knowledgemanagement->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  330. 'enabled'=>'$conf->knowledgemanagement->enabled',
  331. // Use 'perms'=>'$user->rights->knowledgemanagement->level1->level2' if you want your menu with a permission rules
  332. 'perms'=>'$user->rights->knowledgemanagement->knowledgerecord->write',
  333. 'target'=>'',
  334. // 0=Menu for internal users, 1=external users, 2=both
  335. 'user'=>2
  336. );
  337. $this->menu[$r++] = array(
  338. 'fk_menu' => 'fk_mainmenu=ticket,fk_leftmenu=knowledgemanagement_knowledgerecord',
  339. 'type' => 'left',
  340. 'titre' => 'Categories',
  341. 'mainmenu' => 'ticket',
  342. 'url' => '/categories/index.php?type=13',
  343. 'langs' => 'knowledgemanagement',
  344. 'position' => 112,
  345. 'enabled' => '$conf->knowledgemanagement->enabled',
  346. 'perms' => '$user->rights->knowledgemanagement->knowledgerecord->read',
  347. 'target' => '',
  348. 'user' => 0
  349. );
  350. /* END MODULEBUILDER LEFTMENU KNOWLEDGERECORD */
  351. // Exports profiles provided by this module
  352. $r = 1;
  353. /* BEGIN MODULEBUILDER EXPORT KNOWLEDGERECORD */
  354. /*
  355. $langs->load("knowledgemanagement");
  356. $this->export_code[$r]=$this->rights_class.'_'.$r;
  357. $this->export_label[$r]='KnowledgeRecordLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  358. $this->export_icon[$r]='knowledgerecord@knowledgemanagement';
  359. // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
  360. $keyforclass = 'KnowledgeRecord'; $keyforclassfile='/knowledgemanagement/class/knowledgerecord.class.php'; $keyforelement='knowledgerecord@knowledgemanagement';
  361. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  362. //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
  363. //unset($this->export_fields_array[$r]['t.fieldtoremove']);
  364. //$keyforclass = 'KnowledgeRecordLine'; $keyforclassfile='/knowledgemanagement/class/knowledgerecord.class.php'; $keyforelement='knowledgerecordline@knowledgemanagement'; $keyforalias='tl';
  365. //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  366. $keyforselect='knowledgerecord'; $keyforaliasextra='extra'; $keyforelement='knowledgerecord@knowledgemanagement';
  367. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  368. //$keyforselect='knowledgerecordline'; $keyforaliasextra='extraline'; $keyforelement='knowledgerecordline@knowledgemanagement';
  369. //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  370. //$this->export_dependencies_array[$r] = array('knowledgerecordline'=>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)
  371. //$this->export_special_array[$r] = array('t.field'=>'...');
  372. //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
  373. //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
  374. $this->export_sql_start[$r]='SELECT DISTINCT ';
  375. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'knowledgerecord as t';
  376. //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'knowledgerecord_line as tl ON tl.fk_knowledgerecord = t.rowid';
  377. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  378. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('knowledgerecord').')';
  379. $r++; */
  380. /* END MODULEBUILDER EXPORT KNOWLEDGERECORD */
  381. // Imports profiles provided by this module
  382. $r = 1;
  383. /* BEGIN MODULEBUILDER IMPORT KNOWLEDGERECORD */
  384. /*
  385. $langs->load("knowledgemanagement");
  386. $this->export_code[$r]=$this->rights_class.'_'.$r;
  387. $this->export_label[$r]='KnowledgeRecordLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  388. $this->export_icon[$r]='knowledgerecord@knowledgemanagement';
  389. $keyforclass = 'KnowledgeRecord'; $keyforclassfile='/knowledgemanagement/class/knowledgerecord.class.php'; $keyforelement='knowledgerecord@knowledgemanagement';
  390. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  391. $keyforselect='knowledgerecord'; $keyforaliasextra='extra'; $keyforelement='knowledgerecord@knowledgemanagement';
  392. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  393. //$this->export_dependencies_array[$r]=array('mysubobject'=>'ts.rowid', 't.myfield'=>array('t.myfield2','t.myfield3')); // 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)
  394. $this->export_sql_start[$r]='SELECT DISTINCT ';
  395. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'knowledgerecord as t';
  396. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  397. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('knowledgerecord').')';
  398. $r++; */
  399. /* END MODULEBUILDER IMPORT KNOWLEDGERECORD */
  400. }
  401. /**
  402. * Function called when module is enabled.
  403. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
  404. * It also creates data directories
  405. *
  406. * @param string $options Options when enabling module ('', 'noboxes')
  407. * @return int 1 if OK, 0 if KO
  408. */
  409. public function init($options = '')
  410. {
  411. global $conf, $langs;
  412. $result = $this->_load_tables('/install/mysql/', 'knowledgemanagement');
  413. if ($result < 0) {
  414. 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')
  415. }
  416. // Create extrafields during init
  417. //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
  418. //$extrafields = new ExtraFields($this->db);
  419. //$result1=$extrafields->addExtraField('knowledgemanagement_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'knowledgemanagement@knowledgemanagement', '$conf->knowledgemanagement->enabled');
  420. //$result2=$extrafields->addExtraField('knowledgemanagement_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'knowledgemanagement@knowledgemanagement', '$conf->knowledgemanagement->enabled');
  421. //$result3=$extrafields->addExtraField('knowledgemanagement_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'knowledgemanagement@knowledgemanagement', '$conf->knowledgemanagement->enabled');
  422. //$result4=$extrafields->addExtraField('knowledgemanagement_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'knowledgemanagement@knowledgemanagement', '$conf->knowledgemanagement->enabled');
  423. //$result5=$extrafields->addExtraField('knowledgemanagement_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'knowledgemanagement@knowledgemanagement', '$conf->knowledgemanagement->enabled');
  424. // Permissions
  425. $this->remove($options);
  426. $sql = array();
  427. // Document templates
  428. $moduledir = 'knowledgemanagement';
  429. $myTmpObjects = array();
  430. $myTmpObjects['KnowledgeRecord'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
  431. foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
  432. if ($myTmpObjectKey == 'KnowledgeRecord') {
  433. continue;
  434. }
  435. if ($myTmpObjectArray['includerefgeneration']) {
  436. $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/knowledgemanagement/template_knowledgerecords.odt';
  437. $dirodt = DOL_DATA_ROOT.'/doctemplates/knowledgemanagement';
  438. $dest = $dirodt.'/template_knowledgerecords.odt';
  439. if (file_exists($src) && !file_exists($dest)) {
  440. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  441. dol_mkdir($dirodt);
  442. $result = dol_copy($src, $dest, 0, 0);
  443. if ($result < 0) {
  444. $langs->load("errors");
  445. $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
  446. return 0;
  447. }
  448. }
  449. $sql = array_merge($sql, array(
  450. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".((int) $conf->entity),
  451. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."','".strtolower($myTmpObjectKey)."',".((int) $conf->entity).")",
  452. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".((int) $conf->entity),
  453. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".strtolower($myTmpObjectKey)."', ".((int) $conf->entity).")"
  454. ));
  455. }
  456. }
  457. return $this->_init($sql, $options);
  458. }
  459. /**
  460. * Function called when module is disabled.
  461. * Remove from database constants, boxes and permissions from Dolibarr database.
  462. * Data directories are not deleted
  463. *
  464. * @param string $options Options when enabling module ('', 'noboxes')
  465. * @return int 1 if OK, 0 if KO
  466. */
  467. public function remove($options = '')
  468. {
  469. $sql = array();
  470. return $this->_remove($sql, $options);
  471. }
  472. }