*
* @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
* @link http://status.net/
*/
-if (!defined('STATUSNET')) {
- exit(1);
-}
-
-require_once INSTALLDIR . '/lib/api.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* 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 TwitterApiAction
+class ApiHelpTestAction extends ApiPrivateAuthAction
{
-
- /**
- * Take arguments for running
- *
- * @param array $args $_REQUEST args
- *
- * @return boolean success flag
- *
- */
-
- function prepare($args)
- {
- parent::prepare($args);
- return true;
- }
-
- /**
- * Handle the request
- *
- * @param array $args $_REQUEST data (unused)
- *
- * @return void
- */
-
- function handle($args)
+ protected function handle()
{
- parent::handle($args);
+ parent::handle();
if ($this->format == 'xml') {
- $this->init_document('xml');
+ $this->initDocument('xml');
$this->element('ok', null, 'true');
- $this->end_document('xml');
+ $this->endDocument('xml');
} elseif ($this->format == 'json') {
- $this->init_document('json');
+ $this->initDocument('json');
print '"ok"';
- $this->end_document('json');
+ $this->endDocument('json');
} else {
- $this->clientError(
- _('API method not found!'),
- 404,
- $this->format
- );
+ // TRANS: Client error displayed when coming across a non-supported API method.
+ throw new ClientException(_('API method not found.'), 404);
}
}
+ /**
+ * Return true if read only.
+ *
+ * MAY override
+ *
+ * @param array $args other arguments
+ *
+ * @return boolean is read only action?
+ */
+ function isReadOnly($args)
+ {
+ return true;
+ }
}
-