Update shownotice for new framework, make phpcs-clean

actions/shownotice.php

@@ -1,9 +1,12 @@
 <?php
-/*
+/**
- * Laconica - a distributed open-source microblogging tool
+ * Laconica, the distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
  *
- * This program is free software: you can redistribute it and/or modify
+ * Show a single notice
+ *
+ * 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,25 +18,69 @@
  *
  * 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  Personal
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 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); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/stream.php');
+require_once INSTALLDIR.'/lib/personalgroupnav.php';
+require_once INSTALLDIR.'/lib/noticelist.php';
+require_once INSTALLDIR.'/lib/feedlist.php';
 
-class ShownoticeAction extends StreamAction
+/**
+ * Show a single notice
+ *
+ * @category Personal
+ * @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/
+ */
+
+class ShownoticeAction extends Action
 {
+    /**
+     * Notice object to show
+     */
 
     var $notice = null;
+
+    /**
+     * Profile of the notice object
+     */
+
     var $profile = null;
+
+    /**
+     * Avatar of the profile of the notice object
+     */
+
     var $avatar = null;
 
+    /**
+     * Load attributes based on database arguments
+     *
+     * Loads all the DB stuff
+     *
+     * @param array $args $_REQUEST array
+     *
+     * @return success flag
+     */
+
     function prepare($args)
     {
-
         parent::prepare($args);
 
         $id = $this->arg('notice');
+
         $this->notice = Notice::staticGet($id);
 
         if (!$this->notice) {
@@ -53,45 +100,112 @@ class ShownoticeAction extends StreamAction
         return true;
     }
 
-    function last_modified()
+    /**
+     * Is this action read-only?
+     *
+     * @return boolean true
+     */
+
+    function isReadOnly()
+    {
+        return true;
+    }
+
+    /**
+     * Last-modified date for page
+     *
+     * When was the content of this page last modified? Based on notice,
+     * profile, avatar.
+     *
+     * @return int last-modified date as unix timestamp
+     */
+
+    function lastModified()
     {
         return max(strtotime($this->notice->created),
                    strtotime($this->profile->modified),
                    ($this->avatar) ? strtotime($this->avatar->modified) : 0);
     }
 
+    /**
+     * An entity tag for this page
+     *
+     * Shows the ETag for the page, based on the notice ID and timestamps
+     * for the notice, profile, and avatar. It's weak, since we change
+     * the date text "one hour ago", etc.
+     *
+     * @return string etag
+     */
+
     function etag()
     {
+        $avtime = ($this->avatar) ?
+          strtotime($this->avatar->modified) : 0;
+
         return 'W/"' . implode(':', array($this->arg('action'),
                                           common_language(),
                                           $this->notice->id,
                                           strtotime($this->notice->created),
                                           strtotime($this->profile->modified),
-                                          ($this->avatar) ? strtotime($this->avatar->modified) : 0)) . '"';
+                                          $avtime)) . '"';
     }
 
+    /**
+     * Title of the page
+     *
+     * @return string title of the page
+     */
+
+    function title()
+    {
+        return sprintf(_('%1$s\'s status on %2$s'),
+                       $this->profile->nickname,
+                       common_exact_date($this->notice->created));
+    }
+
+    /**
+     * Handle input
+     *
+     * Only handles get, so just show the page.
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
     function handle($args)
     {
-
         parent::handle($args);
 
-        common_show_header(sprintf(_('%1$s\'s status on %2$s'),
+        $this->showPage();
-                                   $this->profile->nickname,
-                                   common_exact_date($this->notice->created)),
-                           array($this, 'show_header'), null,
-                           array($this, 'show_top'));
-
-        $this->elementStart('ul', array('id' => 'notices'));
-        $nli = new NoticeListItem($this->notice);
-        $nli->show();
-        $this->elementEnd('ul');
-
-        common_show_footer();
     }
 
-    function show_header()
+    /**
-    {
+     * Fill the content area of the page
+     *
+     * Shows a single notice list item.
+     *
+     * @return void
+     */
 
+    function showContent()
+    {
+        $this->elementStart('ul', array('id' => 'notices'));
+        $nli = new NoticeListItem($this->notice, $this);
+        $nli->show();
+        $this->elementEnd('ul');
+    }
+
+    /**
+     * Extra <head> content
+     *
+     * We show the microid(s) for the author, if any.
+     *
+     * @return void
+     */
+
+    function extraHead()
+    {
         $user = User::staticGet($this->profile->id);
 
         if (!$user) {
@@ -99,26 +213,17 @@ class ShownoticeAction extends StreamAction
         }
 
         if ($user->emailmicroid && $user->email && $this->notice->uri) {
+            $id = new Microid('mailto:'. $user->email,
+                              $this->notice->uri);
             $this->element('meta', array('name' => 'microid',
-                                         'content' => "mailto+http:sha1:" . sha1(sha1('mailto:' . $user->email) . sha1($this->notice->uri))));
+                                         'content' => $id->toString()));
         }
 
         if ($user->jabbermicroid && $user->jabber && $this->notice->uri) {
+            $id = new Microid('xmpp:', $user->jabber,
+                              $this->notice->uri);
             $this->element('meta', array('name' => 'microid',
-                                         'content' => "xmpp+http:sha1:" . sha1(sha1('xmpp:' . $user->jabber) . sha1($this->notice->uri))));
+                                         'content' => $id->toString()));
         }
     }
-
-    function show_top()
-    {
-        $cur = common_current_user();
-        if ($cur && $cur->id == $this->profile->id) {
-            common_notice_form();
-        }
-    }
-
-    function no_such_notice()
-    {
-        $this->clientError(_('No such notice.'));
-    }
 }