uiredesign + phpdocs

1 files changed, 40 insertions, 21 deletions

diff --git a/actions/disfavor.php b/actions/disfavor.php
index d4a189d19..09b3bf18d 100644
--- a/actions/disfavor.php
+++ b/actions/disfavor.php
@@ -1,5 +1,17 @@
 <?php
-/*
+
+/**
+ * Disfavor action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ *
  * Laconica - a distributed open-source microblogging tool
  * Copyright (C) 2008, Controlez-Vous, Inc.
  *
@@ -17,59 +29,65 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
 require_once INSTALLDIR.'/lib/favorform.php';
 
+/**
+ * Disfavor class.
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ */
 class DisfavorAction extends Action
 {
-
+    /**
+     * Class handler.
+     * 
+     * @param array $args query arguments
+     *
+     * @return void
+     */
     function handle($args)
     {
-
         parent::handle($args);
-
         if (!common_logged_in()) {
             $this->clientError(_('Not logged in.'));
             return;
         }
-
         $user = common_current_user();
-
         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
-            common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname)));
+            common_redirect(common_local_url('showfavorites',
+                array('nickname' => $user->nickname)));
             return;
         }
-
-        $id = $this->trimmed('notice');
-
+        $id     = $this->trimmed('notice');
         $notice = Notice::staticGet($id);
-
-        $token = $this->trimmed('token-'.$notice->id);
-
+        $token  = $this->trimmed('token-'.$notice->id);
         if (!$token || $token != common_session_token()) {
             $this->clientError(_("There was a problem with your session token. Try again, please."));
             return;
         }
-
-        $fave = new Fave();
-        $fave->user_id = $this->id;
+        $fave            = new Fave();
+        $fave->user_id   = $this->id;
         $fave->notice_id = $notice->id;
         if (!$fave->find(true)) {
             $this->clientError(_('This notice is not a favorite!'));
             return;
         }
-
         $result = $fave->delete();
-
         if (!$result) {
             common_log_db_error($fave, 'DELETE', __FILE__);
             $this->serverError(_('Could not delete favorite.'));
             return;
         }
-        
         $user->blowFavesCache();
-
         if ($this->boolean('ajax')) {
             $this->startHTML('text/xml;charset=utf-8', true);
             $this->elementStart('head');
@@ -86,3 +104,4 @@ class DisfavorAction extends Action
         }
     }
 }
+