modules_calendar_RepeatDelegate Interface Reference

A dummy interface to define the methods that can be implemented in the table delegate class to hook into the repeat methods. More...

Public Member Functions
	beforeSaveRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat, array $changes=array())
	Hook executed before a repeat record is saved (i.e. either updated or added).
	afterSaveRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat, array $changes=array())
	Hook executed after a repeat record is saved (u.e. either updated or added).
	beforeUpdateRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat, array $changes=array())
	Hook executed before a repeat record is updated.
	afterUpdateRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat, array $changes=array())
	Hook executed after a repeat record is updated.
	beforeAddRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat)
	Hook executed before a repeat record is added.
	afterAddRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat)
	Hook executed after a repeat record is added.
	beforeDeleteRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat)
	Hook executed before a repeat record is deleted.
	afterDeleteRepeat (Dataface_Record $event, modules_calendar_RepeatEvent $repeat)
	Hook executed after a repeat record is deleted.

---

Detailed Description

A dummy interface to define the methods that can be implemented in the table delegate class to hook into the repeat methods.

Definition at line 7 of file RepeatDelegate.php.

---

Member Function Documentation

afterAddRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat
	)

Hook executed after a repeat record is added.

Parameters:

Dataface_Record	$event	The event record that has been saved. This is the repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.

Returns:

void

Attention:

The afterSave() and afterInsert() delegate methods are still called as usual when repeat records are inserted. This is an additional hook that is called after the standard hooks.

afterDeleteRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat
	)

Hook executed after a repeat record is deleted.

Parameters:

Dataface_Record	$event	The repeat record that is to be deleted.
modules_calendar_RepeatEvent	$repeat	The repeat object that stores all of the information about the repeat including reference to the original record, the frequency, etc..

Attention:

The afterDelete() delegate method is still called as usual when repeat records are inserted. This is an additional hook that is called after the standard hooks.

afterSaveRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat,
		array $	changes = array()
	)

Hook executed after a repeat record is saved (u.e. either updated or added).

Parameters:

Dataface_Record	$event	The event record that has been saved. This is the repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.
array	$changes	Associative array of values that were changed in the repeat.

Returns:

void

Attention:

The afterSave() delegate method is still called as usual when repeat records are inserted. This is an additional hook that is called after the standard hooks.

afterUpdateRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat,
		array $	changes = array()
	)

Hook executed after a repeat record is updated.

Parameters:

Dataface_Record	$event	The event record that has been saved. This is the repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.
array	$changes	Associative array of values that were changed in the repeat.

Returns:

void

Attention:

The afterSave() and afterUpdate() delegate methods are still called as usual when repeat records are inserted. This is an additional hook that is called after the standard hooks.

beforeAddRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat
	)

Hook executed before a repeat record is added.

Parameters:

Dataface_Record	$event	The event record that has been saved. This is the repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.

Returns:

void

Exceptions:

Exception

Throwing an exception from this method signals the save to fail.

Attention:

The beforeSave() and beforeInsert() delegate methods are still called as usual when repeat records are inserted. This is an additional hook that is called before the standard hooks.

beforeDeleteRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat
	)

Hook executed before a repeat record is deleted.

Parameters:

Dataface_Record	$event	The repeat record that is to be deleted.
modules_calendar_RepeatEvent	$repeat	The repeat object that stores all of the information about the repeat including reference to the original record, the frequency, etc..

Exceptions:

Exception

Throwing an exception from this method signals the delete to fail.

Attention:

The beforeDelete() delegate method is still called as usual when repeat records are inserted. This is an additional hook that is called before the standard hooks.

beforeSaveRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat,
		array $	changes = array()
	)

Hook executed before a repeat record is saved (i.e. either updated or added).

Parameters:

Dataface_Record	$event	The event record that is to be inserted as a repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.
array	$changes	Optional associative array of changes that have been made and are to be updated.

Returns:

void

Exceptions:

Exception

Throwing an exception from this method signals the save to fail.

Attention:

The beforeSave() delegate method is still called as usual when repeat records are inserted. This is an additional hook that is called before the standard hooks.

beforeUpdateRepeat	(	Dataface_Record $	event,
		modules_calendar_RepeatEvent $	repeat,
		array $	changes = array()
	)

Hook executed before a repeat record is updated.

Parameters:

Dataface_Record	$event	The event record that has been saved. This is the repeat.
modules_calendar_RepeatEvent	$repeat	The repeat record containing all of the details about the repeat including a reference to the source record.
array	$changes	Associative array of values that were changed in the repeat.

Returns:

void

Exceptions:

Exception

Throwing an exception from this method signals the save to fail.

Attention:

The beforeSave() and beforeUpdate() delegate methods are still called as usual when repeat records are inserted. This is an additional hook that is called before the standard hooks.

---

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

• /Applications/XAMPP/xamppfiles/htdocs/nanofabrication/modules/calendar/classes/RepeatDelegate.php