Class: Readme

Source Location: /_includes/lib_readme.php

Class Overview

Describes a readme. A readme is a guide with several chapters of information which are ordered into a more navigatable fashion for the users convenience.

Author(s):

Andreas Launila

Variables

Methods

Class Details

[line 27]
Describes a readme. A readme is a guide with several chapters of information which are ordered into a more navigatable fashion for the users convenience.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$chapters =

[line 33]

An array of Chapter instances describing all chapters, except the introduction, contained in the readme.

Tags:

access:

private

Type:

array

[ Top ]

$intro =

[line 39]

The introduction chapter, may be null in which case no introduction chapter exists.

Tags:

access:

private

Type:

Chapter

[ Top ]

Class Methods

constructor __construct [line 44]

Readme __construct(
)

Constructor for Readme.

Tags:

access:

public

[ Top ]

method addChapter [line 55]

void addChapter(
Chapter
$newChapter, [boolean
$isIntro = false])

Adds a new chapter to the readme.

Tags:

access:

public

Parameters:

Chapter	$newChapter	The new chapter that should be added.
boolean	$isIntro	Whether or not the chapter should be used as an introduction.

[ Top ]

method getReadme [line 67]

string getReadme(
)

Gets the readme as XHTML compliant code.

Tags:

return:	XHTML compliant code that represents the readme.
access:	public

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:50 +0200 by phpDocumentor 1.3.0RC4