modReception Class Reference

Class to describe and enable module Reception. More...

Inheritance diagram for modReception:

Collaboration diagram for modReception:

Public Member Functions
	__construct ($db)
	Constructor.
	init ($options='')
	Function called when module is enabled.
Public Member Functions inherited from DolibarrModules
	getName ()
	Gives the translated module name if translation exists in admin.lang or into language files of module.
	getDesc ()
	Gives the translated module description if translation exists in admin.lang or the default module description.
	getDescLong ()
	Gives the long description of a module.
	getDescLongReadmeFound ()
	Return path of file if a README file was found.
	getChangeLog ()
	Gives the changelog.
	getPublisher ()
	Gives the publisher name.
	getPublisherUrl ()
	Gives the publisher url.
	getVersion ($translated=1)
	Gives module version (translated if param $translated is on) For 'experimental' modules, gives 'experimental' translation For 'dolibarr' modules, gives Dolibarr version.
	getModulePosition ()
	Gives the module position.
	isCoreOrExternalModule ()
	Tells if module is core or external.
	getLangFilesArray ()
	Gives module related language files list.
	getExportDatasetLabel ($r)
	Gives translated label of an export dataset.
	getImportDatasetLabel ($r)
	Gives translated label of an import dataset.
	getLastActivationDate ()
	Gives the last date of activation.
	getLastActivationInfo ()
	Gives the last author of activation.
	insert_boxes ($option='')
	Adds boxes.
	delete_boxes ()
	Removes boxes.
	insert_cronjobs ()
	Adds cronjobs.
	delete_cronjobs ()
	Removes boxes.
	delete_tabs ()
	Removes tabs.
	insert_tabs ()
	Adds tabs.
	insert_const ()
	Adds constants.
	delete_const ()
	Removes constants tagged 'deleteonunactive'.
	insert_permissions ($reinitadminperms=0, $force_entity=null, $notrigger=0)
	Adds access rights.
	delete_permissions ()
	Removes access rights.
	insert_menus ()
	Adds menu entries.
	delete_menus ()
	Removes menu entries.
	create_dirs ()
	Creates directories.
	insert_dirs ($name, $dir)
	Adds directories definitions.
	delete_dirs ()
	Removes directories.
	insert_module_parts ()
	Adds generic parts.
	delete_module_parts ()
	Removes generic parts.
	remove ($options='')
	Function called when module is disabled.
	getKanbanView ($codeenabledisable='', $codetoconfig='')
	Return Kanban view of a module.
	checkForUpdate ()
	Check for module update TODO : store results for $this->url_last_version and $this->needUpdate Add a cron task to monitor for updates.
	checkForCompliance ()
	Check for module compliance with Dolibarr rules and law If a module is reported by this function,it is surely a malware.

Additional Inherited Members
Public Attributes inherited from DolibarrModules
	$lastVersion = ''
	Module last version.
	$needUpdate = false
	true indicate this module need update
Protected Member Functions inherited from DolibarrModules
	_init ($array_sql, $options='')
	Enables a module.
	_remove ($array_sql, $options='')
	Disable function.
	_active ()
	Insert constants for module activation.
	_unactive ()
	Module deactivation.
	_load_tables ($reldir, $onlywithsuffix='')
	Create tables and keys required by module:

Detailed Description

Class to describe and enable module Reception.

Definition at line 33 of file modReception.class.php.

Constructor & Destructor Documentation

__construct()

modReception::__construct

(

$db

)

Constructor.

Define names, constants, directories, boxes, permissions

Parameters

DoliDB

$db

Database handler

Reimplemented from DolibarrModules.

Definition at line 40 of file modReception.class.php.

References description, getDolGlobalString(), and name.

Member Function Documentation

init()

modReception::init

(

$options = ''

)

Function called when module is enabled.

The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. It also creates data directories

Parameters

string

$options

Options when enabling module ('', 'noboxes')

Returns

int 1 if OK, 0 if KO

Reimplemented from DolibarrModules.

Definition at line 260 of file modReception.class.php.

References DolibarrModules\_init(), dol_copy(), and dol_mkdir().

---

The documentation for this class was generated from the following file:

• dolibarr_19.0/htdocs/core/modules/modReception.class.php