/themes/plain/index.php

Description

Default theme.

This is mostly intended to be an example theme, to base new themes on. $Id: index.php 597 2006-06-16 07:21:17Z stijn $

Functions
boxEnd (line 84)

End a page element.

This function should output the necessary HTML to end a page element.

void boxEnd ()
boxStart (line 69)

Start a page element.

Most themes define style to separate common page elements from each other. This function should output the HTML necessary to do so.

void boxStart ([mixed $title = ""], [mixed $class = ""])
loginForm (line 108)

Output a login form.

This should output a login form that sends POST information to the current page. The form should have two fields: user and password. The framework will call this when appropriate, and will handle the resulting POST.

It is expected that the display code uses the parameters passed to this function to explain the reason for asking their credentials to the user.

void loginForm (int $reason, [string $db = NULL])
  • int $reason: the reason for credential verification
  • string $db: the name of the database to login to
postContent (line 53)

Output the HTML to be written after the content.

Use the same values as for preContent.

void postContent ()
preContent (line 39)

Output all HTML needed before the content is output.

The theme should use the $PAGE global variable to display stuff. Important keys in the $PAGE variable:

  • title: the title of the page
  • options: the hash of options and their values
  • topics: array of topics
  • backlink: the link to the parent of this page

void preContent ()
setThemeOptions (line 18)

Set options for the theme.

Globally recognized theme options are:

  • no_sidebar: if true, do not display a topics / boxes side bar

void setThemeOptions (array $options)
  • array $options: hash of options and their values

Documentation generated on Fri, 30 Jun 2006 10:31:37 +0200 by phpDocumentor 1.3.0RC3