ActionsDatapolicy Class Reference

Class ActionsDatapolicy. 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...
	addMoreActionsButtons ($parameters, &$object, &$action, $hookmanager)
	addMoreActionsButtons More...
	printCommonFooter ($parameters, &$object, &$action, $hookmanager)
	printCommonFooter More...

Detailed Description

Class ActionsDatapolicy.

Definition at line 28 of file actions_datapolicy.class.php.

Constructor & Destructor Documentation

__construct()

ActionsDatapolicy::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 60 of file actions_datapolicy.class.php.

References db.

Member Function Documentation

addMoreActionsButtons()

ActionsDatapolicy::addMoreActionsButtons	(		$parameters,
		&	$object,
		&	$action,
			$hookmanager
	)

addMoreActionsButtons

Parameters

array	$parameters	array of parameters
Object	$object	Object
string	$action	Actions
HookManager	$hookmanager	Hook manager

Returns

void

Definition at line 329 of file actions_datapolicy.class.php.

addMoreMassActions()

ActionsDatapolicy::addMoreMassActions	(		$parameters,
		&	$object,
		&	$action,
			$hookmanager
	)

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

Parameters

array	$parameters	Hook metadatas (context, etc...)
CommonObject	$object	The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string	$action	Current action (if set). Generally create or edit or null
HookManager	$hookmanager	Hook manager propagated to allow calling another hook

Returns

int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 272 of file actions_datapolicy.class.php.

beforePDFCreation()

ActionsDatapolicy::beforePDFCreation	(		$parameters,
		&	$object,
		&	$action
	)

Execute action.

Parameters

array	$parameters	Array of parameters
Object	$object	Object 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 301 of file actions_datapolicy.class.php.

doActions()

ActionsDatapolicy::doActions	(		$parameters,
		&	$object,
		&	$action,
			$hookmanager
	)

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

Parameters

array	$parameters	Hook metadatas (context, etc...)
CommonObject	$object	The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string	$action	Current action (if set). Generally create or edit or null
HookManager	$hookmanager	Hook manager propagated to allow calling another hook

Returns

int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 91 of file actions_datapolicy.class.php.

doMassActions()

ActionsDatapolicy::doMassActions	(		$parameters,
		&	$object,
		&	$action,
			$hookmanager
	)

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

Parameters

array	$parameters	Hook metadatas (context, etc...)
CommonObject	$object	The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
string	$action	Current action (if set). Generally create or edit or null
HookManager	$hookmanager	Hook manager propagated to allow calling another hook

Returns

int < 0 on error, 0 on success, 1 to replace standard code

Definition at line 239 of file actions_datapolicy.class.php.

getNomUrl()

ActionsDatapolicy::getNomUrl	(		$parameters,
		&	$object,
		&	$action
	)

Execute action.

Parameters

array	$parameters	Array of parameters
CommonObject	$object	The 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 75 of file actions_datapolicy.class.php.

printCommonFooter()

ActionsDatapolicy::printCommonFooter	(		$parameters,
		&	$object,
		&	$action,
			$hookmanager
	)

printCommonFooter

Parameters

array	$parameters	array of parameters
Object	$object	Object
string	$action	Actions
HookManager	$hookmanager	Hook manager

Returns

int

Definition at line 387 of file actions_datapolicy.class.php.

---

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

• htdocs/datapolicy/class/actions_datapolicy.class.php