doc.php 3.71 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

/**
 * Documentation action.
 *
 * PHP version 5
 *
 * @category Action
9
 * @package  StatusNet
10 11
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
Robin Millette's avatar
Robin Millette committed
12
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
13
 * @link     http://status.net/
Robin Millette's avatar
Robin Millette committed
14
 *
15
 * StatusNet - the distributed open-source microblogging tool
16
 * Copyright (C) 2008, 2009, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * 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/>.
 */

32
if (!defined('STATUSNET') && !defined('LACONICA')) {
Robin Millette's avatar
Robin Millette committed
33 34 35 36 37 38 39
    exit(1);
}

/**
 * Documentation class.
 *
 * @category Action
40
 * @package  StatusNet
41 42
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
Robin Millette's avatar
Robin Millette committed
43
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
44
 * @link     http://status.net/
Robin Millette's avatar
Robin Millette committed
45
 */
46 47
class DocAction extends Action
{
Robin Millette's avatar
Robin Millette committed
48 49
    var $filename;
    var $title;
Evan Prodromou's avatar
Evan Prodromou committed
50

Robin Millette's avatar
Robin Millette committed
51
    /**
Evan Prodromou's avatar
Evan Prodromou committed
52
     * Handle a request
Evan Prodromou's avatar
Evan Prodromou committed
53
     *
Robin Millette's avatar
Robin Millette committed
54 55 56
     * @param array $args array of arguments
     *
     * @return nothing
Robin Millette's avatar
Robin Millette committed
57
     */
58 59
    function handle($args)
    {
60
        parent::handle($args);
61 62 63 64

        $this->title  = $this->trimmed('title');
        $this->output = null;

Evan Prodromou's avatar
Evan Prodromou committed
65
        if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
66 67 68 69 70 71 72 73

            $this->filename = INSTALLDIR.'/doc-src/'.$this->title;
            if (!file_exists($this->filename)) {
                $this->clientError(_('No such document.'));
                return;
            }

            $c = file_get_contents($this->filename);
Evan Prodromou's avatar
Evan Prodromou committed
74

75 76
            $this->output = common_markup_to_html($c);

Evan Prodromou's avatar
Evan Prodromou committed
77
            Event::handle('EndLoadDoc', array($this->title, &$this->output));
78
        }
79

Robin Millette's avatar
Robin Millette committed
80 81 82
        $this->showPage();
    }

Evan Prodromou's avatar
Evan Prodromou committed
83 84 85 86 87 88 89 90 91 92
    /**
     * Page title
     *
     * Gives the page title of the document. Override default for hAtom entry.
     *
     * @return void
     */

    function showPageTitle()
    {
93 94
        $this->element('h1', array('class' => 'entry-title'), $this->title());
    }
Evan Prodromou's avatar
Evan Prodromou committed
95

Evan Prodromou's avatar
Evan Prodromou committed
96 97 98 99 100 101 102 103
    /**
     * Block for content.
     *
     * Overrides default from Action to wrap everything in an hAtom entry.
     *
     * @return void.
     */

104
    function showContentBlock()
Evan Prodromou's avatar
Evan Prodromou committed
105 106 107 108 109 110 111 112 113 114 115
    {
        $this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
        $this->showPageTitle();
        $this->showPageNoticeBlock();
        $this->elementStart('div', array('id' => 'content_inner',
                                         'class' => 'entry-content'));
        // show the actual content (forms, lists, whatever)
        $this->showContent();
        $this->elementEnd('div');
        $this->elementEnd('div');
    }
116

Robin Millette's avatar
Robin Millette committed
117 118
    /**
     * Display content.
Evan Prodromou's avatar
Evan Prodromou committed
119
     *
Evan Prodromou's avatar
Evan Prodromou committed
120 121 122
     * Shows the content of the document.
     *
     * @return void
Robin Millette's avatar
Robin Millette committed
123
     */
Evan Prodromou's avatar
Evan Prodromou committed
124

Robin Millette's avatar
Robin Millette committed
125 126
    function showContent()
    {
127
        $this->raw($this->output);
Robin Millette's avatar
Robin Millette committed
128 129 130 131
    }

    /**
     * Page title.
Evan Prodromou's avatar
Evan Prodromou committed
132
     *
Evan Prodromou's avatar
Evan Prodromou committed
133 134
     * Uses the title of the document.
     *
Robin Millette's avatar
Robin Millette committed
135
     * @return page title
Robin Millette's avatar
Robin Millette committed
136
     */
Robin Millette's avatar
Robin Millette committed
137 138 139
    function title()
    {
        return ucfirst($this->title);
140
    }
141

Evan Prodromou's avatar
Evan Prodromou committed
142 143 144 145 146 147 148 149
    /**
     * These pages are read-only.
     *
     * @param array $args unused.
     *
     * @return boolean read-only flag (false)
     */

150
    function isReadOnly($args)
151 152 153
    {
        return true;
    }
154
}