CRUDEvents Class Reference

Public Member Functions
	__construct ($controller)
	onSuccessDeleteMessage (CRUDMessage $message, $instance)
	Returns the message displayed after a deletion.
	onErrorDeleteMessage (CRUDMessage $message, $instance)
	Returns the message displayed when an error occurred when deleting.
	onConfDeleteMessage (CRUDMessage $message, $instance)
	Returns the confirmation message displayed before deleting an instance.
	onSuccessUpdateMessage (CRUDMessage $message, $instance)
	Returns the message displayed when an instance is added or inserted.
	onErrorUpdateMessage (CRUDMessage $message, $instance)
	Returns the message displayed when an error occurred when updating or inserting.
	onNotFoundMessage (CRUDMessage $message, $ids)
	Returns the message displayed when an instance does not exist.
	beforeLoadView ($viewName, &$vars)
	onDisplayElements ($dataTable, $objects, $refresh)
	Triggered after displaying objects in dataTable.
	onSuccessDeleteMultipleMessage (CRUDMessage $message, $instance)
	onErrorDeleteMultipleMessage (CRUDMessage $message)
	onConfDeleteMultipleMessage (CRUDMessage $message, $data)
	onNewInstance (object $instance)
	Triggered when a new instance is created before rendering in the form.
	onBeforeUpdate (object $instance, bool $isNew)
	Triggered before the instance updating (insert or update).
	onBeforeUpdateRequest (array &$requestValues, bool $isNew)
	Triggered before the instance updating, for POST values updating (insert or update).

Protected Attributes
	$controller

Detailed Description

Definition at line 7 of file CRUDEvents.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$controller

)

Definition at line 10 of file CRUDEvents.php.

Member Function Documentation

beforeLoadView()

beforeLoadView	(		$viewName,
		&	$vars
	)

Parameters

string	$viewName
array | null	$vars

Definition at line 85 of file CRUDEvents.php.

onBeforeUpdate()

onBeforeUpdate	(	object	$instance,
		bool	$isNew
	)

Triggered before the instance updating (insert or update).

Parameters

object	$instance
bool	$isNew

Definition at line 125 of file CRUDEvents.php.

onBeforeUpdateRequest()

onBeforeUpdateRequest	(	array &	$requestValues,
		bool	$isNew
	)

Triggered before the instance updating, for POST values updating (insert or update).

Parameters

array	$requestValues
bool	$isNew

Definition at line 134 of file CRUDEvents.php.

onConfDeleteMessage()

onConfDeleteMessage	(	CRUDMessage	$message,
			$instance
	)

Returns the confirmation message displayed before deleting an instance.

Parameters

CRUDMessage	$message
object	$instance

Returns

CRUDMessage

Definition at line 43 of file CRUDEvents.php.

onConfDeleteMultipleMessage()

onConfDeleteMultipleMessage	(	CRUDMessage	$message,
			$data
	)

Definition at line 106 of file CRUDEvents.php.

onDisplayElements()

onDisplayElements	(		$dataTable,
			$objects,
			$refresh
	)

Triggered after displaying objects in dataTable.

Parameters

DataTable	$dataTable
array	$objects
boolean	$refresh

Definition at line 95 of file CRUDEvents.php.

onErrorDeleteMessage()

onErrorDeleteMessage	(	CRUDMessage	$message,
			$instance
	)

Returns the message displayed when an error occurred when deleting.

Parameters

CRUDMessage	$message
object	$instance

Returns

CRUDMessage

Definition at line 32 of file CRUDEvents.php.

onErrorDeleteMultipleMessage()

onErrorDeleteMultipleMessage

(

CRUDMessage

$message

)

Definition at line 102 of file CRUDEvents.php.

onErrorUpdateMessage()

onErrorUpdateMessage	(	CRUDMessage	$message,
			$instance
	)

Returns the message displayed when an error occurred when updating or inserting.

Parameters

CRUDMessage	$message
object	$instance

Returns

CRUDMessage

Definition at line 65 of file CRUDEvents.php.

onNewInstance()

onNewInstance

(

object

$instance

)

Triggered when a new instance is created before rendering in the form.

Parameters

object	$instance
bool	$isNew

Definition at line 116 of file CRUDEvents.php.

onNotFoundMessage()

onNotFoundMessage	(	CRUDMessage	$message,
			$ids
	)

Returns the message displayed when an instance does not exist.

Parameters

CRUDMessage	$message
mixed	$ids

Returns

CRUDMessage

Definition at line 76 of file CRUDEvents.php.

onSuccessDeleteMessage()

onSuccessDeleteMessage	(	CRUDMessage	$message,
			$instance
	)

Returns the message displayed after a deletion.

Parameters

CRUDMessage	$message
object	$instance

Returns

CRUDMessage

Definition at line 21 of file CRUDEvents.php.

onSuccessDeleteMultipleMessage()

onSuccessDeleteMultipleMessage	(	CRUDMessage	$message,
			$instance
	)

Definition at line 98 of file CRUDEvents.php.

onSuccessUpdateMessage()

onSuccessUpdateMessage	(	CRUDMessage	$message,
			$instance
	)

Returns the message displayed when an instance is added or inserted.

Parameters

CRUDMessage	$message
object	$instance

Returns

CRUDMessage

Definition at line 54 of file CRUDEvents.php.

Field Documentation

$controller

$controller

protected

Definition at line 8 of file CRUDEvents.php.

---

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

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity/src/Ubiquity/controllers/crud/CRUDEvents.php