OnInit	Fired when the object is created.
InitComplete	Fired at end of constructor.
OnInsert	Fired before object is saved to persistent storage.
InsertComplete	Fired after object has finished saving.
OnOutput	Fired before output is generated.
OutputComplete	Fired after output has finished being generated.

Summary

Article	Represents a static article.
Functions
isArticle	Determine if this object is, in fact, an article.
setticky	Set whether or not an article should be considered “featured”.
isSticky	Determines if the article is set as sticky.
readSticky	Get the title and permalink without retreiving the entire article.
entryID	Gets the ID of the article, which is normally just the last portion of the path.
getPath	Builds a path to store the given article.
insert	Save the object as a new article.

Functions

isArticle

function isArticle( $path = false )

Determine if this object is, in fact, an article. This is based on the internal storage format of the article information, i.e. if the correct storage format is found, then it’s an article.

Parameters

path	Optional parameter for the unique ID of the object. This should only be used by back-end classes.

Returns

True if object is a valid article, false otherwise.

setticky

Set whether or not an article should be considered “featured”. Articles not set sticky should be considered archival and not shown on things like front-page article lists.

Parameters

show	Optional boolean parameter to turn stickiness on or off. Default is true (stickiness on).

Returns

True on success, false on failure.

isSticky

function isSticky( $path = false )

Determines if the article is set as sticky.

Parameters

path	Optional unique ID for the article.

Returns

True if the article is sticky, false otherwise.

readSticky

function readSticky( $path )

Get the title and permalink without retreiving the entire article.

Parameters

path	The unique ID for the article.

Returns

A two-element array, with “link” and “title” for the permalink and subject of the article.

entryID

function entryID()

Gets the ID of the article, which is normally just the last portion of the path.

Returns

A string containing the unique ID of this article.

getPath

function getPath( $curr_ts = false,
$just_name = false,
$long_format = false )

Builds a path to store the given article. This is only meaningful for file-based storage and should only be used internally.

Parameters

curr_ts	An optional timestamp.
just_name	Optional boolean to return just a file name.
long_format	Optional boolean to use long date format.

Returns

A string to use for the path to the article.

insert

function insert ( $blog,
$dir_path = false )

Save the object as a new article.

Parameters

blog	The blog object into which the article should be inserted.
dir_path	Optional directory name to use for the article.

Returns

True on success, false on failure.

function isArticle( $path = false )

Determine if this object is, in fact, an article.

function isSticky( $path = false )

Determines if the article is set as sticky.

function readSticky( $path )

Get the title and permalink without retreiving the entire article.

function entryID()

Gets the ID of the article, which is normally just the last portion of the path.

function getPath( $curr_ts = false,
$just_name = false,
$long_format = false )

Builds a path to store the given article.

function insert ( $blog,
$dir_path = false )

Save the object as a new article.

A base object which is event-aware, i.e.

An abstract class representing entries of all types in the blog database.

Represents an entry in the weblog.