Docs For Class OnpubArticle

Description

An article.

author: Corey H.M. Taylor
copyright: Onpub (TM). Copyright 2012, Onpub.com. http://onpub.com/
license: GNU General Public License Version 2

Located in /OnpubArticle.php (line 13)

Variable Summary

array $authors

string $content

int $ID

OnpubImage $image

int $imageID

array $sectionIDs

string $title

string $url

Method Summary

OnpubArticle __construct ()

DateTime getCreated ()

DateTime getModified ()

string getSummary ([int $limit = 30])

void setCreated (DateTime $created)

void setModified (DateTime $modified)

Variables

array $authors (line 52)

Article authors. Default is an empty array.

access: public

string $content (line 38)

Article content. Default is an empty string.

access: public

int $ID (line 20)

Article ID. Default is NULL.

access: public

OnpubImage $image (line 58)

Article image. Default is NULL.

access: public

int $imageID (line 26)

Image ID. Default is NULL.

access: public

array $sectionIDs (line 64)

Article section IDs. Default is an empty array.

access: public

string $title (line 32)

Article title. Default is an empty string.

access: public

string $url (line 44)

Article URL. Default is an empty string.

access: public

Methods

Constructor __construct (line 69)

Construct a new article.

OnpubArticle __construct ()

getCreated (line 92)

Get this article's creation date.

By default, returns the date at the time this method was called for the first time. Call OnpubArticle::setCreated() to explicitly set this article's creation date.

access: public

DateTime getCreated ()

getModified (line 120)

Get this article's last modification date.

By default, returns the date at the time this method was called for the first time. Call OnpubArticle::setModified() to explicitly set this article's last modification date.

access: public

DateTime getModified ()

getSummary (line 147)

Get a summary of this article's content.

By default a 30 word summary is generated.

access: public

string getSummary ([int $limit = 30])

int $limit: The maximum number of words to include in the summary.

setCreated (line 106)

Set this article's creation date.

access: public

void setCreated (DateTime $created)

DateTime $created

setModified (line 134)

Set this article's last modification date.

access: public

void setModified (DateTime $modified)

DateTime $modified