modPartnership.class.php 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  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) 2021 Dorian Laurent <i.merraha@sofimedmaroc.com>
  6. * Copyright (C) 2021 NextGestion <contact@nextgestion.com>
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  20. */
  21. /**
  22. * \defgroup partnership Module Partnership
  23. * \brief Partnership module descriptor.
  24. *
  25. * \file htdocs/partnership/core/modules/modPartnership.class.php
  26. * \ingroup partnership
  27. * \brief Description and activation file for module Partnership
  28. */
  29. include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
  30. /**
  31. * Description and activation class for module Partnership
  32. * This module is base on this specification :
  33. * https://wiki.dolibarr.org/index.php?title=Draft:Module_Partnership_management#Note
  34. */
  35. class modPartnership extends DolibarrModules
  36. {
  37. /**
  38. * Constructor. Define names, constants, directories, boxes, permissions
  39. *
  40. * @param DoliDB $db Database handler
  41. */
  42. public function __construct($db)
  43. {
  44. global $langs, $conf;
  45. $this->db = $db;
  46. // Id for module (must be unique).
  47. // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
  48. $this->numero = 58000;
  49. // Key text used to identify module (for permissions, menus, etc...)
  50. $this->rights_class = 'partnership';
  51. // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
  52. // It is used to group modules by family in module setup page
  53. $this->family = "crm";
  54. // Module position in the family on 2 digits ('01', '10', '20', ...)
  55. $this->module_position = '90';
  56. // 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)
  57. //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
  58. // Module label (no space allowed), used if translation string 'ModulePartnershipName' not found (Partnership is name of module).
  59. $this->name = preg_replace('/^mod/i', '', get_class($this));
  60. // Module description, used if translation string 'ModulePartnershipDesc' not found (Partnership is name of module).
  61. $this->description = "PartnershipDescription";
  62. // Used only if file README.md and README-LL.md not found.
  63. $this->descriptionlong = "PartnershipDescriptionLong";
  64. // // Author
  65. // $this->editor_name = 'Editor name';
  66. // $this->editor_url = 'https://www.example.com';
  67. // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
  68. $this->version = 'development';
  69. // Url to the file with your last numberversion of this module
  70. //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
  71. // Key used in llx_const table to save module status enabled/disabled (where PARTNERSHIP is value of property name of module in uppercase)
  72. $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
  73. // Name of image file used for this module.
  74. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
  75. // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
  76. // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
  77. $this->picto = 'partnership';
  78. // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
  79. $this->module_parts = array(
  80. // Set this to 1 if module has its own trigger directory (core/triggers)
  81. 'triggers' => 0,
  82. // Set this to 1 if module has its own login method file (core/login)
  83. 'login' => 0,
  84. // Set this to 1 if module has its own substitution function file (core/substitutions)
  85. 'substitutions' => 0,
  86. // Set this to 1 if module has its own menus handler directory (core/menus)
  87. 'menus' => 0,
  88. // Set this to 1 if module overwrite template dir (core/tpl)
  89. 'tpl' => 0,
  90. // Set this to 1 if module has its own barcode directory (core/modules/barcode)
  91. 'barcode' => 0,
  92. // Set this to 1 if module has its own models directory (core/modules/xxx)
  93. 'models' => 1,
  94. // Set this to 1 if module has its own printing directory (core/modules/printing)
  95. 'printing' => 0,
  96. // Set this to 1 if module has its own theme directory (theme)
  97. 'theme' => 0,
  98. // Set this to relative path of css file if module has its own css file
  99. 'css' => array(
  100. // '/partnership/css/partnership.css.php',
  101. ),
  102. // Set this to relative path of js file if module must load a js on all pages
  103. 'js' => array(
  104. // '/partnership/js/partnership.js.php',
  105. ),
  106. // 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'
  107. 'hooks' => array(
  108. // 'data' => array(
  109. // 'hookcontext1',
  110. // 'hookcontext2',
  111. // ),
  112. // 'entity' => '0',
  113. ),
  114. // Set this to 1 if features of module are opened to external users
  115. 'moduleforexternal' => 0,
  116. );
  117. // Data directories to create when module is enabled.
  118. // Example: this->dirs = array("/partnership/temp","/partnership/subdir");
  119. $this->dirs = array("/partnership/temp");
  120. // Config pages. Put here list of php page, stored into partnership/admin directory, to use to setup module.
  121. $this->config_page_url = array("setup.php@partnership");
  122. // Dependencies
  123. // A condition to hide module
  124. $this->hidden = false;
  125. // List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
  126. $this->depends = array();
  127. $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
  128. $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
  129. // The language file dedicated to your module
  130. $this->langfiles = array("partnership");
  131. // Prerequisites
  132. $this->phpmin = array(5, 6); // Minimum version of PHP required by module
  133. $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
  134. // Messages at activation
  135. $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  136. $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  137. //$this->automatic_activation = array('FR'=>'PartnershipWasAutomaticallyActivatedBecauseOfYourCountryChoice');
  138. //$this->always_enabled = true; // If true, can't be disabled
  139. // Constants
  140. // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
  141. // Example: $this->const=array(1 => array('PARTNERSHIP_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
  142. // 2 => array('PARTNERSHIP_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
  143. // );
  144. $this->const = array();
  145. // Some keys to add into the overwriting translation tables
  146. /*$this->overwrite_translation = array(
  147. 'en_US:ParentCompany'=>'Parent company or reseller',
  148. 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
  149. )*/
  150. if (!isset($conf->partnership) || !isset($conf->partnership->enabled)) {
  151. $conf->partnership = new stdClass();
  152. $conf->partnership->enabled = 0;
  153. }
  154. // Array to add new pages in new tabs
  155. $this->tabs = array();
  156. $tabtoadd = (!empty(getDolGlobalString('PARTNERSHIP_IS_MANAGED_FOR')) && getDolGlobalString('PARTNERSHIP_IS_MANAGED_FOR') == 'member') ? 'member' : 'thirdparty';
  157. if ($tabtoadd == 'member') {
  158. $fk_mainmenu = "members";
  159. } else {
  160. $fk_mainmenu = "companies";
  161. }
  162. // Example:
  163. // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@partnership:$user->rights->partnership->read:/partnership/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
  164. // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@partnership:$user->rights->othermodule->read:/partnership/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.
  165. // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
  166. //
  167. // Where objecttype can be
  168. // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
  169. // 'contact' to add a tab in contact view
  170. // 'contract' to add a tab in contract view
  171. // 'group' to add a tab in group view
  172. // 'intervention' to add a tab in intervention view
  173. // 'invoice' to add a tab in customer invoice view
  174. // 'invoice_supplier' to add a tab in supplier invoice view
  175. // 'member' to add a tab in fundation member view
  176. // 'opensurveypoll' to add a tab in opensurvey poll view
  177. // 'order' to add a tab in customer order view
  178. // 'order_supplier' to add a tab in supplier order view
  179. // 'payment' to add a tab in payment view
  180. // 'payment_supplier' to add a tab in supplier payment view
  181. // 'product' to add a tab in product view
  182. // 'propal' to add a tab in propal view
  183. // 'project' to add a tab in project view
  184. // 'stock' to add a tab in stock view
  185. // 'thirdparty' to add a tab in third party view
  186. // 'user' to add a tab in user view
  187. // Dictionaries
  188. $this->dictionaries=array(
  189. 'langs'=>'partnership@partnership',
  190. // List of tables we want to see into dictonnary editor
  191. 'tabname'=>array(MAIN_DB_PREFIX."c_partnership_type"),
  192. // Label of tables
  193. 'tablib'=>array("PartnershipType"),
  194. // Request to select fields
  195. 'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'c_partnership_type as f WHERE f.entity = '.$conf->entity),
  196. // Sort order
  197. 'tabsqlsort'=>array("label ASC"),
  198. // List of fields (result of select to show dictionary)
  199. 'tabfield'=>array("code,label"),
  200. // List of fields (list of fields to edit a record)
  201. 'tabfieldvalue'=>array("code,label"),
  202. // List of fields (list of fields for insert)
  203. 'tabfieldinsert'=>array("code,label"),
  204. // Name of columns with primary key (try to always name it 'rowid')
  205. 'tabrowid'=>array("rowid"),
  206. // Condition to show each dictionary
  207. 'tabcond'=>array($conf->partnership->enabled)
  208. );
  209. // Boxes/Widgets
  210. // Add here list of php file(s) stored in partnership/core/boxes that contains a class to show a widget.
  211. $this->boxes = array(
  212. // 0 => array(
  213. // 'file' => 'partnershipwidget1.php@partnership',
  214. // 'note' => 'Widget provided by Partnership',
  215. // 'enabledbydefaulton' => 'Home',
  216. // ),
  217. // ...
  218. );
  219. // Cronjobs (List of cron jobs entries to add when module is enabled)
  220. // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
  221. $arraydate=dol_getdate(dol_now());
  222. $datestart=dol_mktime(21, 15, 0, $arraydate['mon'], $arraydate['mday'], $arraydate['year']);
  223. $this->cronjobs = array(
  224. 0 => array('priority'=>60, 'label'=>'CancelPartnershipForExpiredMembers', 'jobtype'=>'method', 'class'=>'/partnership/class/partnershiputils.class.php', 'objectname'=>'PartnershipUtils', 'method'=>'doCancelStatusOfMemberPartnership', 'parameters'=>'', 'comment'=>'Cancel status of partnership when subscription is expired + x days.', 'frequency'=>1, 'unitfrequency'=>86400, 'status'=>1, 'test'=>'$conf->partnership->enabled', 'datestart'=>$datestart),
  225. 1 => array('priority'=>61, 'label'=>'PartnershipCheckBacklink', 'jobtype'=>'method', 'class'=>'/partnership/class/partnershiputils.class.php', 'objectname'=>'PartnershipUtils', 'method'=>'doWarningOfPartnershipIfDolibarrBacklinkNotfound', 'parameters'=>'', 'comment'=>'Warning of partnership if Dolibarr backlink not found on partner website.', 'frequency'=>1, 'unitfrequency'=>86400, 'status'=>0, 'test'=>'$conf->partnership->enabled', 'datestart'=>$datestart),
  226. );
  227. // Permissions provided by this module
  228. $this->rights = array();
  229. $r = 0;
  230. // Add here entries to declare new permissions
  231. /* BEGIN MODULEBUILDER PERMISSIONS */
  232. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  233. $this->rights[$r][1] = 'Read objects of Partnership'; // Permission label
  234. $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->partnership->level1->level2)
  235. $r++;
  236. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  237. $this->rights[$r][1] = 'Create/Update objects of Partnership'; // Permission label
  238. $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->partnership->level1->level2)
  239. $r++;
  240. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  241. $this->rights[$r][1] = 'Delete objects of Partnership'; // Permission label
  242. $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->partnership->level1->level2)
  243. $r++;
  244. /* END MODULEBUILDER PERMISSIONS */
  245. // Main menu entries to add
  246. $this->menu = array();
  247. $r = 0;
  248. // Add here entries to declare new menus
  249. /* BEGIN MODULEBUILDER TOPMENU */
  250. // $this->menu[$r++]=array(
  251. // // '' 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
  252. // 'fk_menu'=>'fk_mainmenu=partnership',
  253. // // This is a Left menu entry
  254. // 'type'=>'left',
  255. // 'titre'=>'List Partnership',
  256. // 'mainmenu'=>'partnership',
  257. // 'leftmenu'=>'partnership',
  258. // 'url'=>'/partnership/partnership_list.php',
  259. // // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  260. // 'langs'=>'partnership@partnership',
  261. // 'position'=>1100+$r,
  262. // // Define condition to show or hide menu entry. Use '$conf->partnership->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  263. // 'enabled'=>'$conf->partnership->enabled',
  264. // // Use 'perms'=>'$user->rights->partnership->level1->level2' if you want your menu with a permission rules
  265. // 'perms'=>'1',
  266. // 'target'=>'',
  267. // // 0=Menu for internal users, 1=external users, 2=both
  268. // 'user'=>2,
  269. // );
  270. $this->menu[$r++] = array(
  271. 'fk_menu'=>'fk_mainmenu='.$fk_mainmenu, // '' 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
  272. 'type'=>'left', // This is a Top menu entry
  273. 'titre'=>'Partnership',
  274. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth"'),
  275. 'mainmenu'=>$fk_mainmenu,
  276. 'leftmenu'=>'partnership',
  277. 'url'=>'/partnership/partnership_list.php',
  278. 'langs'=>'partnership', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  279. 'position'=>1100 + $r,
  280. 'enabled'=>'$conf->partnership->enabled', // Define condition to show or hide menu entry. Use '$conf->partnership->enabled' if entry must be visible if module is enabled.
  281. 'perms'=>'$user->rights->partnership->read', // Use 'perms'=>'$user->rights->partnership->level1->level2' if you want your menu with a permission rules
  282. 'target'=>'',
  283. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  284. );
  285. $this->menu[$r++] = array(
  286. 'fk_menu'=>'fk_mainmenu='.$fk_mainmenu.',fk_leftmenu=partnership', // '' 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
  287. 'type'=>'left', // This is a Left menu entry
  288. 'titre'=>'NewPartnership',
  289. 'mainmenu'=>$fk_mainmenu,
  290. 'leftmenu'=>'partnership_new',
  291. 'url'=>'/partnership/partnership_card.php?action=create',
  292. 'langs'=>'partnership', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  293. 'position'=>1100 + $r,
  294. 'enabled'=>'$conf->partnership->enabled', // Define condition to show or hide menu entry. Use '$conf->partnership->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  295. 'perms'=>'$user->rights->partnership->write', // Use 'perms'=>'$user->rights->partnership->level1->level2' if you want your menu with a permission rules
  296. 'target'=>'',
  297. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  298. );
  299. $this->menu[$r++] = array(
  300. 'fk_menu'=>'fk_mainmenu='.$fk_mainmenu.',fk_leftmenu=partnership', // '' 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
  301. 'type'=>'left', // This is a Left menu entry
  302. 'titre'=>'ListOfPartnerships',
  303. 'mainmenu'=>$fk_mainmenu,
  304. 'leftmenu'=>'partnership_list',
  305. 'url'=>'/partnership/partnership_list.php',
  306. 'langs'=>'partnership', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  307. 'position'=>1100 + $r,
  308. 'enabled'=>'$conf->partnership->enabled', // Define condition to show or hide menu entry. Use '$conf->partnership->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  309. 'perms'=>'$user->rights->partnership->read', // Use 'perms'=>'$user->rights->partnership->level1->level2' if you want your menu with a permission rules
  310. 'target'=>'',
  311. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  312. );
  313. /* END MODULEBUILDER LEFTMENU PARTNERSHIP */
  314. // Exports profiles provided by this module
  315. $r = 1;
  316. /* BEGIN MODULEBUILDER EXPORT PARTNERSHIP */
  317. /*
  318. $langs->load("partnership@partnership");
  319. $this->export_code[$r]=$this->rights_class.'_'.$r;
  320. $this->export_label[$r]='PartnershipLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  321. $this->export_icon[$r]='partnership@partnership';
  322. // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
  323. $keyforclass = 'Partnership'; $keyforclassfile='/partnership/class/partnership.class.php'; $keyforelement='partnership@partnership';
  324. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  325. //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
  326. //unset($this->export_fields_array[$r]['t.fieldtoremove']);
  327. //$keyforclass = 'PartnershipLine'; $keyforclassfile='/partnership/class/partnership.class.php'; $keyforelement='partnershipline@partnership'; $keyforalias='tl';
  328. //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  329. $keyforselect='partnership'; $keyforaliasextra='extra'; $keyforelement='partnership@partnership';
  330. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  331. //$keyforselect='partnershipline'; $keyforaliasextra='extraline'; $keyforelement='partnershipline@partnership';
  332. //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  333. //$this->export_dependencies_array[$r] = array('partnershipline'=>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)
  334. //$this->export_special_array[$r] = array('t.field'=>'...');
  335. //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
  336. //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
  337. $this->export_sql_start[$r]='SELECT DISTINCT ';
  338. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'partnership as t';
  339. //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'partnership_line as tl ON tl.fk_partnership = t.rowid';
  340. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  341. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('partnership').')';
  342. $r++; */
  343. /* END MODULEBUILDER EXPORT PARTNERSHIP */
  344. // Imports profiles provided by this module
  345. $r = 1;
  346. /* BEGIN MODULEBUILDER IMPORT PARTNERSHIP */
  347. /*
  348. $langs->load("partnership@partnership");
  349. $this->export_code[$r]=$this->rights_class.'_'.$r;
  350. $this->export_label[$r]='PartnershipLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  351. $this->export_icon[$r]='partnership@partnership';
  352. $keyforclass = 'Partnership'; $keyforclassfile='/partnership/class/partnership.class.php'; $keyforelement='partnership@partnership';
  353. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  354. $keyforselect='partnership'; $keyforaliasextra='extra'; $keyforelement='partnership@partnership';
  355. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  356. //$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)
  357. $this->export_sql_start[$r]='SELECT DISTINCT ';
  358. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'partnership as t';
  359. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  360. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('partnership').')';
  361. $r++; */
  362. /* END MODULEBUILDER IMPORT PARTNERSHIP */
  363. }
  364. /**
  365. * Function called when module is enabled.
  366. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
  367. * It also creates data directories
  368. *
  369. * @param string $options Options when enabling module ('', 'noboxes')
  370. * @return int 1 if OK, 0 if KO
  371. */
  372. public function init($options = '')
  373. {
  374. global $conf, $langs;
  375. $result = $this->_load_tables('/partnership/sql/');
  376. if ($result < 0) {
  377. 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')
  378. }
  379. // Create extrafields during init
  380. //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
  381. //$extrafields = new ExtraFields($this->db);
  382. //$result1=$extrafields->addExtraField('partnership_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'partnership@partnership', '$conf->partnership->enabled');
  383. //$result2=$extrafields->addExtraField('partnership_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'partnership@partnership', '$conf->partnership->enabled');
  384. //$result3=$extrafields->addExtraField('partnership_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'partnership@partnership', '$conf->partnership->enabled');
  385. //$result4=$extrafields->addExtraField('partnership_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'partnership@partnership', '$conf->partnership->enabled');
  386. //$result5=$extrafields->addExtraField('partnership_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'partnership@partnership', '$conf->partnership->enabled');
  387. // Permissions
  388. $this->remove($options);
  389. $sql = array();
  390. // Document templates
  391. $moduledir = 'partnership';
  392. $myTmpObjects = array();
  393. $myTmpObjects['Partnership'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
  394. foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
  395. if ($myTmpObjectKey == 'Partnership') {
  396. continue;
  397. }
  398. if ($myTmpObjectArray['includerefgeneration']) {
  399. $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/partnership/template_partnerships.odt';
  400. $dirodt = DOL_DATA_ROOT.'/doctemplates/partnership';
  401. $dest = $dirodt.'/template_partnerships.odt';
  402. if (file_exists($src) && !file_exists($dest)) {
  403. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  404. dol_mkdir($dirodt);
  405. $result = dol_copy($src, $dest, 0, 0);
  406. if ($result < 0) {
  407. $langs->load("errors");
  408. $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
  409. return 0;
  410. }
  411. }
  412. $sql = array_merge($sql, array(
  413. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".$conf->entity,
  414. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."','".strtolower($myTmpObjectKey)."',".$conf->entity.")",
  415. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".$conf->entity,
  416. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".strtolower($myTmpObjectKey)."', ".$conf->entity.")"
  417. ));
  418. }
  419. }
  420. return $this->_init($sql, $options);
  421. }
  422. /**
  423. * Function called when module is disabled.
  424. * Remove from database constants, boxes and permissions from Dolibarr database.
  425. * Data directories are not deleted
  426. *
  427. * @param string $options Options when enabling module ('', 'noboxes')
  428. * @return int 1 if OK, 0 if KO
  429. */
  430. public function remove($options = '')
  431. {
  432. $sql = array();
  433. return $this->_remove($sql, $options);
  434. }
  435. }