gnu-social/actions/doc.php

238 lines
6.7 KiB
PHP
Raw Normal View History

<?php
2009-01-21 05:29:31 +09:00
/**
* Documentation action.
*
* PHP version 5
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
2009-01-21 05:29:31 +09:00
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
2009-08-26 07:16:46 +09:00
* @link http://status.net/
2009-01-21 05:29:31 +09:00
*
2009-08-26 07:14:12 +09:00
* StatusNet - the distributed open-source microblogging tool
2010-03-11 07:05:28 +09:00
* Copyright (C) 2008-2010, StatusNet, 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/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
2009-01-21 05:29:31 +09:00
exit(1);
}
/**
* Documentation class.
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
2009-01-21 05:29:31 +09:00
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
2009-08-26 07:16:46 +09:00
* @link http://status.net/
2009-01-21 05:44:03 +09:00
*/
class DocAction extends Action
{
2009-10-07 18:14:25 +09:00
var $output = null;
var $filename = null;
var $title = null;
function prepare($args)
{
parent::prepare($args);
2009-10-07 18:14:25 +09:00
$this->title = $this->trimmed('title');
if (!preg_match('/^[a-zA-Z0-9_-]*$/', $this->title)) {
$this->title = 'help';
}
2009-10-07 18:14:25 +09:00
$this->output = null;
$this->loadDoc();
return true;
}
2009-01-21 05:29:31 +09:00
/**
2009-10-07 04:29:22 +09:00
* Handle a request
*
2009-01-21 05:29:31 +09:00
* @param array $args array of arguments
*
* @return nothing
2009-01-21 05:44:03 +09:00
*/
function handle($args)
{
parent::handle($args);
2009-01-21 05:29:31 +09:00
$this->showPage();
}
2009-10-07 04:29:22 +09:00
/**
* Page title
*
* Gives the page title of the document. Override default for hAtom entry.
*
* @return void
*/
function showPageTitle()
{
$this->element('h1', array('class' => 'entry-title'), $this->title());
}
2009-10-07 04:29:22 +09:00
/**
* Block for content.
*
* Overrides default from Action to wrap everything in an hAtom entry.
*
* @return void.
*/
function showContentBlock()
2009-10-07 04:29:22 +09:00
{
$this->elementStart('div', array('id' => 'content', 'class' => 'h-entry'));
2009-10-07 04:29:22 +09:00
$this->showPageTitle();
$this->showPageNoticeBlock();
$this->elementStart('div', array('id' => 'content_inner',
'class' => 'e-content'));
2009-10-07 04:29:22 +09:00
// show the actual content (forms, lists, whatever)
$this->showContent();
$this->elementEnd('div');
$this->elementEnd('div');
}
2009-01-21 05:29:31 +09:00
/**
* Display content.
*
2009-10-07 04:29:22 +09:00
* Shows the content of the document.
*
* @return void
2009-01-21 05:44:03 +09:00
*/
2009-01-21 05:29:31 +09:00
function showContent()
{
$this->raw($this->output);
2009-01-21 05:29:31 +09:00
}
/**
* Page title.
*
2009-10-07 04:29:22 +09:00
* Uses the title of the document.
*
2009-01-21 05:29:31 +09:00
* @return page title
2009-01-21 05:44:03 +09:00
*/
2009-01-21 05:29:31 +09:00
function title()
{
return ucfirst($this->title);
}
2009-01-23 18:15:15 +09:00
2009-10-07 04:29:22 +09:00
/**
* These pages are read-only.
*
* @param array $args unused.
*
* @return boolean read-only flag (false)
*/
function isReadOnly($args)
2009-01-23 18:15:15 +09:00
{
return true;
}
2009-10-07 18:14:25 +09:00
function loadDoc()
{
if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
$paths = DocFile::defaultPaths();
2009-10-07 18:14:25 +09:00
$docfile = DocFile::forTitle($this->title, $paths);
if (empty($docfile)) {
// TRANS: Client exception thrown when requesting a document from the documentation that does not exist.
// TRANS: %s is the non-existing document.
throw new ClientException(sprintf(_('No such document "%s".'), $this->title), 404);
2009-10-07 18:14:25 +09:00
}
$this->output = $docfile->toHTML();
2009-10-07 18:14:25 +09:00
Event::handle('EndLoadDoc', array($this->title, &$this->output));
}
}
2011-10-01 03:24:27 +09:00
function showLocalNav()
{
$menu = new DocNav($this);
$menu->show();
}
}
class DocNav extends Menu
{
function show()
{
if (Event::handle('StartDocNav', array($this))) {
$stub = new HomeStubNav($this->action);
$this->submenu(_m('MENU','Home'), $stub);
$docs = new DocListNav($this->action);
$this->submenu(_m('MENU','Docs'), $docs);
Event::handle('EndDocNav', array($this));
}
2011-10-01 03:24:27 +09:00
}
}
class DocListNav extends Menu
{
function getItems()
{
$items = array();
if (Event::handle('StartDocsMenu', array(&$items))) {
$items = array(array('doc',
array('title' => 'help'),
_m('MENU', 'Help'),
_('Getting started'),
'nav_doc_help'),
array('doc',
array('title' => 'about'),
_m('MENU', 'About'),
_('About this site'),
'nav_doc_about'),
array('doc',
array('title' => 'faq'),
_m('MENU', 'FAQ'),
_('Frequently asked questions'),
'nav_doc_faq'),
array('doc',
array('title' => 'contact'),
_m('MENU', 'Contact'),
_('Contact info'),
'nav_doc_contact'),
array('doc',
array('title' => 'tags'),
_m('MENU', 'Tags'),
_('Using tags'),
'nav_doc_tags'),
array('doc',
array('title' => 'groups'),
_m('MENU', 'Groups'),
_('Using groups'),
'nav_doc_groups'),
array('doc',
array('title' => 'api'),
_m('MENU', 'API'),
_('RESTful API'),
'nav_doc_api'));
Event::handle('EndDocsMenu', array(&$items));
}
return $items;
}
}