doc.php 2.28 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1
<?php
Robin Millette's avatar
Robin Millette committed
2 3 4 5 6 7 8 9 10 11 12 13 14

/**
 * Documentation action.
 *
 * PHP version 5
 *
 * @category Action
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @author   Robin Millette <millette@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 * @link     http://laconi.ca/
 *
Evan Prodromou's avatar
Evan Prodromou committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

Robin Millette's avatar
Robin Millette committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45
if (!defined('LACONICA')) {
    exit(1);
}

/**
 * Documentation class.
 *
 * @category Action
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @author   Robin Millette <millette@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 * @link     http://laconi.ca/

Evan Prodromou's avatar
Evan Prodromou committed
46

Robin Millette's avatar
Robin Millette committed
47
*/
48 49
class DocAction extends Action
{
Robin Millette's avatar
Robin Millette committed
50 51
    var $filename;
    var $title;
Evan Prodromou's avatar
Evan Prodromou committed
52

Robin Millette's avatar
Robin Millette committed
53 54 55 56 57 58 59
    /**
     * Class handler.
     * 
     * @param array $args array of arguments
     *
     * @return nothing
    */
60 61
    function handle($args)
    {
62
        parent::handle($args);
Robin Millette's avatar
Robin Millette committed
63 64 65
        $this->title    = $this->trimmed('title');
        $this->filename = INSTALLDIR.'/doc/'.$this->title;
        if (!file_exists($this->filename)) {
66
            $this->clientError(_('No such document.'));
67 68
            return;
        }
Robin Millette's avatar
Robin Millette committed
69 70 71 72 73 74 75 76 77 78 79
        $this->showPage();
    }

    /**
     * Display content.
     * 
     * @return nothing
    */
    function showContent()
    {
        $c      = file_get_contents($this->filename);
80
        $output = common_markup_to_html($c);
81
        $this->raw($output);
Robin Millette's avatar
Robin Millette committed
82 83 84 85 86 87 88 89 90 91
    }

    /**
     * Page title.
     * 
     * @return page title
    */
    function title()
    {
        return ucfirst($this->title);
92
    }
93
}
Robin Millette's avatar
Robin Millette committed
94