Class to describe a BlockedLog module. More...
Inheritance diagram for modBlockedLog:
Collaboration diagram for modBlockedLog:
Public Member Functions | |
| __construct ($db) | |
| Constructor. More... | |
| alreadyUsed () | |
| Check if module was already used before unactivation linked to warnings_unactivation property. More... | |
| init ($options= '') | |
| Function called when module is enabled. More... | |
| remove ($options= '') | |
| Function called when module is disabled. More... | |
| Public Member Functions inherited from DolibarrModules | |
| __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... | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from DolibarrModules | |
| _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) | |
| Create tables and keys required by module. More... | |
Detailed Description
Class to describe a BlockedLog module.
Definition at line 30 of file modBlockedLog.class.php.
Constructor & Destructor Documentation
| modBlockedLog::__construct | ( | $db | ) |
Constructor.
Define names, constants, directories, boxes, permissions
Definition at line 37 of file modBlockedLog.class.php.
References alreadyUsed(), db, description, and name.
Member Function Documentation
| modBlockedLog::alreadyUsed | ( | ) |
Check if module was already used before unactivation linked to warnings_unactivation property.
- Returns
- boolean True if already used, otherwise False
Definition at line 148 of file modBlockedLog.class.php.
References db.
Referenced by __construct().
| modBlockedLog::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
Definition at line 164 of file modBlockedLog.class.php.
References DolibarrModules\_init(), db, and dol_now().
| modBlockedLog::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 $options Options when enabling module ('', 'noboxes')
- Returns
- int 1 if OK, 0 if KO
Definition at line 207 of file modBlockedLog.class.php.
References DolibarrModules\_remove(), db, and dol_now().
The documentation for this class was generated from the following file:
- htdocs/core/modules/modBlockedLog.class.php