actions/doc.php

   1 <?php
   2
   3 /**
   4  * Documentation action.
   5  *
   6  * PHP version 5
   7  *
   8  * @category Action
   9  * @package  StatusNet
  10  * @author   Evan Prodromou <evan@status.net>
  11  * @author   Robin Millette <millette@status.net>
  12  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  13  * @link     http://status.net/
  14  *
  15  * StatusNet - the distributed open-source microblogging tool
  16  * Copyright (C) 2008, 2009, StatusNet, Inc.
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU Affero General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU Affero General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU Affero General Public License
  29  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  30  */
  31
  32 if (!defined('STATUSNET') && !defined('LACONICA')) {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Documentation class.
  38  *
  39  * @category Action
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @author   Robin Millette <millette@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  44  * @link     http://status.net/
  45  */
  46 class DocAction extends Action
  47 {
  48     var $filename;
  49     var $title;
  50
  51     /**
  52      * Class handler.
  53      *
  54      * @param array $args array of arguments
  55      *
  56      * @return nothing
  57      */
  58     function handle($args)
  59     {
  60         parent::handle($args);
  61
  62         $this->title  = $this->trimmed('title');
  63         $this->output = null;
  64
  65         if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
  66
  67             $this->filename = INSTALLDIR.'/doc-src/'.$this->title;
  68             if (!file_exists($this->filename)) {
  69                 $this->clientError(_('No such document.'));
  70                 return;
  71             }
  72
  73             $c = file_get_contents($this->filename);
  74             $this->output = common_markup_to_html($c);
  75
  76             Event::handle('EndLoadDoc', array($this->title, &$this->output));
  77         }
  78
  79         $this->showPage();
  80     }
  81
  82     // overrrided to add entry-title class
  83     function showPageTitle() {
  84         $this->element('h1', array('class' => 'entry-title'), $this->title());
  85     }
  86
  87     // overrided to add hentry, and content-inner classes
  88     function showContentBlock()
  89      {
  90          $this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
  91          $this->showPageTitle();
  92          $this->showPageNoticeBlock();
  93          $this->elementStart('div', array('id' => 'content_inner',
  94              'class' => 'entry-content'));
  95          // show the actual content (forms, lists, whatever)
  96          $this->showContent();
  97          $this->elementEnd('div');
  98          $this->elementEnd('div');
  99      }
 100
 101     /**
 102      * Display content.
 103      *
 104      * @return nothing
 105      */
 106     function showContent()
 107     {
 108         $this->raw($this->output);
 109     }
 110
 111     /**
 112      * Page title.
 113      *
 114      * @return page title
 115      */
 116     function title()
 117     {
 118         return ucfirst($this->title);
 119     }
 120
 121     function isReadOnly($args)
 122     {
 123         return true;
 124     }
 125 }