Class: Article

Source Location: /_includes/lib_articles.php

Class Overview

TableEntry
   |
   --Article

Describes an article.

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 article.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$authorId =

[line 58]

The unique identifier of the article's author.

Tags:

access:

private

Type:

string

[ Top ]

$counterId =

[line 70]

The unique identifier for the counter that is associated with the article.

Tags:

access:

private

Type:

integer

[ Top ]

$fileName =

[line 64]

The filename of the file in the article folder that contains the contents of the article.

Tags:

access:

private

Type:

string

[ Top ]

$timestamp =

[line 53]

The unix timestamp for when the article was added.

Tags:

access:

private

Type:

integer

[ Top ]

$title =

[line 48]

The title of the article.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 76]

Article __construct(
integer
$id)

Constructor for Article.

Tags:

access:

public

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

Parameters:

integer

$id

The unique identifier for the article.

[ Top ]

method getArticle [line 102]

string getArticle(
)

Gets the article in a XHTML form.

Tags:

return:	XHTML compliant code representing the article.
access:	public

[ Top ]

method getAuthor [line 127]

Author getAuthor(
)

Gets the author of the article.

Tags:

return:	An article author.
access:	public

[ Top ]

method getCounter [line 145]

Counter getCounter(
)

Gets the counter that is connected to the article.

Tags:

return:	An Counter instance representing the connected counter.
access:	public

[ Top ]

method getTitle [line 119]

string getTitle(
)

Gets the title describing the article.

Tags:

return:	A title.
access:	public

[ Top ]

method getUrl [line 137]

string getUrl(
)

Gets the url to the article. The url is easy to read and is the one that the user should always be seeing.

Tags:

return:	An url relative to the page root.
access:	public

[ Top ]

method readRow [line 90]

void readRow(
mixed
$row)

Tags:

access:	protected
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:23 +0100 by phpDocumentor 1.3.0RC4