Skip to content

Commit

Permalink
Added "chat" and "connections" streams. Closes #16.
Browse files Browse the repository at this point in the history
Added method calls for the whitelist and the blacklists. Closes #17.

Updated docs.

Fixed bugs.
  • Loading branch information
alecgorge committed Apr 11, 2011
1 parent ed0ce04 commit 9b6c1a8
Show file tree
Hide file tree
Showing 29 changed files with 559 additions and 160 deletions.
35 changes: 31 additions & 4 deletions docs/html/index.html
Expand Up @@ -296,7 +296,7 @@
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>getFileContents</li>
<li class="method-info-desc"><strong>Description: </strong>Gets the contents of the specified file.</li>
<li class="method-info-desc"><strong>Description: </strong>Gets the contents of the specified file. The file path is relative to the folder that the craftbukkit jar is in.</li>
<li class="method-info-args"><strong>Arguments: </strong><ul class='method-info-args-ul'><li><strong>String</strong> The name of the file to read.</li></ul></li>
<li class="method-info-return"><strong>Returns: </strong><strong>String</strong> The file's contents.</li>
</ul>
Expand All @@ -305,7 +305,7 @@
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>setFileContents</li>
<li class="method-info-desc"><strong>Description: </strong>Sets (not appends to) the contents of the specified file.</li>
<li class="method-info-desc"><strong>Description: </strong>Sets (not appends to) the contents of the specified file. The file path is relative to the folder that the craftbukkit jar is in.</li>
<li class="method-info-args"><strong>Arguments: </strong><ul class='method-info-args-ul'><li><strong>String</strong> The name of the file to read.</li><li><strong>String</strong> The content to put in the file.</li></ul></li>
<li class="method-info-return"><strong>Returns: </strong><strong>boolean</strong> True if call succeeded. False will never be returned, instead an exception will be thrown and the call will not return as successful. This will occur if the specified file does not exist.</li>
</ul>
Expand All @@ -314,7 +314,7 @@
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>editPropertiesFile</li>
<li class="method-info-desc"><strong>Description: </strong>Sets the specified key of the specified file to the specified value with the specified type.</li>
<li class="method-info-desc"><strong>Description: </strong>Sets the specified key of the specified file to the specified value with the specified type. The file path is relative to the folder that the craftbukkit jar is in.</li>
<li class="method-info-args"><strong>Arguments: </strong><ul class='method-info-args-ul'><li><strong>String</strong> The name of the .properties file to edit WITHOUT the extentions. (server, not server.properties)</li><li><strong>String</strong> The type of value. Options are boolean, long, int, string and double.</li><li><strong>String</strong> The key that will have value set to it.</li><li><strong>String</strong> The value to set key to as A STRING. This means that true will be come "true" and 1.5 will become "1.5".</li></ul></li>
<li class="method-info-return"><strong>Returns: </strong><strong>boolean</strong> True if call succeeded. False will never be returned, instead an exception will be thrown and the call will not return as successful. This will occur if the specified file does not exist.</li>
</ul>
Expand All @@ -323,11 +323,38 @@
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>getPropertiesFile</li>
<li class="method-info-desc"><strong>Description: </strong>Gets a key value set for the specified properties file.</li>
<li class="method-info-desc"><strong>Description: </strong>Gets a key value set for the specified properties file. The file path is relative to the folder that the craftbukkit jar is in.</li>
<li class="method-info-args"><strong>Arguments: </strong><ul class='method-info-args-ul'><li><strong>String</strong> The name of the properties file to read.</li></ul></li>
<li class="method-info-return"><strong>Returns: </strong><strong>Object</strong> A key value set for the specified properties file.</li>
</ul>
<br class="clear" />
</div>
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>getWhitelist</li>
<li class="method-info-desc"><strong>Description: </strong>Gets the players on the whitelist.</li>
<li class="method-info-args"><strong>Arguments: </strong>None</li>
<li class="method-info-return"><strong>Returns: </strong><strong>Array</strong> Returns an array of strings; where each item in the array is a string that contains a player's name.</li>
</ul>
<br class="clear" />
</div>
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>getBannedPlayers</li>
<li class="method-info-desc"><strong>Description: </strong>Gets the players on the ban list.</li>
<li class="method-info-args"><strong>Arguments: </strong>None</li>
<li class="method-info-return"><strong>Returns: </strong><strong>Array</strong> Returns an array of strings; where each item in the array is a string that contains a player's name.</li>
</ul>
<br class="clear" />
</div>
<div class="method-wrapper">
<ul class="method-info">
<li class="method-info-name"><strong>Name: </strong>getBannedIPs</li>
<li class="method-info-desc"><strong>Description: </strong>Gets the IPs on the ban list.</li>
<li class="method-info-args"><strong>Arguments: </strong>None</li>
<li class="method-info-return"><strong>Returns: </strong><strong>Array</strong> Returns an array of strings; where each item in the array is a string that contains an IP address.</li>
</ul>
<br class="clear" />
</div>
</div> </body>
</html>
2 changes: 1 addition & 1 deletion sdk/php/docs/allitems-frame.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/deprecated-list.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
4 changes: 3 additions & 1 deletion sdk/php/docs/index-all.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down Expand Up @@ -61,6 +61,8 @@ <h1 id="letterJ">J</h1>
<h1 id="letterM">M</h1>
<dl>
<dt><a href="jsonapi/jsonapi.html#makeURL()">makeURL()</a> - Method in class <a href="jsonapi/jsonapi.html">JSONAPI\JSONAPI</a></dt>
<dd>Generates the proper URL for a standard API call the given method and arguments.</dd>
<dt><a href="jsonapi/jsonapi.html#makeURLMultiple()">makeURLMultiple()</a> - Method in class <a href="jsonapi/jsonapi.html">JSONAPI\JSONAPI</a></dt>
<dd>Generates the proper URL for a multiple API call the given method and arguments.</dd>
</dl>
<div class="header">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/index.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
34 changes: 27 additions & 7 deletions sdk/php/docs/jsonapi/jsonapi.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down Expand Up @@ -85,7 +85,11 @@ <h1>Class JSONAPI</h1>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#makeURL()">makeURL</a>(array methods, array args)</p><p class="description">Generates the proper URL for a multiple API call the given method and arguments.</p></td>
<td class="description"><p class="name"><a href="#makeURL()">makeURL</a>(string method, array args)</p><p class="description">Generates the proper URL for a standard API call the given method and arguments.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#makeURLMultiple()">makeURLMultiple</a>(array methods, array args)</p><p class="description">Generates the proper URL for a multiple API call the given method and arguments.</p></td>
</tr>
</table>

Expand All @@ -99,7 +103,7 @@ <h3 id="__construct()">__construct</h3>

<hr>

<a href="../source/jsonapi.php.html#line77" class="location">JSONAPI.php at line 77</a>
<a href="../source/jsonapi.php.html#line80" class="location">JSONAPI.php at line 80</a>

<h3 id="call()">call</h3>
<code class="signature">public array <strong>call</strong>(string method, array args)</code>
Expand All @@ -115,7 +119,7 @@ <h3 id="call()">call</h3>

<hr>

<a href="../source/jsonapi.php.html#line111" class="location">JSONAPI.php at line 111</a>
<a href="../source/jsonapi.php.html#line114" class="location">JSONAPI.php at line 114</a>

<h3 id="callMultiple()">callMultiple</h3>
<code class="signature">public array <strong>callMultiple</strong>(array methods, array args)</code>
Expand Down Expand Up @@ -148,17 +152,33 @@ <h3 id="createKey()">createKey</h3>

<hr>

<a href="../source/jsonapi.php.html#line66" class="location">JSONAPI.php at line 66</a>
<a href="../source/jsonapi.php.html#line58" class="location">JSONAPI.php at line 58</a>

<h3 id="makeURL()">makeURL</h3>
<code class="signature">public string <strong>makeURL</strong>(array methods, array args)</code>
<code class="signature">public string <strong>makeURL</strong>(string method, array args)</code>
<div class="details">
<p>Generates the proper URL for a standard API call the given method and arguments.</p><dl>
<dt>Parameters:</dt>
<dd>method - The name of the JSONAPI API method to generate the URL for.</dd>
<dd>args - An array of arguments that are to be passed in the URL.</dd>
<dt>Returns:</dt>
<dd>A proper standard JSONAPI API call URL. Example: "http://localhost:20059/api/call?method=methodName&args=jsonEncodedArgsArray&key=validKey".</dd>
</dl>
</div>

<hr>

<a href="../source/jsonapi.php.html#line69" class="location">JSONAPI.php at line 69</a>

<h3 id="makeURLMultiple()">makeURLMultiple</h3>
<code class="signature">public string <strong>makeURLMultiple</strong>(array methods, array args)</code>
<div class="details">
<p>Generates the proper URL for a multiple API call the given method and arguments.</p><dl>
<dt>Parameters:</dt>
<dd>methods - An array of strings, where each string is the name of the JSONAPI API method to generate the URL for.</dd>
<dd>args - An array of arrays, where each array contains the arguments that are to be passed in the URL.</dd>
<dt>Returns:</dt>
<dd>A proper multiple JSONAPI API call URL. Example: "http://localhost:20059/api/call?method=methodName&args=jsonEncodedArgs&key=validKey".</dd>
<dd>A proper multiple JSONAPI API call URL. Example: "http://localhost:20059/api/call-multiple?method=[methodName,methodName2]&args=jsonEncodedArrayOfArgsArrays&key=validKey".</dd>
</dl>
</div>

Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/jsonapi/package-frame.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/jsonapi/package-functions.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/jsonapi/package-globals.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/jsonapi/package-summary.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/jsonapi/package-tree.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/overview-files.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/overview-frame.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/overview-summary.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down
2 changes: 1 addition & 1 deletion sdk/php/docs/overview-tree.html
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Thu, 07 Apr 2011 00:03:44 +0000">
<meta name="when" content="Mon, 11 Apr 2011 23:08:46 +0000">

<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
Expand Down

0 comments on commit 9b6c1a8

Please sign in to comment.