Class: Filter

Source Location: /_includes/lib_mplf_archive.php

Class Overview

TableEntry
   |
   --Filter

Describes a filter.

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 455]
Describes a filter.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$author =

[line 480]

The author of the filter.

Tags:

access:

private

Type:

string

[ Top ]

$categoryId =

[line 490]

The unique identifier of the category that the filter belongs to.

Tags:

access:

private

Type:

integer

[ Top ]

$contents =

[line 495]

The contents of the associated XML file.

Tags:

access:

private

Type:

string

[ Top ]

$description =

[line 465]

A description of the filter.

Tags:

access:

private

Type:

string

[ Top ]

$edits =

[line 485]

The unique identifiers of Edits that belong to the filter.

Tags:

access:

private

Type:

array

[ Top ]

$name =

[line 460]

The name of the filter.

Tags:

access:

private

Type:

string

[ Top ]

$timeAdded =

[line 470]

The timestamp representing the time when the filter was first added.

Tags:

access:

private

Type:

integer

[ Top ]

$version =

[line 475]

The MPLF version that the filter was designed for.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 501]

Filter __construct(
integer
$id)

Constructor for Filter.

Tags:

access:

public

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

Parameters:

integer

$id

The id of the filter.

[ Top ]

method getAddedTimestamp [line 547]

integer getAddedTimestamp(
)

Gets the timestamp for when the filter was added.

Tags:

return:	An Unix timestamp.
access:	public

[ Top ]

method getAssociatedEdits [line 580]

array getAssociatedEdits(
)

Gets all Edit instances that are associated with the filter.

Tags:

return:	Key is the chronological order with 0 being the most recent and so on. Value is an Edit instance.
access:	public

[ Top ]

method getAuthor [line 563]

string getAuthor(
)

Gets the author of the filter.

Tags:

return:	An author name.
access:	public

[ Top ]

method getCategory [line 571]

Category getCategory(
)

Gets the category that the filter belongs to.

Tags:

return:	An instance of Category..
access:	public

[ Top ]

method getContents [line 597]

string getContents(
)

Gets the contents of the associated XML file.

Tags:

return:	An XML file.
access:	public

[ Top ]

method getDescription [line 539]

string getDescription(
)

Gets the description of the filter.

Tags:

return:	A filter description.
access:	public

[ Top ]

method getName [line 531]

string getName(
)

Gets the name of the filter.

Tags:

return:	A filter name.
access:	public

[ Top ]

method getVersion [line 555]

string getVersion(
)

Gets the MPLF version that the filter was designed for.

Tags:

return:	A version string, e.g. "1.3".
access:	public

[ Top ]

method readRow [line 517]

void readRow(
mixed
$row)

Tags:

access:	protected
see:	com.lokorin.lokorin.includes.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:41 +0200 by phpDocumentor 1.3.0RC4