summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Prodromou <evan@status.net>2009-10-06 15:29:22 -0400
committerEvan Prodromou <evan@status.net>2010-01-22 13:53:53 -0500
commitdf9b780706eec9ff67e97803f5f70b475b010281 (patch)
tree910c12dacace7edc08bc33d91ab28da826255697
parenta3e484a0e898bb94dd45cd7807bea1a931d7c6a9 (diff)
action/doc.php is PHPCS clean
-rw-r--r--actions/doc.php61
1 files changed, 45 insertions, 16 deletions
diff --git a/actions/doc.php b/actions/doc.php
index 836f039d3..5df18a859 100644
--- a/actions/doc.php
+++ b/actions/doc.php
@@ -49,7 +49,7 @@ class DocAction extends Action
var $title;
/**
- * Class handler.
+ * Handle a request
*
* @param array $args array of arguments
*
@@ -71,6 +71,7 @@ class DocAction extends Action
}
$c = file_get_contents($this->filename);
+
$this->output = common_markup_to_html($c);
Event::handle('EndLoadDoc', array($this->title, &$this->output));
@@ -79,30 +80,48 @@ class DocAction extends Action
$this->showPage();
}
- // overrrided to add entry-title class
- function showPageTitle() {
+ /**
+ * 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());
}
- // overrided to add hentry, and content-inner classes
+ /**
+ * Block for content.
+ *
+ * Overrides default from Action to wrap everything in an hAtom entry.
+ *
+ * @return void.
+ */
+
function showContentBlock()
- {
- $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');
- }
+ {
+ $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');
+ }
/**
* Display content.
*
- * @return nothing
+ * Shows the content of the document.
+ *
+ * @return void
*/
+
function showContent()
{
$this->raw($this->output);
@@ -111,6 +130,8 @@ class DocAction extends Action
/**
* Page title.
*
+ * Uses the title of the document.
+ *
* @return page title
*/
function title()
@@ -118,6 +139,14 @@ class DocAction extends Action
return ucfirst($this->title);
}
+ /**
+ * These pages are read-only.
+ *
+ * @param array $args unused.
+ *
+ * @return boolean read-only flag (false)
+ */
+
function isReadOnly($args)
{
return true;