Merge remote-tracking branch 'upstream/master' into social-master

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

diff --git a/actions/apihelptest.php b/actions/apihelptest.php
index 4691cbf99c8f150bac027c69f4c6a0c90dd05471..a41ebc936732a2e8962267e099f61778175db796 100644 (file)
--- a/actions/apihelptest.php
+++ b/actions/apihelptest.php
@@ -21,6 +21,7 @@
  *
  * @category  API
  * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
@@ -31,31 +32,26 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once INSTALLDIR . '/lib/api.php';
-
 /**
  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
  *
  * @category API
  * @package  StatusNet
+ * @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 ApiHelpTestAction extends ApiAction
+class ApiHelpTestAction extends ApiPrivateAuthAction
 {
-
     /**
      * Take arguments for running
      *
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
-    function prepare($args)
+    function prepare(array $args=array())
     {
         parent::prepare($args);
         return true;
@@ -68,8 +64,7 @@ class ApiHelpTestAction extends ApiAction
      *
      * @return void
      */
-
-    function handle($args)
+    function handle(array $args=array())
     {
         parent::handle($args);
 
@@ -83,12 +78,25 @@ class ApiHelpTestAction extends ApiAction
             $this->endDocument('json');
         } else {
             $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
             );
         }
     }
 
+    /**
+     * Return true if read only.
+     *
+     * MAY override
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean is read only action?
+     */
+    function isReadOnly(array $args=array())
+    {
+        return true;
+    }
 }
-