Entry

function data( $value  =  false )

Set or return the data property.  If the optional value parameter is set to a true value (i.e. a non-empty string), then this value is set to the data property.  Otherwise, the data property is returned.

function tags( $list  =  false )

Set or return an array of tags for this entry.  Each tag is an arbitrary string entered by the user with no inherent meaning.

function permalink()

Abstract function that returns the object’s permalink.  Child classes must over-ride this.

function getParent()

Abstract function to return the parent object of the current object.  This will be a Blog object for BlogEntry or Article objects, and a BlogEntry or Article for BlogComment or TrackBack objects.  Child classes must over-ride this method.

function baselink()

Gets a link to the object’s base directory, to use for converting relative to absolute paths.  I some cases, this is just the permalink.

Returns

An absolute URI.

function queryStringToID()

Abstract function that converts a query string into a unique identifier for an object.  Child classes must over-ride this function.

function absolutizeBBCodeURI( $data, $current_uri )

A function to search LBCode marked-up text and convert the URIs in links and images from relative to absolute.

Parameters

Returns

A string with the markup in the data parameter, but with relative img and url tags converted to absolute URIs.  If the relative URI contains no slashes, colons, or ampersands, the relative URI given will be interpreted as under the under the current_uri parameter.  If it contains slashes, but no colons or ampersands, it will interpreted as relative to the blog root, if there is a current blog, and if the given URI starts with a slash, it will be interpreted as relative to the DOCUMENT_ROOT, if it is set.

function absolutizeHTMLURI( $data, $current_uri )

A version of absolutizeBBCodeURI that works with HTML markup.

Parameters

Returns

The markup in the data parameter with href and src attributes absolutized according to the same rules as apply with absolutizeBBCodeURI.

function stripHTML( $data )

Strip HTML code out of a string.  Note that the UNICODE_ESCAPE_HACK configuration constant can be used to switch between using the PHP htmlentities() and htmlspecialchars() functions to sanitize input.  This is because htmlentities() has a nasty habit of mangling Unicode.

Parameters

Returns

A copy of data with HTML special characters such as angle brackets and ampersands converted into their corresponding HTML entities.  This will cause them to display in a web page as characters, not HTML markup.

Converts LBCode markup into HTML.

Parameters

Returns

A string with the converted text.

function markup( $data  =  "", $use_nofollow  =  false )

Apply appropriate markup to the entry data.

Parameters

Returns

A string with markup applied.

function getAbstract( $numchars  =  500 )

A quick function to get a plain text abstract of the entry data by grabbing the first paragraph of text or the first N characters, whichever comes first.  Markup is removed in the process.  Note that it attempts to do word wrapping to avoid cutting words off in the middle.

Parameters

A string containing the abstract text, with all markup stripped out.

function prettyDate( $ts  =  false )

Get a human-readable date from a timestamp.

Parameters

Returns

A string with a formatted, localized date.

function readFileData()

Reads entry data from a file.  File metadata is enclosed in META tags which are HTML comments, in one-per-line format.  Here is an example.

<!--META Subject: This is a subject META-->

Variables are created for every such line which is referenced in the metadata_fields property of the object.  The metadata_fields property is an associative array where the element key is the propery of the object to which the value is assigned and the element valueis the case-insensitive variable used in the file, as with “Subject” in the example above.

There is also a custom_fields property.  This is an associative array, just as metadata_fields.  If custom_fields is populated, its members are merged into metadata_fields, in effect adding elements to the standard metadata fields.

Returns

The body of the entry as a string.

function writeFileData()

Write entry data to a file.  The contents of the file are determined by the properties of the object and the contents of the metadata_fields and custom_fields properties, just as with readFileData.  This function writes the metadata to HTML comments, as mentioned above, while the body data is written at the end of the file.  Note that, in order for the file to be written, the file property of the object must be set.

Returns

True if the file write is successful, false otherwise.