modBlockedLog Class Reference

Class to describe a BlockedLog module. More...

Inheritance diagram for modBlockedLog:

Collaboration diagram for modBlockedLog:

Public Member Functions
	__construct ($db)
	Constructor.
	alreadyUsed ()
	Check if module was already used before unactivation linked to warnings_unactivation property.
	init ($options='')
	Function called when module is enabled.
	remove ($options='')
	Function called when module is disabled.
	getDesc ($foruseinpopupdesc=0)
	Overwrite the common getDesc() method.
Public Member Functions inherited from DolibarrModules
	getName ()
	Gives the translated module name if translation exists in admin.lang or into language files of module.
	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 ()
	Save configuration for generic features.
	delete_module_parts ()
	Removes generic parts.
	getKanbanView ($codeenabledisable='', $codetoconfig='')
	Return Kanban view of a module.
	checkForUpdate ()
	Check for module update.
	checkForCompliance ($nametocheck='')
	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
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:
	declareNewDictionary ($dictionaryArray, $langs='')
	Helper method to declare dictionaries one at a time (rather than declaring dictionaries property by property).

Detailed Description

Class to describe a BlockedLog module.

Definition at line 32 of file modBlockedLog.class.php.

Constructor & Destructor Documentation

__construct()

modBlockedLog::__construct

(

$db

)

Constructor.

Define names, constants, directories, boxes, permissions

Parameters

DoliDB

$db

Database handler

Reimplemented from DolibarrModules.

Definition at line 39 of file modBlockedLog.class.php.

References $mysoc, alreadyUsed(), description, getDolGlobalString(), img_picto(), isModEnabled(), and name.

Member Function Documentation

alreadyUsed()

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 152 of file modBlockedLog.class.php.

References isBlockedLogUsed().

Referenced by __construct().

getDesc()

modBlockedLog::getDesc

(

$foruseinpopupdesc = 0

)

Overwrite the common getDesc() method.

Parameters

int<0,1>

$foruseinpopupdesc If 1, we return a short description for use into popup window

Returns

string Translated module description

Reimplemented from DolibarrModules.

Definition at line 316 of file modBlockedLog.class.php.

References info_admin(), and isALNEQualifiedVersion().

init()

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

Reimplemented from DolibarrModules.

Definition at line 168 of file modBlockedLog.class.php.

References $object, DolibarrModules\_init(), dol_now(), dol_print_error(), dolDecrypt(), dolibarr_set_const(), and getDolGlobalString().

remove()

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', 'forcedisable')

Returns

int 1 if OK, 0 if KO

Reimplemented from DolibarrModules.

Definition at line 259 of file modBlockedLog.class.php.

References $object, DolibarrModules\_remove(), dol_now(), and dol_syslog().

---

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

• dolibarr_23.0/htdocs/core/modules/modBlockedLog.class.php