29include_once DOL_DOCUMENT_ROOT.
'/core/modules/DolibarrModules.class.php';
48 $this->numero = 500000;
51 $this->rights_class =
'mymodule';
55 $this->family =
"other";
58 $this->module_position =
'90';
63 $this->
name = preg_replace(
'/^mod/i',
'', get_class($this));
68 $this->descriptionlong =
"MyModuleDescription";
71 $this->editor_name =
'Editor name';
72 $this->editor_url =
'https://www.example.com';
75 $this->version =
'1.0';
80 $this->const_name =
'MAIN_MODULE_'.strtoupper($this->
name);
86 $this->picto =
'generic';
89 $this->module_parts = array(
125 'moduleforexternal' => 0,
130 $this->dirs = array(
"/mymodule/temp");
133 $this->config_page_url = array(
"setup.php@mymodule");
137 $this->hidden =
false;
139 $this->depends = array();
141 $this->requiredby = array();
143 $this->conflictwith = array();
146 $this->langfiles = array(
"mymodule@mymodule");
149 $this->phpmin = array(7, 0);
150 $this->need_dolibarr_version = array(11, -3);
151 $this->need_javascript_ajax = 0;
154 $this->warnings_activation = array();
155 $this->warnings_activation_ext = array();
164 $this->
const = array();
172 if (!isset($conf->mymodule) || !isset($conf->mymodule->enabled)) {
173 $conf->mymodule =
new stdClass();
174 $conf->mymodule->enabled = 0;
178 $this->tabs = array();
206 $this->dictionaries = array();
235 $this->boxes = array(
246 $this->cronjobs = array(
268 $this->rights = array();
295 $this->menu = array();
299 $this->menu[$r++] = array(
302 'titre'=>
'ModuleMyModuleName',
303 'prefix' =>
img_picto(
'', $this->picto,
'class="paddingright pictofixedwidth valignmiddle"'),
304 'mainmenu'=>
'mymodule',
306 'url'=>
'/mymodule/mymoduleindex.php',
307 'langs'=>
'mymodule@mymodule',
308 'position'=>1000 + $r,
309 'enabled'=>
'isModEnabled("mymodule")',
436 public function init($options =
'')
438 global $conf, $langs;
456 $this->
remove($options);
462 $myTmpObjects = array();
463 $myTmpObjects[
'MyObject'] = array(
'includerefgeneration'=>0,
'includedocgeneration'=>0);
465 foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
466 if ($myTmpObjectKey ==
'MyObject') {
469 if ($myTmpObjectArray[
'includerefgeneration']) {
470 $src = DOL_DOCUMENT_ROOT.
'/install/doctemplates/'.$moduledir.
'/template_myobjects.odt';
471 $dirodt = DOL_DATA_ROOT.
'/doctemplates/'.$moduledir;
472 $dest = $dirodt.
'/template_myobjects.odt';
474 if (file_exists($src) && !file_exists($dest)) {
475 require_once DOL_DOCUMENT_ROOT.
'/core/lib/files.lib.php';
477 $result =
dol_copy($src, $dest, 0, 0);
479 $langs->load(
"errors");
480 $this->error = $langs->trans(
'ErrorFailToCopyFile', $src, $dest);
485 $sql = array_merge($sql, array(
486 "DELETE FROM ".MAIN_DB_PREFIX.
"document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey).
"' AND type = '".$this->db->escape(strtolower($myTmpObjectKey)).
"' AND entity = ".((
int) $conf->entity),
487 "INSERT INTO ".MAIN_DB_PREFIX.
"document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey).
"', '".$this->db->escape(strtolower($myTmpObjectKey)).
"', ".((
int) $conf->entity).
")",
488 "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),
489 "INSERT INTO ".MAIN_DB_PREFIX.
"document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey).
"_odt', '".$this->db->escape(strtolower($myTmpObjectKey)).
"', ".((
int) $conf->entity).
")"
494 return $this->
_init($sql, $options);
505 public function remove($options =
'')
508 return $this->
_remove($sql, $options);
_init($array_sql, $options='')
Enables a module.
_remove($array_sql, $options='')
Disable function.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Description and activation class for module MyModule.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.