Add/update translator documentation.

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

diff --git a/actions/apistatusesshow.php b/actions/apistatusesshow.php
index 86ffd6862eb13b9bcc448c658e3f0fb1865bf1f9..13cc88c2c73bcc6c53d67ae3e6b4a78c559bf1ca 100644 (file)
--- a/actions/apistatusesshow.php
+++ b/actions/apistatusesshow.php
@@ -55,10 +55,8 @@ require_once INSTALLDIR . '/lib/apiprivateauth.php';
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
 class ApiStatusesShowAction extends ApiPrivateAuthAction
 {
-
     var $notice_id = null;
     var $notice    = null;
 
@@ -68,9 +66,7 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
     function prepare($args)
     {
         parent::prepare($args);
@@ -100,12 +96,12 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
      *
      * @return void
      */
-
     function handle($args)
     {
         parent::handle($args);
 
         if (!in_array($this->format, array('xml', 'json', 'atom'))) {
+            // TRANS: Client error displayed when coming across a non-supported API method.
             $this->clientError(_('API method not found.'), 404);
             return;
         }
@@ -118,6 +114,7 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
             $this->deleteNotice();
             break;
         default:
+            // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
             $this->clientError(_('HTTP method not supported.'), 405);
             return;
         }
@@ -128,7 +125,6 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
      *
      * @return void
      */
-
     function showNotice()
     {
         if (!empty($this->notice)) {
@@ -143,10 +139,11 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
                 $this->showSingleAtomStatus($this->notice);
                 break;
             default:
-                throw new Exception(sprintf(_("Unsupported format: %s"), $this->format));
+                // TRANS: Exception thrown requesting an unsupported notice output format.
+                // TRANS: %s is the requested output format.
+                throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
             }
         } else {
-
             // XXX: Twitter just sets a 404 header and doens't bother
             // to return an err msg
 
@@ -154,12 +151,14 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
 
             if (!empty($deleted)) {
                 $this->clientError(
+                    // TRANS: Client error displayed requesting a deleted status.
                     _('Status deleted.'),
                     410,
                     $this->format
                 );
             } else {
                 $this->clientError(
+                    // TRANS: Client error displayed requesting a status with an invalid ID.
                     _('No status with that ID found.'),
                     404,
                     $this->format
@@ -169,7 +168,7 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
     }
 
     /**
-     * Is this action read only?
+     * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
      *
      * @param array $args other arguments
      *
@@ -178,7 +177,7 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
 
     function isReadOnly($args)
     {
-        return true;
+        return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
     }
 
     /**
@@ -186,7 +185,6 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
      *
      * @return string datestamp of the latest notice in the stream
      */
-
     function lastModified()
     {
         if (!empty($this->notice)) {
@@ -204,7 +202,6 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
      *
      * @return string etag
      */
-
     function etag()
     {
         if (!empty($this->notice)) {
@@ -226,14 +223,16 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
     function deleteNotice()
     {
         if ($this->format != 'atom') {
-            $this->clientError(_("Can only delete using the Atom format."));
+            // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
+            $this->clientError(_('Can only delete using the Atom format.'));
             return;
         }
 
         if (empty($this->auth_user) ||
             ($this->notice->profile_id != $this->auth_user->id &&
              !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
-            $this->clientError(_('Can\'t delete this notice.'), 403);
+            // TRANS: Client error displayed when a user has no rights to delete notices of other users.
+            $this->clientError(_('Cannot delete this notice.'), 403);
             return;
         }
 
@@ -246,6 +245,7 @@ class ApiStatusesShowAction extends ApiPrivateAuthAction
 
         header('HTTP/1.1 200 OK');
         header('Content-Type: text/plain');
+        // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
         print(sprintf(_('Deleted notice %d'), $this->notice->id));
         print("\n");
     }