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

Class ActionsMyModule. More...

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNomUrl ($parameters, &$object, &$action)
 Execute action. More...
 
 doActions ($parameters, &$object, &$action, $hookmanager)
 Overloading the doActions function : replacing the parent's function with the one below. More...
 
 doMassActions ($parameters, &$object, &$action, $hookmanager)
 Overloading the doActions function : replacing the parent's function with the one below. More...
 
 addMoreMassActions ($parameters, &$object, &$action, $hookmanager)
 Overloading the addMoreMassActions function : replacing the parent's function with the one below. More...
 
 beforePDFCreation ($parameters, &$object, &$action)
 Execute action. More...
 
 afterPDFCreation ($parameters, &$pdfhandler, &$action)
 Execute action. More...
 

Detailed Description

Class ActionsMyModule.

Definition at line 29 of file actions_mymodule.class.php.

Constructor & Destructor Documentation

◆ __construct()

ActionsMyModule::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 63 of file actions_mymodule.class.php.

Member Function Documentation

◆ addMoreMassActions()

ActionsMyModule::addMoreMassActions (   $parameters,
$object,
$action,
  $hookmanager 
)

Overloading the addMoreMassActions function : replacing the parent's function with the one below.

Parameters
array$parametersHook metadatas (context, etc...)
CommonObject$objectThe object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string$actionCurrent action (if set). Generally create or edit or null
HookManager$hookmanagerHook manager propagated to allow calling another hook
Returns
int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 163 of file actions_mymodule.class.php.

◆ afterPDFCreation()

ActionsMyModule::afterPDFCreation (   $parameters,
$pdfhandler,
$action 
)

Execute action.

Parameters
array$parametersArray of parameters
Object$pdfhandlerPDF builder handler
string$action'add', 'update', 'view'
Returns
int <0 if KO, =0 if OK but we want to process standard actions too, >0 if OK and we want to replace standard actions.

Definition at line 224 of file actions_mymodule.class.php.

◆ beforePDFCreation()

ActionsMyModule::beforePDFCreation (   $parameters,
$object,
$action 
)

Execute action.

Parameters
array$parametersArray of parameters
Object$objectObject output on PDF
string$action'add', 'update', 'view'
Returns
int <0 if KO, =0 if OK but we want to process standard actions too, >0 if OK and we want to replace standard actions.

Definition at line 195 of file actions_mymodule.class.php.

◆ doActions()

ActionsMyModule::doActions (   $parameters,
$object,
$action,
  $hookmanager 
)

Overloading the doActions function : replacing the parent's function with the one below.

Parameters
array$parametersHook metadatas (context, etc...)
CommonObject$objectThe object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string$actionCurrent action (if set). Generally create or edit or null
HookManager$hookmanagerHook manager propagated to allow calling another hook
Returns
int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 95 of file actions_mymodule.class.php.

◆ doMassActions()

ActionsMyModule::doMassActions (   $parameters,
$object,
$action,
  $hookmanager 
)

Overloading the doActions function : replacing the parent's function with the one below.

Parameters
array$parametersHook metadatas (context, etc...)
CommonObject$objectThe object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string$actionCurrent action (if set). Generally create or edit or null
HookManager$hookmanagerHook manager propagated to allow calling another hook
Returns
int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 128 of file actions_mymodule.class.php.

◆ getNomUrl()

ActionsMyModule::getNomUrl (   $parameters,
$object,
$action 
)

Execute action.

Parameters
array$parametersArray of parameters
CommonObject$objectThe object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string$action'add', 'update', 'view'
Returns
int <0 if KO, =0 if OK but we want to process standard actions too, >0 if OK and we want to replace standard actions.

Definition at line 79 of file actions_mymodule.class.php.


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