spunQ_IDatabaseListener Interface Reference

Observer interface for database actions. More...

Inheritance diagram for spunQ_IDatabaseListener:

List of all members.

Public Member Functions
	executingSelectQuery (spunQ_IDatabaseConnection $connection, spunQ_SelectQuery $query, array $queryParams=array())
	Called before a select query is executed.
	executedSelectQuery (spunQ_IDatabaseConnection $connection, spunQ_SelectQuery $query, array &$result, array $queryParams=array())
	Called after a select query was executed.
	executingUpdateQuery (spunQ_IDatabaseConnection $connection, spunQ_UpdateQuery $query, array $queryParams=array())
	Called before an update query is executed.
	executedUpdateQuery (spunQ_IDatabaseConnection $connection, spunQ_UpdateQuery $query, &$result, array $queryParams=array())
	Called after an update query was executed.
	executingDeleteQuery (spunQ_IDatabaseConnection $connection, spunQ_DeleteQuery $query, array $queryParams=array())
	Called before a delete query is executed.
	executedDeleteQuery (spunQ_IDatabaseConnection $connection, spunQ_DeleteQuery $query, &$result, array $queryParams=array())
	Called after a delete query was executed.
	executingInsertQuery (spunQ_IDatabaseConnection $connection, spunQ_InsertQuery $query)
	Called before an insert query is executed.
	executedInsertQuery (spunQ_IDatabaseConnection $connection, spunQ_InsertQuery $query, &$result)
	Called before after an insert query was executed.
	creatingTypeStorage (spunQ_IDatabaseConnection $connection, spunQ_UserType $type)
	Called before a type storage is created.
	createdTypeStorage (spunQ_IDatabaseConnection $connection, spunQ_ITypeStorage $storage)
	Called after a type storage is created.
	creatingTypeMemberStorage (spunQ_IDatabaseConnection $connection, spunQ_Member $member)
	Called before a type member storage is created.
	createdTypeMemberStorage (spunQ_IDatabaseConnection $connection, spunQ_ITypeMemberStorage $storage)
	Called after a type member storage is created.
	deletingTypeMemberStorage (spunQ_IDatabaseConnection $connection, spunQ_ITypeMemberStorage $storage)
	Called before a type member storage is deleted.
	deletedTypeMemberStorage (spunQ_IDatabaseConnection $connection, spunQ_ITypeMemberStorage $storage)
	Called after a type member storage is deleted.

---

Detailed Description

Observer interface for database actions.

All functions containing a present participle indicate that the action was not performed yet. Functions having the past participle are called after the operation was finished. The following statements are called when a select query is being performed:

• spunQ_IDatabaseConnection::executeSelectQuery() is entered
• spunQ_IDatabaseListener::executingSelectQuery() is called
• The select query is executed
• spunQ_IDatabaseListener::executedSelectQuery() is called with the result of the query as parameter.
• The select query is returned, leaving the scope of spunQ_IDatabaseConnection::executeSelectQuery()

Note that it is not guaranteed that the post-processing functions (the ones using the past participle) are called. The operation might generate an exception, which would cause the actual function to exit prematurely.

Definition at line 21 of file IDatabaseListener.interface.php.

---

Member Function Documentation

spunQ_IDatabaseListener::createdTypeMemberStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_ITypeMemberStorage $	storage
	)

Called after a type member storage is created.

Parameters:

	$connection	The connection that triggered this event.
	$storage	The storage that was created.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::createdTypeStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_ITypeStorage $	storage
	)

Called after a type storage is created.

Parameters:

	$connection	The connection that triggered this event.
	$storage	The storage that was created.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::creatingTypeMemberStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_Member $	member
	)

Called before a type member storage is created.

See also:

spunQ_IDatabaseConnection::createTypeMemberStorage()

Parameters:

	$connection	The connection that triggered this event.
	$member	The type member to create type storage for.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::creatingTypeStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_UserType $	type
	)

Called before a type storage is created.

See also:

spunQ_IDatabaseConnection::createTypeStorage()

Parameters:

	$connection	The connection that triggered this event.
	$type	The type to create type storage for.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::deletedTypeMemberStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_ITypeMemberStorage $	storage
	)

Called after a type member storage is deleted.

See also:

spunQ_IDatabaseConnection::createTypeMemberStorage()

Parameters:

	$connection	The connection that triggered this event.
	$storage	The storage that was deleted.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::deletingTypeMemberStorage	(	spunQ_IDatabaseConnection $	connection,
		spunQ_ITypeMemberStorage $	storage
	)

Called before a type member storage is deleted.

See also:

spunQ_IDatabaseConnection::createTypeMemberStorage()

Parameters:

	$connection	The connection that triggered this event.
	$storage	The storage that will be deleted.

Returns:

void.

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executedDeleteQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_DeleteQuery $	query,
		&$	result,
		array $	queryParams = array()
	)

Called after a delete query was executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that was executed.
	$result	The result array.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executedInsertQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_InsertQuery $	query,
		&$	result
	)

Called before after an insert query was executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that was executed.
	$result	The result array.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executedSelectQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_SelectQuery $	query,
		array &$	result,
		array $	queryParams = array()
	)

Called after a select query was executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that was executed.
	$result	The result array.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executedUpdateQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_UpdateQuery $	query,
		&$	result,
		array $	queryParams = array()
	)

Called after an update query was executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that was executed.
	$result	The result array.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executingDeleteQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_DeleteQuery $	query,
		array $	queryParams = array()
	)

Called before a delete query is executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that is about to be executed.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executingInsertQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_InsertQuery $	query
	)

Called before an insert query is executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that is about to be executed.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executingSelectQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_SelectQuery $	query,
		array $	queryParams = array()
	)

Called before a select query is executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that is about to be executed.

Returns:

void

Implemented in spunQ_GroupCreator.

spunQ_IDatabaseListener::executingUpdateQuery	(	spunQ_IDatabaseConnection $	connection,
		spunQ_UpdateQuery $	query,
		array $	queryParams = array()
	)

Called before an update query is executed.

Parameters:

	$connection	The connection that triggered this event.
	$query	The query that is about to be executed.

Returns:

void

Implemented in spunQ_GroupCreator.

---

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

• IDatabaseListener.interface.php