bring messaging section (inbox, outbox, mailbox) into PEAR Code Standards compliance

Actually refactored the method names on these classes to come into
complete compliance with the code standards. Untested; maybe there are
some bad method names now.

darcs-hash:20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz

1 files changed, 110 insertions, 39 deletions

diff --git a/_darcs/pristine/actions/inbox.php b/_darcs/pristine/actions/inbox.php
index c752e404e..da27814a6 100644
--- a/_darcs/pristine/actions/inbox.php
+++ b/_darcs/pristine/actions/inbox.php
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * action handler for message inbox
+ *
+ * PHP version 5
+ *
+ * LICENCE: 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.
@@ -15,41 +18,109 @@
  *
  * 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/>.
+ *
+ * @category  Message
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/mailbox.php';
+
+/**
+ * action handler for message inbox
+ *
+ * @category Message
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ * @see      MailboxAction
  */
 
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/mailbox.php');
-
-class InboxAction extends MailboxAction {
-	
-	function get_title($user, $page) {
-		if ($page > 1) {
-			$title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
-		} else {
-			$title = sprintf(_("Inbox for %s"), $user->nickname);
-		}
-		return $title;
-	}
-	
-	function get_messages($user, $page) {
-		$message = new Message();
-		$message->to_profile = $user->id;
-		$message->orderBy('created DESC, id DESC');
-		$message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
-
-		if ($message->find()) {
-			return $message;
-		} else {
-			return NULL;
-		}
-	}
-	
-	function get_message_profile($message) {
-		return $message->getFrom();
-	}
-	
-	function get_instructions() {
-		return _('This is your inbox, which lists your incoming private messages.');
-	}
+class InboxAction extends MailboxAction
+{
+    /**
+     * returns the title of the page
+     *
+     * @param User $user current user
+     * @param int  $page current page
+     *
+     * @return string localised title of the page
+     *
+     * @see MailboxAction::getTitle()
+     */
+
+    function getTitle($user, $page)
+    {
+        if ($page > 1) {
+            $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
+        } else {
+            $title = sprintf(_("Inbox for %s"), $user->nickname);
+        }
+        return $title;
+    }
+
+    /**
+     * retrieve the messages for this user and this page
+     *
+     * Does a query for the right messages
+     *
+     * @param User $user The current user
+     * @param int  $page The page the user is on
+     *
+     * @return Message data object with stream for messages
+     *
+     * @see MailboxAction::getMessages()
+     */
+
+    function getMessages($user, $page)
+    {
+        $message = new Message();
+
+        $message->to_profile = $user->id;
+
+        $message->orderBy('created DESC, id DESC');
+        $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
+
+        if ($message->find()) {
+            return $message;
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * returns the profile we want to show with the message
+     *
+     * For inboxes, we show the sender.
+     *
+     * @param Message $message The message to get the profile for
+     *
+     * @return Profile The profile of the message sender
+     *
+     * @see MailboxAction::getMessageProfile()
+     */
+
+    function getMessageProfile($message)
+    {
+        return $message->getFrom();
+    }
+
+    /**
+     * instructions for using this page
+     *
+     * @return string localised instructions for using the page
+     */
+
+    function getInstructions()
+    {
+        return _('This is your inbox, which lists your incoming private messages.');
+    }
 }