dolibarr
19.0.0-dev
|
Class DolibarrModules. More...
Public Member Functions | |
__construct ($db) | |
Constructor. 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... | |
getModulePosition () | |
Gives the module position. 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... | |
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... | |
getKanbanView ($codeenabledisable='', $codetoconfig='') | |
Return Kanban view of a module. More... | |
checkForUpdate () | |
Check for module update TODO : store results for $this->url_last_version and $this->needUpdate Add a cron task to monitor for updates. More... | |
Public Attributes | |
$lastVersion = '' | |
Module last version. | |
$needUpdate = false | |
true indicate this module need update | |
Protected Member Functions | |
_init ($array_sql, $options='') | |
Enables a module. More... | |
_remove ($array_sql, $options='') | |
Disable function. More... | |
_active () | |
Insert constants for module activation. More... | |
_unactive () | |
Module deactivation. More... | |
_load_tables ($reldir, $onlywithsuffix='') | |
Create tables and keys required by module: More... | |
Class DolibarrModules.
Parent class for module descriptor class files
Definition at line 37 of file DolibarrModules.class.php.
DolibarrModules::__construct | ( | $db | ) |
Constructor.
Define names, constants, directories, boxes, permissions
Reimplemented in modAgenda, modCommande, modProduct, modSalaries, modAdherent, modDataPolicy, modFacture, modFicheinter, modHoliday, modProjet, modSociete, modBanque, modComptabilite, modExpedition, modFournisseur, modPartnership, modPropale, modService, modSupplierProposal, modTax, modDon, modOauth, modPaymentByBankTransfer, modReceiptPrinter, modStock, modApi, modBom, modCategorie, modDocumentGeneration, modECM, modExport, modExternalSite, modFckeditor, modMailing, modPrelevement, modPrinting, modBarcode, modBookmark, modClickToDial, modContrat, modCron, modEventOrganization, modExternalRss, modFTP, modKnowledgeManagement, modLabel, modMailmanSpip, modMrp, modMultiCurrency, modProductBatch, modRecruitment, modResource, modStockTransfer, modSyslog, modUser, modVariants, modWorkstation, modMyModule, modAccounting, modAsset, modBookCal, modDebugBar, modDeplacement, modGeoIPMaxmind, modHRM, modImport, modIncoterm, modLdap, modLoan, modNotification, modOpenSurvey, modPaypal, modReception, modTakePos, modTicket, modWebhook, modWorkflow, modZapier, modCollab, modDav, modDynamicPrices, modEmailCollector, modExpenseReport, modGravatar, modIntracommreport, modPaybox, modSocialNetworks, modStripe, modWebsite, modMargin, modModuleBuilder, modWebServices, modWebServicesClient, and modBlockedLog.
Definition at line 415 of file DolibarrModules.class.php.
|
protected |
Insert constants for module activation.
Definition at line 1039 of file DolibarrModules.class.php.
|
protected |
Enables a module.
Inserts all informations into database.
array | $array_sql | SQL requests to be executed when enabling module |
string | $options | String with options when disabling module:
|
Definition at line 436 of file DolibarrModules.class.php.
|
protected |
Create tables and keys required by module:
string | $reldir | Relative directory where to scan files. Example: '/install/mysql/' or '/module/sql/' |
string | $onlywithsuffix | Only with the defined suffix |
Definition at line 1126 of file DolibarrModules.class.php.
|
protected |
Disable function.
Deletes the module constants and boxes from the database.
string[] | $array_sql | SQL requests to be executed when module is disabled |
string | $options | Options when disabling module: |
Definition at line 535 of file DolibarrModules.class.php.
|
protected |
Module deactivation.
Definition at line 1089 of file DolibarrModules.class.php.
DolibarrModules::checkForUpdate | ( | ) |
Check for module update TODO : store results for $this->url_last_version and $this->needUpdate Add a cron task to monitor for updates.
Definition at line 2500 of file DolibarrModules.class.php.
DolibarrModules::create_dirs | ( | ) |
Creates directories.
Definition at line 2136 of file DolibarrModules.class.php.
DolibarrModules::delete_boxes | ( | ) |
Removes boxes.
Definition at line 1405 of file DolibarrModules.class.php.
DolibarrModules::delete_const | ( | ) |
Removes constants tagged 'deleteonunactive'.
Definition at line 1806 of file DolibarrModules.class.php.
DolibarrModules::delete_cronjobs | ( | ) |
Removes boxes.
Definition at line 1613 of file DolibarrModules.class.php.
DolibarrModules::delete_dirs | ( | ) |
Removes directories.
Definition at line 2243 of file DolibarrModules.class.php.
DolibarrModules::delete_menus | ( | ) |
Removes menu entries.
Definition at line 2106 of file DolibarrModules.class.php.
DolibarrModules::delete_module_parts | ( | ) |
Removes generic parts.
Definition at line 2343 of file DolibarrModules.class.php.
DolibarrModules::delete_permissions | ( | ) |
Removes access rights.
Definition at line 1979 of file DolibarrModules.class.php.
DolibarrModules::delete_tabs | ( | ) |
Removes tabs.
Definition at line 1644 of file DolibarrModules.class.php.
DolibarrModules::getChangeLog | ( | ) |
Gives the changelog.
First check ChangeLog-la_LA.md then ChangeLog.md
Definition at line 774 of file DolibarrModules.class.php.
DolibarrModules::getDesc | ( | ) |
Gives the translated module description if translation exists in admin.lang or the default module description.
Definition at line 651 of file DolibarrModules.class.php.
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.
Definition at line 685 of file DolibarrModules.class.php.
DolibarrModules::getDescLongReadmeFound | ( | ) |
Return path of file if a README file was found.
Definition at line 739 of file DolibarrModules.class.php.
DolibarrModules::getExportDatasetLabel | ( | $r | ) |
Gives translated label of an export dataset.
int | $r | Dataset index |
Definition at line 926 of file DolibarrModules.class.php.
DolibarrModules::getImportDatasetLabel | ( | $r | ) |
Gives translated label of an import dataset.
int | $r | Dataset index |
Definition at line 948 of file DolibarrModules.class.php.
DolibarrModules::getKanbanView | ( | $codeenabledisable = '' , |
|
$codetoconfig = '' |
|||
) |
Return Kanban view of a module.
string | $codeenabledisable | HTML code for button to enable/disable module |
string | $codetoconfig | HTML code to go to config page |
Definition at line 2409 of file DolibarrModules.class.php.
DolibarrModules::getLangFilesArray | ( | ) |
Gives module related language files list.
Definition at line 914 of file DolibarrModules.class.php.
DolibarrModules::getLastActivationDate | ( | ) |
Gives the last date of activation.
Definition at line 969 of file DolibarrModules.class.php.
DolibarrModules::getLastActivationInfo | ( | ) |
Gives the last author of activation.
Definition at line 999 of file DolibarrModules.class.php.
DolibarrModules::getModulePosition | ( | ) |
Gives the module position.
Definition at line 871 of file DolibarrModules.class.php.
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.
Definition at line 617 of file DolibarrModules.class.php.
DolibarrModules::getPublisher | ( | ) |
Gives the publisher name.
Definition at line 817 of file DolibarrModules.class.php.
DolibarrModules::getPublisherUrl | ( | ) |
Gives the publisher url.
Definition at line 827 of file DolibarrModules.class.php.
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.
int | $translated | 1=Special version keys are translated, 0=Special version keys are not translated |
Definition at line 840 of file DolibarrModules.class.php.
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
string | $options | Options when enabling module ('', 'newboxdefonly', 'noboxes', 'menuonly') 'noboxes' = Do not insert boxes 'newboxdefonly' = For boxes, insert def of boxes only and not boxes activation |
Reimplemented in modProduct, modSociete, modFournisseur, modService, modFacture, modCategorie, modBookCal, modPropale, modWebhook, modStock, modBom, modCommande, modMyModule, modAdherent, modEventOrganization, modStockTransfer, modMrp, modKnowledgeManagement, modPartnership, modRecruitment, modWorkstation, modTicket, modProjet, modUser, modExpedition, modResource, modHoliday, modHRM, modMultiCurrency, modTakePos, modZapier, modReception, modDav, modBanque, modExpenseReport, modAsset, modContrat, modFicheinter, modApi, modDataPolicy, modEmailCollector, modTax, modOpenSurvey, modSalaries, modBlockedLog, modWebsite, modDeplacement, modMailing, modLoan, modWorkflow, modSupplierProposal, modDon, modBarcode, modPrelevement, modIntracommreport, modPaymentByBankTransfer, modOauth, modReceiptPrinter, modProductBatch, modComptabilite, modDocumentGeneration, modLabel, modDebugBar, modNotification, and modExternalRss.
Definition at line 2383 of file DolibarrModules.class.php.
DolibarrModules::insert_boxes | ( | $option = '' | ) |
Adds boxes.
string | $option | Options when disabling module ('newboxdefonly'=insert only boxes definition) |
Definition at line 1307 of file DolibarrModules.class.php.
DolibarrModules::insert_const | ( | ) |
Adds constants.
Definition at line 1737 of file DolibarrModules.class.php.
DolibarrModules::insert_cronjobs | ( | ) |
Adds cronjobs.
Definition at line 1479 of file DolibarrModules.class.php.
DolibarrModules::insert_dirs | ( | $name, | |
$dir | |||
) |
Adds directories definitions.
string | $name | Name |
string | $dir | Directory |
Definition at line 2204 of file DolibarrModules.class.php.
DolibarrModules::insert_menus | ( | ) |
Adds menu entries.
Definition at line 2005 of file DolibarrModules.class.php.
DolibarrModules::insert_module_parts | ( | ) |
Adds generic parts.
Definition at line 2269 of file DolibarrModules.class.php.
DolibarrModules::insert_permissions | ( | $reinitadminperms = 0 , |
|
$force_entity = null , |
|||
$notrigger = 0 |
|||
) |
Adds access rights.
int | $reinitadminperms | If 1, we also grant them to all admin users |
int | $force_entity | Force current entity |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1845 of file DolibarrModules.class.php.
DolibarrModules::insert_tabs | ( | ) |
Adds tabs.
Definition at line 1670 of file DolibarrModules.class.php.
DolibarrModules::isCoreOrExternalModule | ( | ) |
Tells if module is core or external.
'dolibarr' and 'dolibarr_deprecated' is core 'experimental' and 'development' is core
Definition at line 891 of file DolibarrModules.class.php.
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
string | $options | Options when enabling module ('', 'noboxes') |
Reimplemented in modBookCal, modEventOrganization, modBom, modMyModule, modKnowledgeManagement, modWebhook, modStockTransfer, modPartnership, modMrp, modRecruitment, modWorkstation, modEmailCollector, modMultiCurrency, modTakePos, modZapier, modDav, modDataPolicy, modApi, modBlockedLog, modSupplierProposal, and modExternalRss.
Definition at line 2396 of file DolibarrModules.class.php.