dolibarr  9.0.0
Public Member Functions | List of all members
DolibarrModules Class Reference

Class DolibarrModules. More...

+ Inheritance diagram for DolibarrModules:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 _init ($array_sql, $options='')
 Enables a module. More...
 
 _remove ($array_sql, $options='')
 Disable function. More...
 
 getName ()
 Gives the translated module name if translation exists in admin.lang or into language files of module. More...
 
 getDesc ()
 Gives the translated module description if translation exists in admin.lang or the default module description. More...
 
 getDescLong ()
 Gives the long description of a module. More...
 
 getDescLongReadmeFound ()
 Return path of file if a README file was found. More...
 
 getChangeLog ()
 Gives the changelog. More...
 
 getPublisher ()
 Gives the publisher name. More...
 
 getPublisherUrl ()
 Gives the publisher url. More...
 
 getVersion ($translated=1)
 Gives module version (translated if param $translated is on) For 'experimental' modules, gives 'experimental' translation For 'dolibarr' modules, gives Dolibarr version. More...
 
 isCoreOrExternalModule ()
 Tells if module is core or external. More...
 
 getLangFilesArray ()
 Gives module related language files list. More...
 
 getExportDatasetLabel ($r)
 Gives translated label of an export dataset. More...
 
 getImportDatasetLabel ($r)
 Gives translated label of an import dataset. More...
 
 getLastActivationDate ()
 Gives the last date of activation. More...
 
 getLastActivationInfo ()
 Gives the last author of activation. More...
 
 _active ()
 Insert constants for module activation. More...
 
 _unactive ()
 Module deactivation. More...
 
 _load_tables ($reldir)
 Create tables and keys required by module. More...
 
 insert_boxes ($option='')
 Adds boxes. More...
 
 delete_boxes ()
 Removes boxes. More...
 
 insert_cronjobs ()
 Adds cronjobs. More...
 
 delete_cronjobs ()
 Removes boxes. More...
 
 delete_tabs ()
 Removes tabs. More...
 
 insert_tabs ()
 Adds tabs. More...
 
 insert_const ()
 Adds constants. More...
 
 delete_const ()
 Removes constants tagged 'deleteonunactive'. More...
 
 insert_permissions ($reinitadminperms=0, $force_entity=null, $notrigger=0)
 Adds access rights. More...
 
 delete_permissions ()
 Removes access rights. More...
 
 insert_menus ()
 Adds menu entries. More...
 
 delete_menus ()
 Removes menu entries. More...
 
 create_dirs ()
 Creates directories. More...
 
 insert_dirs ($name, $dir)
 Adds directories definitions. More...
 
 delete_dirs ()
 Removes directories. More...
 
 insert_module_parts ()
 Adds generic parts. More...
 
 delete_module_parts ()
 Removes generic parts. More...
 
 init ($options='')
 Function called when module is enabled. More...
 
 remove ($options='')
 Function called when module is disabled. More...
 

Detailed Description

Class DolibarrModules.

Parent class for module descriptor class files

Definition at line 36 of file DolibarrModules.class.php.

Constructor & Destructor Documentation

◆ __construct()

DolibarrModules::__construct (   $db)

Constructor.

Define names, constants, directories, boxes, permissions

Parameters
DoliDB$dbDatabase handler

Definition at line 362 of file DolibarrModules.class.php.

Member Function Documentation

◆ _active()

DolibarrModules::_active ( )

Insert constants for module activation.

Returns
int Error count (0 if OK)

Definition at line 943 of file DolibarrModules.class.php.

◆ _init()

DolibarrModules::_init (   $array_sql,
  $options = '' 
)

Enables a module.

Inserts all informations into database

Parameters
array$array_sqlSQL requests to be executed when enabling module
string$optionsString with options when disabling module:
  • 'noboxes' = Do not insert boxes - 'newboxdefonly' = For boxes, insert def of boxes only and not boxes activation
Returns
int 1 if OK, 0 if KO

Definition at line 384 of file DolibarrModules.class.php.

◆ _load_tables()

DolibarrModules::_load_tables (   $reldir)

Create tables and keys required by module.

Files module.sql and module.key.sql with create table and create keys commands must be stored in directory reldir='/module/sql/' This function is called by this->init

Parameters
string$reldirRelative directory where to scan files
Returns
int <=0 if KO, >0 if OK

Definition at line 1013 of file DolibarrModules.class.php.

Referenced by modResource\loadTables().

◆ _remove()

DolibarrModules::_remove (   $array_sql,
  $options = '' 
)

Disable function.

Deletes the module constants and boxes from the database.

Parameters
string[]$array_sql SQL requests to be executed when module is disabled
string$optionsOptions when disabling module:
Returns
int 1 if OK, 0 if KO

Definition at line 477 of file DolibarrModules.class.php.

◆ _unactive()

DolibarrModules::_unactive ( )

Module deactivation.

Returns
int Error count (0 if OK)

Definition at line 983 of file DolibarrModules.class.php.

◆ create_dirs()

DolibarrModules::create_dirs ( )

Creates directories.

Returns
int Error count (0 if OK)

Definition at line 1957 of file DolibarrModules.class.php.

◆ delete_boxes()

DolibarrModules::delete_boxes ( )

Removes boxes.

Returns
int Error count (0 if OK)

Definition at line 1228 of file DolibarrModules.class.php.

◆ delete_const()

DolibarrModules::delete_const ( )

Removes constants tagged 'deleteonunactive'.

Returns
int <0 if KO, 0 if OK

Definition at line 1614 of file DolibarrModules.class.php.

◆ delete_cronjobs()

DolibarrModules::delete_cronjobs ( )

Removes boxes.

Returns
int Error count (0 if OK)

Definition at line 1419 of file DolibarrModules.class.php.

◆ delete_dirs()

DolibarrModules::delete_dirs ( )

Removes directories.

Returns
int Error count (0 if OK)

Definition at line 2061 of file DolibarrModules.class.php.

◆ delete_menus()

DolibarrModules::delete_menus ( )

Removes menu entries.

Returns
int Error count (0 if OK)

Definition at line 1927 of file DolibarrModules.class.php.

◆ delete_module_parts()

DolibarrModules::delete_module_parts ( )

Removes generic parts.

Returns
int Error count (0 if OK)

Definition at line 2164 of file DolibarrModules.class.php.

◆ delete_permissions()

DolibarrModules::delete_permissions ( )

Removes access rights.

Returns
int Error count (0 if OK)

Definition at line 1797 of file DolibarrModules.class.php.

◆ delete_tabs()

DolibarrModules::delete_tabs ( )

Removes tabs.

Returns
int Error count (0 if OK)

Definition at line 1450 of file DolibarrModules.class.php.

◆ getChangeLog()

DolibarrModules::getChangeLog ( )

Gives the changelog.

First check ChangeLog-la_LA.md then ChangeLog.md

Returns
string Content of ChangeLog

Definition at line 713 of file DolibarrModules.class.php.

◆ getDesc()

DolibarrModules::getDesc ( )

Gives the translated module description if translation exists in admin.lang or the default module description.

Returns
string Translated module description

Definition at line 588 of file DolibarrModules.class.php.

◆ getDescLong()

DolibarrModules::getDescLong ( )

Gives the long description of a module.

First check README-la_LA.md then README.md If no markdown files found, it returns translated value of the key ->descriptionlong.

Returns
string Long description of a module from README.md of from property.

Definition at line 624 of file DolibarrModules.class.php.

◆ getDescLongReadmeFound()

DolibarrModules::getDescLongReadmeFound ( )

Return path of file if a README file was found.

Returns
string Path of file if a README file was found.

Definition at line 678 of file DolibarrModules.class.php.

◆ getExportDatasetLabel()

DolibarrModules::getExportDatasetLabel (   $r)

Gives translated label of an export dataset.

Parameters
int$rDataset index
Returns
string Translated databaset label

Definition at line 838 of file DolibarrModules.class.php.

◆ getImportDatasetLabel()

DolibarrModules::getImportDatasetLabel (   $r)

Gives translated label of an import dataset.

Parameters
int$rDataset index
Returns
string Translated dataset label

Definition at line 862 of file DolibarrModules.class.php.

◆ getLangFilesArray()

DolibarrModules::getLangFilesArray ( )

Gives module related language files list.

Returns
string[] Language files list

Definition at line 826 of file DolibarrModules.class.php.

◆ getLastActivationDate()

DolibarrModules::getLastActivationDate ( )

Gives the last date of activation.

Returns
timestamp Date of last activation

Definition at line 885 of file DolibarrModules.class.php.

◆ getLastActivationInfo()

DolibarrModules::getLastActivationInfo ( )

Gives the last author of activation.

Returns
array Array array('authorid'=>Id of last activation user, 'lastactivationdate'=>Date of last activation)

Definition at line 912 of file DolibarrModules.class.php.

◆ getName()

DolibarrModules::getName ( )

Gives the translated module name if translation exists in admin.lang or into language files of module.

Otherwise return the module key name.

Returns
string Translated module name

Definition at line 552 of file DolibarrModules.class.php.

◆ getPublisher()

DolibarrModules::getPublisher ( )

Gives the publisher name.

Returns
string Publisher name

Definition at line 758 of file DolibarrModules.class.php.

◆ getPublisherUrl()

DolibarrModules::getPublisherUrl ( )

Gives the publisher url.

Returns
string Publisher url

Definition at line 768 of file DolibarrModules.class.php.

◆ getVersion()

DolibarrModules::getVersion (   $translated = 1)

Gives module version (translated if param $translated is on) For 'experimental' modules, gives 'experimental' translation For 'dolibarr' modules, gives Dolibarr version.

Parameters
int$translated1=Special version keys are translated, 0=Special version keys are not translated
Returns
string Module version

Definition at line 781 of file DolibarrModules.class.php.

◆ init()

DolibarrModules::init (   $options = '')

Function called when module is enabled.

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

Parameters
string$optionsOptions when enabling module ('', 'newboxdefonly', 'noboxes') 'noboxes' = Do not insert boxes 'newboxdefonly' = For boxes, insert def of boxes only and not boxes activation
Returns
int 1 if OK, 0 if KO

Definition at line 2203 of file DolibarrModules.class.php.

◆ insert_boxes()

DolibarrModules::insert_boxes (   $option = '')

Adds boxes.

Parameters
string$optionOptions when disabling module ('newboxdefonly'=insert only boxes definition)
Returns
int Error count (0 if OK)

Definition at line 1130 of file DolibarrModules.class.php.

◆ insert_const()

DolibarrModules::insert_const ( )

Adds constants.

Returns
int Error count (0 if OK)

Definition at line 1542 of file DolibarrModules.class.php.

◆ insert_cronjobs()

DolibarrModules::insert_cronjobs ( )

Adds cronjobs.

Returns
int Error count (0 if OK)

Definition at line 1301 of file DolibarrModules.class.php.

◆ insert_dirs()

DolibarrModules::insert_dirs (   $name,
  $dir 
)

Adds directories definitions.

Parameters
string$nameName
string$dirDirectory
Returns
int Error count (0 if OK)

Definition at line 2020 of file DolibarrModules.class.php.

◆ insert_menus()

DolibarrModules::insert_menus ( )

Adds menu entries.

Returns
int Error count (0 if OK)

Definition at line 1823 of file DolibarrModules.class.php.

◆ insert_module_parts()

DolibarrModules::insert_module_parts ( )

Adds generic parts.

Returns
int Error count (0 if OK)

Definition at line 2087 of file DolibarrModules.class.php.

◆ insert_permissions()

DolibarrModules::insert_permissions (   $reinitadminperms = 0,
  $force_entity = null,
  $notrigger = 0 
)

Adds access rights.

Parameters
int$reinitadminpermsIf 1, we also grant them to all admin users
int$force_entityForce current entity
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Error count (0 if OK)

Definition at line 1653 of file DolibarrModules.class.php.

◆ insert_tabs()

DolibarrModules::insert_tabs ( )

Adds tabs.

Returns
int Error count (0 if ok)

Definition at line 1476 of file DolibarrModules.class.php.

◆ isCoreOrExternalModule()

DolibarrModules::isCoreOrExternalModule ( )

Tells if module is core or external.

Returns
string 'core', 'external' or 'unknown'

Definition at line 807 of file DolibarrModules.class.php.

◆ remove()

DolibarrModules::remove (   $options = '')

Function called when module is disabled.

The remove function removes tabs, constants, boxes, permissions and menus from Dolibarr database. Data directories are not deleted

Parameters
string$optionsOptions when enabling module ('', 'noboxes')
Returns
int 1 if OK, 0 if KO

Definition at line 2216 of file DolibarrModules.class.php.


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