summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoreliott <eliott@cactuswax.net>2007-10-13 21:27:35 +0200
committerDan McGee <dan@archlinux.org>2008-01-20 06:49:35 +0100
commit36dd7736c993cbcf61228f6e06466a6614939c97 (patch)
tree734bf633c46da10155bff6e8cb806c31e5493be7
parent5e38e3d3d0eff20f8d46bad67c4944a6a1d92ea4 (diff)
downloadaur-36dd7736c993cbcf61228f6e06466a6614939c97.tar.gz
aur-36dd7736c993cbcf61228f6e06466a6614939c97.tar.xz
Moved usage documentation out of the class.
Fixed an issue in the handle class.
-rw-r--r--web/html/rpc.php17
-rw-r--r--web/lib/aurjson.class.php22
2 files changed, 16 insertions, 23 deletions
diff --git a/web/html/rpc.php b/web/html/rpc.php
index 30813912..033cba59 100644
--- a/web/html/rpc.php
+++ b/web/html/rpc.php
@@ -10,9 +10,22 @@ if ( $_SERVER['REQUEST_METHOD'] == 'GET' ) {
if ( isset($_GET['type']) ) {
echo $rpc_o->handle($_GET);
}
- else {
+ else {
+ // dump a simple usage output for people to use.
+ // this could be moved to an api doc in the future, or generated from
+ // the AurJSON class directly with phpdoc. For now though, just putting it here.
echo '<html><body>';
- echo $rpc_o->usage();
+ echo 'The methods currently allowed are: <br />';
+ echo '<ul>';
+ echo '<li>search</li>';
+ echo '<li>info</li>';
+ echo '</ul><br />';
+ echo 'Each method requires the following HTTP GET syntax:<br />';
+ echo '&nbsp;&nbsp; type=<i>methodname</i>&arg=<i>data</i> <br /><br />';
+ echo 'Where <i>methodname</i> is the name of an allowed method, and <i>data</i> is the argument to the call.<br />';
+ echo '<br />';
+ echo 'If you need jsonp type callback specification, you can provide an additional variable <i>callback</i>.<br />';
+ echo 'Example URL: <br />&nbsp;&nbsp; http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103';
echo '</body></html>';
}
}
diff --git a/web/lib/aurjson.class.php b/web/lib/aurjson.class.php
index ce59ed7d..d12f2b54 100644
--- a/web/lib/aurjson.class.php
+++ b/web/lib/aurjson.class.php
@@ -20,33 +20,13 @@ class AurJSON {
private $exposed_methods = array('search','info');
/**
- * Returns the usage data for the exposed json api.
- * @return string The usage data in plain format.
- **/
- public function usage() {
- $usage = 'The methods currently allowed are: <br />';
- $usage .= '<ul>';
- foreach ($this->exposed_methods as $methodname) {
- $usage .= "<li>{$methodname}</li>";
- }
- $usage .= '</ul><br />';
- $usage .= 'Each method requires the following HTTP GET syntax:<br />';
- $usage .= '&nbsp;&nbsp; type=_methodname_&arg=_data_ <br /><br />';
- $usage .= 'Where _methodname_ is the name of an exposed method, and _data_ is the data supplied as part of the call.<br />';
- $usage .= 'The _ characters are included only in this example as placeholders. Do not use them in an actual query.<br /><br />';
- $usage .= 'If you need jsonp type callback specification, you can provide an additional variable "callback".<br />';
- $usage .= 'Example URL: <br />&nbsp;&nbsp; http://aur-url/rpc.php?type=search&args=foobar&callback=jsonp1192244621103';
- return $usage;
- }
-
- /**
* Handles post data, and routes the request.
* @param string $post_data The post data to parse and handle.
* @return string The JSON formatted response data.
**/
public function handle($http_data) {
// set content type header to json
- //header('content-type: application/json');
+ header('content-type: application/json');
// set up db connection.
$this->dbh = db_connect();