Fix translator documentation.

[quix0rs-gnu-social.git] / actions / apifavoritedestroy.php

diff --git a/actions/apifavoritedestroy.php b/actions/apifavoritedestroy.php
index aac866d7e9f5f17e7f038247ec1238b526283009..db121ac882a21dadabd6cff34eadf10e2f1212a2 100644 (file)
--- a/actions/apifavoritedestroy.php
+++ b/actions/apifavoritedestroy.php
@@ -21,8 +21,11 @@
  *
  * @category  API
  * @package   StatusNet
+ * @author    Craig Andrews <candrews@integralblue.com>
+ * @author    Evan Prodromou <evan@status.net>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009 StatusNet, Inc.
+ * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
@@ -31,7 +34,7 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once INSTALLDIR.'/lib/apiauth.php';
+require_once INSTALLDIR . '/lib/apiauth.php';
 
 /**
  * Un-favorites the status specified in the ID parameter as the authenticating user.
@@ -39,15 +42,14 @@ require_once INSTALLDIR.'/lib/apiauth.php';
  *
  * @category API
  * @package  StatusNet
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @author   Evan Prodromou <evan@status.net>
  * @author   Zach Copley <zach@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
 class ApiFavoriteDestroyAction extends ApiAuthAction
 {
-
-    var $user   = null;
     var $notice = null;
 
     /**
@@ -56,9 +58,7 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
     function prepare($args)
     {
         parent::prepare($args);
@@ -78,13 +78,13 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
      *
      * @return void
      */
-
     function handle($args)
     {
         parent::handle($args);
 
         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
             $this->clientError(
+                // TRANS: Client error. POST is a HTTP command. It should not be translated.
                 _('This method requires a POST.'),
                 400,
                 $this->format
@@ -94,7 +94,8 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
 
         if (!in_array($this->format, array('xml', 'json'))) {
             $this->clientError(
-                _('API method not found!'),
+                // TRANS: Client error displayed when coming across a non-supported API method.
+                _('API method not found.'),
                 404,
                 $this->format
             );
@@ -103,6 +104,7 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
 
         if (empty($this->notice)) {
             $this->clientError(
+                // TRANS: Client error displayed when trying to remove a favourite with an invalid ID.
                 _('No status found with that ID.'),
                 404,
                 $this->format
@@ -116,7 +118,8 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
 
         if (!$fave->find(true)) {
             $this->clientError(
-                _('That status is not a favorite!'),
+                // TRANS: Client error displayed when trying to remove a favourite that was not a favourite.
+                _('That status is not a favorite.'),
                 403,
                 $this->favorite
             );
@@ -128,6 +131,7 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
         if (!$result) {
             common_log_db_error($fave, 'DELETE', __FILE__);
             $this->clientError(
+                // TRANS: Client error displayed when removing a favourite has failed.
                 _('Could not delete favorite.'),
                 404,
                 $this->format
@@ -143,5 +147,4 @@ class ApiFavoriteDestroyAction extends ApiAuthAction
             $this->show_single_json_status($this->notice);
         }
     }
-
 }