com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]

Class: Chapter

Source Location: /_includes/lib_readme.php

Class Overview


Describes a readme chapter. A chapter contains information about one specific topic.


Author(s):

  • Andreas Launila

Variables

Methods



Class Details

[line 94]
Describes a readme chapter. A chapter contains information about one specific topic.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$contents =

[line 104]

The actual contents of the chapter. The text (XHTML) informing about the chapter's topic.



Tags:

access:  private

Type:   mixed


[ Top ]

$topic =

[line 99]

The topic of the chapter.



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 112]

Chapter __construct( string $topic, string $contents)

Constructor for Chapter.



Tags:

access:  public


Parameters:

string   $topic   The opic that the chapter is about.
string   $contents   The (XHTML) text that informs about the chapter's topic.

[ Top ]

method getAsHtml [line 129]

string getAsHtml( )

Gets the chapter as XHTML compliant code.



Tags:

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


[ Top ]

method getContents [line 137]

string getContents( )

Gets the contents of the chapter.



Tags:

return:  The chapter's contents.
access:  public


[ Top ]

method getTopic [line 121]

string getTopic( )

Gets the chapter's topic.



Tags:

return:  A chapter topic.
access:  public


[ Top ]


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