Ibuildings - Docs For Class atkActionListener

Docs For Class atkActionListener

Home

Documentation home

Atk index

Docs For Class atkActionListener [ package: atk ]

Class: atkActionListener

Source Location: /utils/class.atkactionlistener.inc

Class atkActionListener

Class Overview

The atkActionListener baseclass for handling ATK events.

The most useful purpose of the atkActionListener is to serve as a base class for custom action listeners. Extend this class and override only the notify($action, $record) method. Using atkNode::addListener you can add listeners that catch evens such as records updates and additions. This is much like the classic atk postUpdate/postAdd triggers, only much more flexible.

Located in /utils/class.atkactionlistener.inc [line 33]

Wiki documentation

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkEventLog	The atkEventLog is a ready to use atkActionListener for logging events in a table.

[ Top ]

Property Summary

Array	$m_actionfilter	The list of actions the action listener should listen to.
atkNode	$m_node	The owning node of the listener.

[ Top ]

Method Summary

atkActionListener	atkActionListener()	Base constructor
void	actionPerformed()	Notify the listener of an action on a record.
void	notify()	Notify the listener of any action on a record.
void	preActionPerformed()	Notify the listener of an action about to be performed on a record.
void	preNotify()	Notify the listener of any action about to be performed on a record.
void	setNode()	Set the owning node of the listener.

[ Top ]

Properties

Array $m_actionfilter = array() [line 40]

The list of actions the action listener should listen to.

API Tags:

Access:

private

[ Top ]

atkNode $m_node = NULL [line 47]

The owning node of the listener.

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkActionListener [line 55]

atkActionListener atkActionListener(
[array
$actionfilter = array()] 
)

Base constructor

Parameters:

array

$actionfilter:

The list of actions to listen to

[ Top ]

actionPerformed [line 101]

void actionPerformed(
String
$action, array
$record 
)

Notify the listener of an action on a record.

This method should be overriden in custom action listeners, to catch the action event.

Parameters:

String	$action:	The action being performed
array	$record:	The record on which the action is performed

API Tags:

Abstract:

Redefined in descendants as:

atkEventLog::actionPerformed() : This method handles the storage of the action in the database.

[ Top ]

notify [line 83]

void notify(
String
$action, array
$record 
)

Notify the listener of any action on a record.

This method is called by the framework for each action called on a node. Depending on the actionfilter passed in the constructor, the call is forwarded to the actionPerformed($action, $record) method.

Parameters:

String	$action:	The action being performed
array	$record:	The record on which the action is performed

[ Top ]

preActionPerformed [line 133]

void preActionPerformed(
String
$action, 
&$record, array
$record 
)

Notify the listener of an action about to be performed on a record.

This method should be overriden in custom action listeners, to catch the action event.

Parameters:

String	$action:	The action about to be performed
array	$record:	The record on which the action is about to be performed
	&$record:

API Tags:

Abstract:

[ Top ]

preNotify [line 115]

void preNotify(
String
$action, 
&$record, array
$record 
)

Notify the listener of any action about to be performed on a record.

This method is called by the framework for each action called on a node. Depending on the actionfilter passed in the constructor, the call is forwarded to the preActionPerformed($action, $record) method.

Parameters:

String	$action:	The action about to be performed
array	$record:	The record on which the action is about to be performed
	&$record:

[ Top ]

setNode [line 68]

void setNode(

&$node, atkNode
$node 
)

Set the owning node of the listener.

When using atkNode::addListener to add a listener to a node it is not necessary to call this method as addListener will do that for you.

Parameters:

atkNode	$node:	The node to set as owner
	&$node:

[ Top ]