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 43]
Describes an event that is schedudled to be run every so often.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$callback =

[line 72]

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

Tags:

access:

private

Type:

string

[ Top ]

$decsription =

[line 48]

A description of the event.

Tags:

access:

private

Type:

string

[ Top ]

$interval =

[line 54]

The number of seconds that should pass between each time the event is run.

Tags:

access:

private

Type:

integer

[ Top ]

$lastPerformed =

[line 60]

The unix timestamp describing the point in time at which the event was last performed.

Tags:

access:

private

Type:

integer

[ Top ]

$libraryName =

[line 67]

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 ]

Class Methods

constructor __construct [line 78]

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 104]

string getDesciption(
)

Gets a brief description of the event.

Tags:

return:	A short description or name.
access:	public

[ Top ]

method markAsPerformed [line 135]

void markAsPerformed(
)

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

Tags:

access:

private

[ Top ]

method performEvent [line 113]

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 92]

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 Tue, 10 Jan 2006 17:06:28 +0100 by phpDocumentor 1.3.0RC4