User Documentation

Overview and Setup

Creator Functions

Internationalization

Page

showarchive.php

showarticles.php

showcomments.php

DisableComments

HTAccessGenerator

RSS1FeedGenerator

RSS2FeedGenerator

TrackbackValidator

Page

Represents a web page. This class is primarily concerned with making sure that the things in the HEAD part of the page are set up correctly.

Inherits

Events

OnInit	Fired when a page object is first created.
InitComplete	Fired after object initialization is complete.
OnOutput	Fired when processing for HTML output starts.
OutputComplete	Fired after the HTML output has been performed.

Summary

Page	Represents a web page.
Properties
display_object	Holds a reference to the primary object which is displayed on this page.
doctype	String holding the DOCTYPE for the page.
title	A string used for the page title.
mime_type	Represents the MIME type of the page.
charset	Holds the character encoding to use for the page.
Functions
setDisplayObject	Sets the object which the page is currently displaying.
addStylesheet	Adds style sheets to be link into the page.
addInlineStylesheet	Adds style sheets to be added inline into the page.
addLink	Adds a generic link element to the page header.
addRSSFeed	Adds an RSS feed to the link elements of the page header.
addScript	Adds a script file to the header of the page.
addInlineScript	Adds an inline script to the header of the page.
addMeta	Adds a META item to the page.
addHeader	Add an item to the HTTP header for the page.
redirect	Redirect to another page.
refresh	Refresh the page.
display	Displays the page, i.e.

Properties

display_object

Holds a reference to the primary object which is displayed on this page. The type of object will vary from page to page and may be set to false on some pages. For most pages, it will be the current Blog object, but BlogEntry and Article object are also common.

doctype

String holding the DOCTYPE for the page. Should normally be set using a named constant.

title

A string used for the page title.

mime_type

Represents the MIME type of the page.

charset

Holds the character encoding to use for the page.

Functions

setDisplayObject

function setDisplayObject( & $ref )

Sets the object which the page is currently displaying.

Parameters

ref	A reference to the object to set.

addStylesheet

function addStylesheet()

Adds style sheets to be link into the page.

Parameters

Takes a variable number of string parameters, each representing the filename of a CSS file.

addInlineStylesheet

function addInlineStylesheet()

Adds style sheets to be added inline into the page.

Parameters

Takes a variable number of string parameters, each containing the CSS code to use for the inline styles.

addLink

function addLink( $attribs )

Adds a generic link element to the page header.

Parameters

attribs

An associative array, with each key corresponding to an attribute of the link with the corresponding value as the value.

addRSSFeed

function addRSSFeed( $href,
$type,
$title )

Adds an RSS feed to the link elements of the page header.

Parameters

href	The URL of the feed file.
type	The MIME type of the feed, e.g. application/xml or application/rss+xml
title	The title for the feed.

addScript

function addScript( $href,
$type = "text/javascript" )

Adds a script file to the header of the page.

Parameters

href	The URL of the script file.
type	Optional MIME type of the script. The default is text/javascript.

addInlineScript

function addInlineScript( $text,
$type = "text/javascript" )

Adds an inline script to the header of the page.

Parameters

text	The text of the script to add inline.
type	Optional MIME type of the script. The default is text/javascript.

addMeta

function addMeta( $content,
$name = false,
$httpequiv = false )

Adds a META item to the page.

Parameters

content	The content of the meta tag.
name	Optional name attribute.
httpequiv	Optional http-equiv attribute.

addHeader

function addHeader( $name,
$content )

Add an item to the HTTP header for the page.

Parameters

name	The header name.
content	The content of the header.

redirect

function redirect( $url )

Redirect to another page.

Parameters

url	The target URL to which to redirect.

refresh

function refresh( $url,
$delay = )

Refresh the page.

Parameters

url	The URL of the page to refresh.
delay	Optional delay of refresh. Default is 0.

display

function display( $page_body,
$blog = false )

Displays the page, i.e. sends it to the browser.

function setDisplayObject( & $ref )

Sets the object which the page is currently displaying.

function addStylesheet()

Adds style sheets to be link into the page.

function addInlineStylesheet()

Adds style sheets to be added inline into the page.

function addLink( $attribs )

Adds a generic link element to the page header.

function addRSSFeed( $href,
$type,
$title )

Adds an RSS feed to the link elements of the page header.

function addScript( $href,
$type = "text/javascript" )

Adds a script file to the header of the page.

function addInlineScript( $text,
$type = "text/javascript" )

Adds an inline script to the header of the page.

function addMeta( $content,
$name = false,
$httpequiv = false )

Adds a META item to the page.

function addHeader( $name,
$content )

Add an item to the HTTP header for the page.

function redirect( $url )

Redirect to another page.

function refresh( $url,
$delay = )

Refresh the page.

function display( $page_body,
$blog = false )

Displays the page, i.e.

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