Class: TimedEvent

Source Location: /_includes/lib_events.php

Class Overview

TableEntry
   |
   --TimedEvent

Describes an event that is schedudled to be run every so often.

Author(s):

Andreas Launila

Variables

Methods

Inherited Variables

Class: TableEntry

TableEntry::$id

Inherited Methods

Class: TableEntry

TableEntry::__construct(): Constructor for TableEntry.
TableEntry::getId(): Gets the unique identifier for the table entry.
TableEntry::readRow(): Processes the contents of a retrieved row that describes the entry.

Class Details

[line 45]
Describes an event that is schedudled to be run every so often.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$callback =

[line 68]

The callback that should be called when the event is to be performed.

Tags:

access:

private

Type:

string

[ Top ]

$decsription =

[line 50]

A description of the event.

Tags:

access:

private

Type:

string

[ Top ]

$libraryName =

[line 63]

The name of the library that should be included before the event is run and before the callback is called. If it's empty then no library is included.

Tags:

access:

private

Type:

string

[ Top ]

$nextTime =

[line 56]

A timestamp that describes the next point in time when the event should be performed.

Tags:

access:

private

Type:

integer

[ Top ]

$timestampFailure =

[line 74]

A timestamp pattern for the timestamp that should be used as the next point in time that the event should be triggered on failure.

Tags:

access:

private

Type:

string

[ Top ]

$timestampSuccess =

[line 80]

A timestamp pattern for the timestamp that should be used as the next point in time that the event should be triggered on success.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 86]

TimedEvent __construct(
integer
$id)

Constructor for TimedEvent.

Tags:

access:

public

Overrides TableEntry::__construct() (Constructor for TableEntry.)

Parameters:

integer

$id

The unique identifier for the timed event.

[ Top ]

method getDesciption [line 114]

string getDesciption(
)

Gets a brief description of the event.

Tags:

return:	A short description or name.
access:	public

[ Top ]

method markAsPerformed [line 151]

void markAsPerformed(
mixed
$timestampPattern)

Marks the event as performed, updating the next time that it should be performed.

Tags:

var:	The timestamp patternt that describes the next time that the event hsould be performed.
access:	private
throws:	IllegalArgumentException If the string is not a valid timestamp pattern.

[ Top ]

method performEvent [line 123]

void performEvent(
)

Performs the event, correctly processing it and marking it as performed.

That means that it will not be performed again until a set number of seconds have elapsed.

Tags:

access:

public

[ Top ]

method readRow [line 101]

void readRow(
mixed
$row)

Tags:

access:	public
see:	com.lokorin.dfcrafters.TableEntry.readRow($row)

Overrides TableEntry::readRow() (Processes the contents of a retrieved row that describes the entry.)

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:22 +0200 by phpDocumentor 1.3.0RC4