Source for file lib_readme.php

<?php
/*
 * Lokorin.com
 * Copyright 2004-2006
 * Licensed under the GNU LGPL. See COPYING for full terms.
 */
/**
 * A library that contains everything related to readmes.
 * @author Andreas Launila
 * @version $Revision: 1.8 $
 * @package com.lokorin.lokorin.lib
 * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
 */
 
/**
 * For access to common constants and functions.
 */
require_once('common.php');
 
/**
 * 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 Andreas Launila
 * @package com.lokorin.lokorin.lib
 */
class Readme {
    /**
     * An array of Chapter instances describing all chapters, except the
     * introduction, contained in the readme.
     * @var array 
     */
    private $chapters;
    /**
     * The introduction chapter, may be null in which case no introduction
     * chapter exists.
     * @var Chapter 
     */
    private $intro;
    
    /**
     * Constructor for Readme.
     */
    public function __construct() {
        $this->chapters = array();
        $this->intro = null;
    }
    
    /**
     * Adds a new chapter to the readme.
     * @param Chapter $newChapter The new chapter that should be added.
     * @param boolean $isIntro Whether or not the chapter should be used as an
     *          introduction.
     */
    public function addChapter(Chapter $newChapter, $isIntro = false) {
        if($isIntro) {
            $this->intro = $newChapter;
        } else {
            $this->chapters[] = $newChapter;
        }
    }
    
    /**
     * Gets the readme as XHTML compliant code.
     * @return string XHTML compliant code that represents the readme.
     */
    public function getReadme() {
        if($this->intro != null) {
            //Display the contents of the intro chapter before anything else.
            $intro = $this->intro->getContents();
        } else {
            $intro = '';
        }
 
        $contents = '';
        $navigation = '<h2>Table of Contents</h2><ul id="readme_toc">';
        foreach($this->chapters as $key => $chapter) {
            $navigation .= '<li><a href="#'.$key.'">'.$chapter->getTopic().
                    '</a></li>';
            $contents .= '<a name="'.$key.'"></a>'.$chapter->getAsHtml()."\n";
        }
        $navigation .= '</ul>';
 
        return '<div id="readme_contents">'.$intro.$navigation.$contents.'</div>';
    }
}
 
/**
 * Describes a readme chapter. A chapter contains information about one
 * specific topic.
 * @author Andreas Launila
 * @package com.lokorin.lokorin.lib
 */
class Chapter {
    /**
     * The topic of the chapter.
     * @var string 
     */
    private $topic;
    /**
     * The actual contents of the chapter. The text (XHTML) informing about the
     * chapter's topic.
     */
    private $contents;
    
    /**
     * Constructor for Chapter.
     * @param string $topic The opic that the chapter is about.
     * @param string $contents The (XHTML) text that informs about the
     *          chapter's topic.
     */
    public function __construct($topic, $contents) {
        $this->topic = $topic;
        $this->contents = $contents;
    }
    
    /**
     * Gets the chapter's topic.
     * @return string A chapter topic.
     */
    public function getTopic() {
        return $this->topic;
    }
    
    /**
     * Gets the chapter as XHTML compliant code.
     * @return string XHTML compliant code that represents the chapter.
     */
    public function getAsHtml() {
        return '<h2>'.$this->topic.'</h2>'."\n".$this->contents;
    }
    
    /**
     * Gets the contents of the chapter.
     * @return string The chapter's contents.
     */
    public function getContents() {
        return $this->contents;
    }
}
?>