PHP SDK documentation based on apache/predictionio-sdk-php#de58c85bfcf07c82d1f57c33221fa7dae998a34c
Project: http://git-wip-us.apache.org/repos/asf/predictionio-site/repo Commit: http://git-wip-us.apache.org/repos/asf/predictionio-site/commit/721427d5 Tree: http://git-wip-us.apache.org/repos/asf/predictionio-site/tree/721427d5 Diff: http://git-wip-us.apache.org/repos/asf/predictionio-site/diff/721427d5 Branch: refs/heads/asf-site Commit: 721427d514442c0b0eeb0f42a76105bc0eea61f7 Parents: 38bcf03 Author: jenkins <[email protected]> Authored: Fri Sep 14 19:26:10 2018 +0000 Committer: jenkins <[email protected]> Committed: Fri Sep 14 19:26:10 2018 +0000 ---------------------------------------------------------------------- sdk/php/api/404.html | 99 ++ sdk/php/api/class-predictionio.BaseClient.html | 296 ++++ .../api/class-predictionio.EngineClient.html | 260 ++++ sdk/php/api/class-predictionio.EventClient.html | 675 +++++++++ sdk/php/api/class-predictionio.Exporter.html | 255 ++++ .../api/class-predictionio.FileExporter.html | 251 ++++ ...class-predictionio.PredictionIOAPIError.html | 183 +++ sdk/php/api/elementlist.js | 3 + sdk/php/api/index.html | 103 ++ sdk/php/api/namespace-predictionio.html | 136 ++ sdk/php/api/resources/collapsed.png | Bin 0 -> 238 bytes sdk/php/api/resources/combined.js | 1347 ++++++++++++++++++ sdk/php/api/resources/footer.png | Bin 0 -> 7948 bytes sdk/php/api/resources/inherit.png | Bin 0 -> 152 bytes sdk/php/api/resources/resize.png | Bin 0 -> 216 bytes sdk/php/api/resources/sort.png | Bin 0 -> 171 bytes sdk/php/api/resources/style.css | 619 ++++++++ sdk/php/api/resources/tree-cleaner.png | Bin 0 -> 126 bytes sdk/php/api/resources/tree-hasnext.png | Bin 0 -> 128 bytes sdk/php/api/resources/tree-last.png | Bin 0 -> 172 bytes sdk/php/api/resources/tree-vertical.png | Bin 0 -> 127 bytes .../source-class-predictionio.BaseClient.html | 179 +++ .../source-class-predictionio.EngineClient.html | 150 ++ .../source-class-predictionio.EventClient.html | 405 ++++++ .../api/source-class-predictionio.Exporter.html | 176 +++ .../source-class-predictionio.FileExporter.html | 140 ++ ...class-predictionio.PredictionIOAPIError.html | 120 ++ 27 files changed, 5397 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/404.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/404.html b/sdk/php/api/404.html new file mode 100644 index 0000000..ac80ac5 --- /dev/null +++ b/sdk/php/api/404.html @@ -0,0 +1,99 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + <meta name="robots" content="noindex"> + + <title>Page not found | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">predictionio\BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">predictionio\EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">predictionio\EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">predictionio\FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">predictionio\Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> +<span>Namespace</span> </li> + <li> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content"> + <h1>Page not found</h1> + <p>The requested page could not be found.</p> + <p>You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.</p> + <p>To continue please try to find requested page in the menu, or use search field on the top.</p> +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js?9c4f6659aff2cc5d1f5e2a4982182f7cbd554a5f"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.BaseClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.BaseClient.html b/sdk/php/api/class-predictionio.BaseClient.html new file mode 100644 index 0000000..314d6ca --- /dev/null +++ b/sdk/php/api/class-predictionio.BaseClient.html @@ -0,0 +1,296 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Class predictionio\BaseClient | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li class="active"><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Class BaseClient</h1> + + + <div class="description"> + <p>Base client for Event and Engine client</p> + </div> + + + + <div> + <h4>Direct known subclasses</h4> + <a href="class-predictionio.EngineClient.html">predictionio\EngineClient</a>, + <a href="class-predictionio.EventClient.html">predictionio\EventClient</a> + </div> + + + + + + + <div class="info"> + <b>Abstract</b><br> + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + + + <b>Located at</b> <a href="source-class-predictionio.BaseClient.html#23-84" title="Go to source code">predictionio/BaseClient.php</a> + <br> + </div> + + + + <table class="summary methods" id="methods"> + <caption>Methods summary</caption> + <tr data-order="__construct" id="___construct"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#___construct">#</a> + <code><a href="source-class-predictionio.BaseClient.html#32-45" title="Go to source code">__construct</a>( <span>string <var>$baseUrl</var></span>, <span>float <var>$timeout</var></span>, <span>float <var>$connectTimeout</var></span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$baseUrl</var></dt> + <dd>Base URL to the server</dd> + <dt><var>$timeout</var></dt> + <dd>Timeout of the request in seconds. Use 0 to wait indefinitely</dd> + <dt><var>$connectTimeout</var></dt> + <dd>Number of seconds to wait while trying to connect to a server</dd> + </dl></div> + + + + + + </div> + </div></td> + </tr> + <tr data-order="getStatus" id="_getStatus"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_getStatus">#</a> + <code><a href="source-class-predictionio.BaseClient.html#47-55" title="Go to source code">getStatus</a>( )</code> + + <div class="description short"> + <p>Get the status of the Event Server or Engine Instance</p> + </div> + + <div class="description detailed hidden"> + <p>Get the status of the Event Server or Engine Instance</p> + + + + <h4>Returns</h4> + <div class="list"> + string<br>status + </div> + + + + + </div> + </div></td> + </tr> + <tr data-order="sendRequest" id="_sendRequest"> + + <td class="attributes"><code> + protected + + array + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_sendRequest">#</a> + <code><a href="source-class-predictionio.BaseClient.html#57-83" title="Go to source code">sendRequest</a>( <span>string <var>$method</var></span>, <span>string <var>$url</var></span>, <span>string <var>$body</var></span> )</code> + + <div class="description short"> + <p>Send a HTTP request to the server</p> + </div> + + <div class="description detailed hidden"> + <p>Send a HTTP request to the server</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$method</var></dt> + <dd>HTTP request method</dd> + <dt><var>$url</var></dt> + <dd>Relative or absolute url</dd> + <dt><var>$body</var></dt> + <dd>HTTP request body</dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + array<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + </table> + + + + + + + + + + + + + <table class="summary properties" id="properties"> + <caption>Properties summary</caption> + <tr data-order="client" id="$client"> + <td class="attributes"><code> + public + + </code></td> + + <td class="name"> + <a href="source-class-predictionio.BaseClient.html#30" title="Go to source code"><var>$client</var></a> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + </div> + </td> + <td class="value"> + <div> + <a href="#$client" class="anchor">#</a> + <code></code> + </div> + </td> + </tr> + </table> + + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.EngineClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.EngineClient.html b/sdk/php/api/class-predictionio.EngineClient.html new file mode 100644 index 0000000..15db0d8 --- /dev/null +++ b/sdk/php/api/class-predictionio.EngineClient.html @@ -0,0 +1,260 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Class predictionio\EngineClient | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li class="active"><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Class EngineClient</h1> + + + <div class="description"> + <p>Client for connecting to an Engine Instance</p> + </div> + + <dl class="tree"> + <dd style="padding-left:0px"> + <a href="class-predictionio.BaseClient.html"><span>predictionio\BaseClient</span></a> + + + + </dd> + <dd style="padding-left:30px"> + <img src="resources/inherit.png" alt="Extended by"> +<b><span>predictionio\EngineClient</span></b> + + + </dd> + </dl> + + + + + + + + + <div class="info"> + + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + + + <b>Located at</b> <a href="source-class-predictionio.EngineClient.html#20-55" title="Go to source code">predictionio/EngineClient.php</a> + <br> + </div> + + + + <table class="summary methods" id="methods"> + <caption>Methods summary</caption> + <tr data-order="__construct" id="___construct"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#___construct">#</a> + <code><a href="source-class-predictionio.EngineClient.html#27-40" title="Go to source code">__construct</a>( <span>string <var>$baseUrl</var> = <span class="php-quote">"http://localhost:8000"</span></span>, <span>float <var>$timeout</var> = <span class="php-num">0</span></span>, <span>float <var>$connectTimeout</var> = <span class="php-num">5</span> </span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$baseUrl</var></dt> + <dd>URL to the Engine Instance. Default is localhost:8000.</dd> + <dt><var>$timeout</var></dt> + <dd><p>of the request in seconds. Use 0 to wait indefinitely + Default is 0.</p></dd> + <dt><var>$connectTimeout</var></dt> + <dd><p>of seconds to wait while trying to connect to a server. + Default is 5.</p></dd> + </dl></div> + + + + + <h4>Overrides</h4> + <div class="list"><code><a href="class-predictionio.BaseClient.html#___construct">predictionio\BaseClient::__construct()</a></code></div> + + </div> + </div></td> + </tr> + <tr data-order="sendQuery" id="_sendQuery"> + + <td class="attributes"><code> + public + + array + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_sendQuery">#</a> + <code><a href="source-class-predictionio.EngineClient.html#42-54" title="Go to source code">sendQuery</a>( <span>array <var>$query</var></span> )</code> + + <div class="description short"> + <p>Send prediction query to an Engine Instance</p> + </div> + + <div class="description detailed hidden"> + <p>Send prediction query to an Engine Instance</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$query</var></dt> + <dd>Query</dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + array<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + </table> + + <table class="summary inherited"> + <caption>Methods inherited from <a href="class-predictionio.BaseClient.html#methods">predictionio\BaseClient</a></caption> + <tr> + <td><code> + <a href="class-predictionio.BaseClient.html#_getStatus">getStatus()</a>, + <a href="class-predictionio.BaseClient.html#_sendRequest">sendRequest()</a> + </code></td> + </tr> + </table> + + + + + + + + + + + + + <table class="summary inherited"> + <caption>Properties inherited from <a href="class-predictionio.BaseClient.html#properties">predictionio\BaseClient</a></caption> + <tr> + <td><code> + <a href="class-predictionio.BaseClient.html#$client"><var>$client</var></a> + </code></td> + </tr> + </table> + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.EventClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.EventClient.html b/sdk/php/api/class-predictionio.EventClient.html new file mode 100644 index 0000000..2ed4581 --- /dev/null +++ b/sdk/php/api/class-predictionio.EventClient.html @@ -0,0 +1,675 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Class predictionio\EventClient | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li class="active"><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Class EventClient</h1> + + + <div class="description"> + <p>Client for connecting to an Event Server</p> + </div> + + <dl class="tree"> + <dd style="padding-left:0px"> + <a href="class-predictionio.BaseClient.html"><span>predictionio\BaseClient</span></a> + + + + </dd> + <dd style="padding-left:30px"> + <img src="resources/inherit.png" alt="Extended by"> +<b><span>predictionio\EventClient</span></b> + + + </dd> + </dl> + + + + + + + + + <div class="info"> + + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + + + <b>Located at</b> <a href="source-class-predictionio.EventClient.html#23-310" title="Go to source code">predictionio/EventClient.php</a> + <br> + </div> + + + + <table class="summary methods" id="methods"> + <caption>Methods summary</caption> + <tr data-order="__construct" id="___construct"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#___construct">#</a> + <code><a href="source-class-predictionio.EventClient.html#33-50" title="Go to source code">__construct</a>( <span>string <var>$accessKey</var></span>, <span>string <var>$baseUrl</var> = <span class="php-quote">'http://localhost:7070'</span></span>, <span>float <var>$timeout</var> = <span class="php-num">0</span></span>, <span>float <var>$connectTimeout</var> = <span class="php-num">5</span> </span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$accessKey</var></dt> + <dd>Key</dd> + <dt><var>$baseUrl</var></dt> + <dd>URL to the Event Server. Default is localhost:7070.</dd> + <dt><var>$timeout</var></dt> + <dd><p>of the request in seconds. Use 0 to wait indefinitely + Default is 0.</p></dd> + <dt><var>$connectTimeout</var></dt> + <dd><p>of seconds to wait while trying to connect to a server. + Default is 5.</p></dd> + </dl></div> + + + + + <h4>Overrides</h4> + <div class="list"><code><a href="class-predictionio.BaseClient.html#___construct">predictionio\BaseClient::__construct()</a></code></div> + + </div> + </div></td> + </tr> + <tr data-order="setUser" id="_setUser"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_setUser">#</a> + <code><a href="source-class-predictionio.EventClient.html#62-93" title="Go to source code">setUser</a>( <span>integer|string <var>$uid</var></span>, <span>array <var>$properties</var> = <span class="php-keyword1">array</span>()</span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Set a user entity</p> + </div> + + <div class="description detailed hidden"> + <p>Set a user entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$uid</var></dt> + <dd>Id</dd> + <dt><var>$properties</var></dt> + <dd>of the user entity to set</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="unsetUser" id="_unsetUser"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_unsetUser">#</a> + <code><a href="source-class-predictionio.EventClient.html#95-124" title="Go to source code">unsetUser</a>( <span>integer|string <var>$uid</var></span>, <span>array <var>$properties</var></span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Unset a user entity</p> + </div> + + <div class="description detailed hidden"> + <p>Unset a user entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$uid</var></dt> + <dd>Id</dd> + <dt><var>$properties</var></dt> + <dd>of the user entity to unset</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="deleteUser" id="_deleteUser"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_deleteUser">#</a> + <code><a href="source-class-predictionio.EventClient.html#126-150" title="Go to source code">deleteUser</a>( <span>integer|string <var>$uid</var></span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Delete a user entity</p> + </div> + + <div class="description detailed hidden"> + <p>Delete a user entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$uid</var></dt> + <dd>Id</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="setItem" id="_setItem"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_setItem">#</a> + <code><a href="source-class-predictionio.EventClient.html#152-180" title="Go to source code">setItem</a>( <span>integer|string <var>$iid</var></span>, <span>array <var>$properties</var> = <span class="php-keyword1">array</span>()</span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Set an item entity</p> + </div> + + <div class="description detailed hidden"> + <p>Set an item entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$iid</var></dt> + <dd>Id</dd> + <dt><var>$properties</var></dt> + <dd>of the item entity to set</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="unsetItem" id="_unsetItem"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_unsetItem">#</a> + <code><a href="source-class-predictionio.EventClient.html#182-210" title="Go to source code">unsetItem</a>( <span>integer|string <var>$iid</var></span>, <span>array <var>$properties</var></span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Unset an item entity</p> + </div> + + <div class="description detailed hidden"> + <p>Unset an item entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$iid</var></dt> + <dd>Id</dd> + <dt><var>$properties</var></dt> + <dd>of the item entity to unset</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="deleteItem" id="_deleteItem"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_deleteItem">#</a> + <code><a href="source-class-predictionio.EventClient.html#212-236" title="Go to source code">deleteItem</a>( <span>integer|string <var>$iid</var></span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span></span> )</code> + + <div class="description short"> + <p>Delete an item entity</p> + </div> + + <div class="description detailed hidden"> + <p>Delete an item entity</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$iid</var></dt> + <dd>Id</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="recordUserActionOnItem" id="_recordUserActionOnItem"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_recordUserActionOnItem">#</a> + <code><a href="source-class-predictionio.EventClient.html#238-275" title="Go to source code">recordUserActionOnItem</a>( <span>string <var>$event</var></span>, <span>integer|string <var>$uid</var></span>, <span>integer|string <var>$iid</var></span>, <span>array <var>$properties</var> = <span class="php-keyword1">array</span>()</span>, <span>string <var>$eventTime</var> = <span class="php-keyword1">null</span> </span> )</code> + + <div class="description short"> + <p>Record a user action on an item</p> + </div> + + <div class="description detailed hidden"> + <p>Record a user action on an item</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$event</var></dt> + <dd>name</dd> + <dt><var>$uid</var></dt> + <dd>Id</dd> + <dt><var>$iid</var></dt> + <dd>Id</dd> + <dt><var>$properties</var></dt> + <dd>of the event</dd> + <dt><var>$eventTime</var></dt> + <dd><p>of the event in ISO 8601 format + (e.g. 2014-09-09T16:17:42.937-08:00). + Default is the current time.</p></dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="createEvent" id="_createEvent"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_createEvent">#</a> + <code><a href="source-class-predictionio.EventClient.html#277-291" title="Go to source code">createEvent</a>( <span>array <var>$data</var></span> )</code> + + <div class="description short"> + <p>Create an event</p> + </div> + + <div class="description detailed hidden"> + <p>Create an event</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$data</var></dt> + <dd>array describing the event</dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + <tr data-order="getEvent" id="_getEvent"> + + <td class="attributes"><code> + public + + string + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_getEvent">#</a> + <code><a href="source-class-predictionio.EventClient.html#293-309" title="Go to source code">getEvent</a>( <span>string <var>$eventId</var></span> )</code> + + <div class="description short"> + <p>Retrieve an event</p> + </div> + + <div class="description detailed hidden"> + <p>Retrieve an event</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$eventId</var></dt> + <dd>ID</dd> + </dl></div> + + <h4>Returns</h4> + <div class="list"> + string<br>JSON response + </div> + + <h4>Throws</h4> + <div class="list"> + <code><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></code><br>Request error + </div> + + + + </div> + </div></td> + </tr> + </table> + + <table class="summary inherited"> + <caption>Methods inherited from <a href="class-predictionio.BaseClient.html#methods">predictionio\BaseClient</a></caption> + <tr> + <td><code> + <a href="class-predictionio.BaseClient.html#_getStatus">getStatus()</a>, + <a href="class-predictionio.BaseClient.html#_sendRequest">sendRequest()</a> + </code></td> + </tr> + </table> + + + + + + + + <table class="summary constants" id="constants"> + <caption>Constants summary</caption> + <tr data-order="DATE_TIME_FORMAT" id="DATE_TIME_FORMAT"> + + <td class="attributes"><code>string</code></td> + <td class="name"> + <code> + <a href="source-class-predictionio.EventClient.html#29" title="Go to source code"><b>DATE_TIME_FORMAT</b></a> + </code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + </div> + </td> + <td class="value"> + <div> + <a href="#DATE_TIME_FORMAT" class="anchor">#</a> + <code>predictionio\DateTime::ISO8601</code> + </div> + </td> + </tr> + </table> + + + + + + <table class="summary inherited"> + <caption>Properties inherited from <a href="class-predictionio.BaseClient.html#properties">predictionio\BaseClient</a></caption> + <tr> + <td><code> + <a href="class-predictionio.BaseClient.html#$client"><var>$client</var></a> + </code></td> + </tr> + </table> + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.Exporter.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.Exporter.html b/sdk/php/api/class-predictionio.Exporter.html new file mode 100644 index 0000000..bbd4615 --- /dev/null +++ b/sdk/php/api/class-predictionio.Exporter.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Trait predictionio\Exporter | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li class="active"><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Trait Exporter</h1> + + + + + + + + + + <div> + <h4>Direct Known Users</h4> + <a href="class-predictionio.FileExporter.html">predictionio\FileExporter</a> + </div> + + + <div class="info"> + + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + + + <b>Located at</b> <a href="source-class-predictionio.Exporter.html#20-81" title="Go to source code">predictionio/Exporter.php</a> + <br> + </div> + + + + <table class="summary methods" id="methods"> + <caption>Methods summary</caption> + <tr data-order="export" id="_export"> + + <td class="attributes"><code> + abstract public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_export">#</a> + <code><a href="source-class-predictionio.Exporter.html#22" title="Go to source code">export</a>( <span> <var>$json</var></span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + + + + + + </div> + </div></td> + </tr> + <tr data-order="jsonEncode" id="_jsonEncode"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_jsonEncode">#</a> + <code><a href="source-class-predictionio.Exporter.html#24-27" title="Go to source code">jsonEncode</a>( <span> <var>$data</var></span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + + + + + + </div> + </div></td> + </tr> + <tr data-order="createEvent" id="_createEvent"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_createEvent">#</a> + <code><a href="source-class-predictionio.Exporter.html#29-80" title="Go to source code">createEvent</a>( <span> <var>$event</var></span>, <span> <var>$entityType</var></span>, <span> <var>$entityId</var></span>, <span>null <var>$targetEntityType</var> = <span class="php-keyword1">null</span></span>, <span>null <var>$targetEntityId</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$properties</var> = <span class="php-keyword1">null</span></span>, <span> <var>$eventTime</var> = <span class="php-keyword1">null</span> </span> )</code> + + <div class="description short"> + <p>Create and export a json-encoded event.</p> + </div> + + <div class="description detailed hidden"> + <p>Create and export a json-encoded event.</p> + + + <h4>Parameters</h4> + <div class="list"><dl> + <dt><var>$event</var></dt> + <dd></dd> + <dt><var>$entityType</var></dt> + <dd></dd> + <dt><var>$entityId</var></dt> + <dd></dd> + <dt><var>$targetEntityType</var></dt> + <dd></dd> + <dt><var>$targetEntityId</var></dt> + <dd></dd> + <dt><var>$properties</var></dt> + <dd></dd> + <dt><var>$eventTime</var></dt> + <dd></dd> + </dl></div> + + + + <h4>See</h4> + <div class="list"> + \predictionio\EventClient::CreateEvent()<br> + </div> + + + </div> + </div></td> + </tr> + </table> + + + + + + + + + + + + + + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.FileExporter.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.FileExporter.html b/sdk/php/api/class-predictionio.FileExporter.html new file mode 100644 index 0000000..bfddb04 --- /dev/null +++ b/sdk/php/api/class-predictionio.FileExporter.html @@ -0,0 +1,251 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Class predictionio\FileExporter | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li class="active"><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Class FileExporter</h1> + + + <div class="description"> + <p>Class FileExporter writes events to a series of JSON objects in a file for batch import.</p> + </div> + + <dl class="tree"> + <dd style="padding-left:0px"> +<b><span>predictionio\FileExporter</span></b> + + uses + <a href="class-predictionio.Exporter.html"><span>predictionio\Exporter</span></a> + + </dd> + </dl> + + + + + + + + + <div class="info"> + + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + <b>Package:</b> predictionio<br> + + <b>Located at</b> <a href="source-class-predictionio.FileExporter.html#20-45" title="Go to source code">predictionio/FileExporter.php</a> + <br> + </div> + + + + <table class="summary methods" id="methods"> + <caption>Methods summary</caption> + <tr data-order="__construct" id="___construct"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#___construct">#</a> + <code><a href="source-class-predictionio.FileExporter.html#31-34" title="Go to source code">__construct</a>( <span> <var>$fileName</var></span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + + + + + + </div> + </div></td> + </tr> + <tr data-order="export" id="_export"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_export">#</a> + <code><a href="source-class-predictionio.FileExporter.html#36-39" title="Go to source code">export</a>( <span> <var>$json</var></span> )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + + + + + + </div> + </div></td> + </tr> + <tr data-order="close" id="_close"> + + <td class="attributes"><code> + public + + + + </code> + </td> + + <td class="name"><div> + <a class="anchor" href="#_close">#</a> + <code><a href="source-class-predictionio.FileExporter.html#41-44" title="Go to source code">close</a>( )</code> + + <div class="description short"> + + </div> + + <div class="description detailed hidden"> + + + + + + + + + </div> + </div></td> + </tr> + </table> + + + <table class="summary used"> + <caption>Methods used from <a href="class-predictionio.Exporter.html#methods">predictionio\Exporter</a></caption> + <tr> + <td><code> + <a href="class-predictionio.Exporter.html#_createEvent">createEvent()</a>, + <a href="class-predictionio.Exporter.html#_jsonEncode">jsonEncode()</a> + </code></td> + </tr> + </table> + + + + + + + + + + + + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/class-predictionio.PredictionIOAPIError.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/class-predictionio.PredictionIOAPIError.html b/sdk/php/api/class-predictionio.PredictionIOAPIError.html new file mode 100644 index 0000000..dd4a965 --- /dev/null +++ b/sdk/php/api/class-predictionio.PredictionIOAPIError.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Class predictionio\PredictionIOAPIError | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li class="active"><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li> + <a href="namespace-predictionio.html" title="Summary of predictionio"><span>Namespace</span></a> + </li> + <li class="active"> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="class"> + <h1>Class PredictionIOAPIError</h1> + + + <div class="description"> + <p>Thrown when there is an error with the request.</p> + </div> + + <dl class="tree"> + <dd style="padding-left:0px"> +Exception + implements +<span>Throwable</span> + + + </dd> + <dd style="padding-left:30px"> + <img src="resources/inherit.png" alt="Extended by"> +<b><span>predictionio\PredictionIOAPIError</span></b> + + + </dd> + </dl> + + + + + + + + + <div class="info"> + + + <b>Namespace:</b> <a href="namespace-predictionio.html">predictionio</a><br> + + + <b>Located at</b> <a href="source-class-predictionio.PredictionIOAPIError.html#20-25" title="Go to source code">predictionio/PredictionIOAPIError.php</a> + <br> + </div> + + + + + <table class="summary inherited"> + <caption>Methods inherited from Exception</caption> + <tr> + <td><code> +__construct(), +__toString(), +__wakeup(), +getCode(), +getFile(), +getLine(), +getMessage(), +getPrevious(), +getTrace(), +getTraceAsString() + </code></td> + </tr> + </table> + + + + + + + + + + + + + <table class="summary inherited"> + <caption>Properties inherited from Exception</caption> + <tr> + <td><code> +<var>$code</var>, +<var>$file</var>, +<var>$line</var>, +<var>$message</var> + </code></td> + </tr> + </table> + + + + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js"></script> +<script src="elementlist.js"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/elementlist.js ---------------------------------------------------------------------- diff --git a/sdk/php/api/elementlist.js b/sdk/php/api/elementlist.js new file mode 100644 index 0000000..2563e5b --- /dev/null +++ b/sdk/php/api/elementlist.js @@ -0,0 +1,3 @@ + +var ApiGen = ApiGen || {}; +ApiGen.elements = [["c","predictionio\\BaseClient"],["c","predictionio\\EngineClient"],["c","predictionio\\EventClient"],["c","predictionio\\Exporter"],["c","predictionio\\FileExporter"],["c","predictionio\\PredictionIOAPIError"]]; http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/index.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/index.html b/sdk/php/api/index.html new file mode 100644 index 0000000..d6ee1d2 --- /dev/null +++ b/sdk/php/api/index.html @@ -0,0 +1,103 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> +<span>Overview</span> + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">predictionio\BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">predictionio\EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">predictionio\EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">predictionio\FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">predictionio\Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">predictionio\PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search" autofocus> + </form> + + <div id="navigation"> + <ul> + <li class="active"> +<span>Overview</span> </li> + <li> +<span>Namespace</span> </li> + <li> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content"> + <h1>PredictionIO API PHP Client</h1> + + + <table class="summary" id="namespaces"> + <caption>Namespaces summary</caption> + <tr> + <td class="name"><a href="namespace-predictionio.html">predictionio</a></td> + </tr> + </table> + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js?9c4f6659aff2cc5d1f5e2a4982182f7cbd554a5f"></script> +<script src="elementlist.js?e3d430db2653e14d9092ac05f398118c8552dbc7"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/namespace-predictionio.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/namespace-predictionio.html b/sdk/php/api/namespace-predictionio.html new file mode 100644 index 0000000..927cda0 --- /dev/null +++ b/sdk/php/api/namespace-predictionio.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>Namespace predictionio | PredictionIO API PHP Client</title> + + <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da"> + +</head> + +<body> +<div id="left"> + <div id="menu"> + <a href="index.html" title="Overview"><span>Overview</span></a> + + + <div id="groups"> + <h3>Namespaces</h3> + <ul> + <li class="active"> + <a href="namespace-predictionio.html"> + predictionio </a> + + </li> + </ul> + </div> + + <hr> + + + <div id="elements"> + <h3>Classes</h3> + <ul> + <li><a href="class-predictionio.BaseClient.html">BaseClient</a></li> + <li><a href="class-predictionio.EngineClient.html">EngineClient</a></li> + <li><a href="class-predictionio.EventClient.html">EventClient</a></li> + <li><a href="class-predictionio.FileExporter.html">FileExporter</a></li> + </ul> + + + <h3>Traits</h3> + <ul> + <li><a href="class-predictionio.Exporter.html">Exporter</a></li> + </ul> + + <h3>Exceptions</h3> + <ul> + <li><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></li> + </ul> + + + </div> + </div> +</div> + +<div id="splitter"></div> + +<div id="right"> +<div id="rightInner"> + <form id="search"> + <input type="hidden" name="cx" value=""> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" class="text" placeholder="Search"> + </form> + + <div id="navigation"> + <ul> + <li> + <a href="index.html" title="Overview"><span>Overview</span></a> + </li> + <li class="active"> +<span>Namespace</span> </li> + <li> +<span>Class</span> </li> + </ul> + <ul> + </ul> + <ul> + </ul> + </div> + +<div id="content" class="namespace"> + <h1>Namespace predictionio</h1> + + + +<table class="summary" id="classes"> +<caption>Classes summary</caption> +<tr> + <td class="name"><a href="class-predictionio.BaseClient.html">BaseClient</a></td> + <td>Base client for Event and Engine client</td> +</tr> +<tr> + <td class="name"><a href="class-predictionio.EngineClient.html">EngineClient</a></td> + <td>Client for connecting to an Engine Instance</td> +</tr> +<tr> + <td class="name"><a href="class-predictionio.EventClient.html">EventClient</a></td> + <td>Client for connecting to an Event Server</td> +</tr> +<tr> + <td class="name"><a href="class-predictionio.FileExporter.html">FileExporter</a></td> + <td>Class FileExporter writes events to a series of JSON objects in a file for batch import.</td> +</tr> +</table> + + +<table class="summary" id="traits"> +<caption>Traits summary</caption> +<tr> + <td class="name"><a href="class-predictionio.Exporter.html">Exporter</a></td> + <td></td> +</tr> +</table> + +<table class="summary" id="exceptions"> +<caption>Exceptions summary</caption> +<tr> + <td class="name"><a href="class-predictionio.PredictionIOAPIError.html">PredictionIOAPIError</a></td> + <td>Thrown when there is an error with the request.</td> +</tr> +</table> + + +</div> + + <div id="footer"> + PredictionIO API PHP Client API documentation generated by <a href="http://apigen.org";>ApiGen</a> + </div> +</div> +</div> +<script src="resources/combined.js?9c4f6659aff2cc5d1f5e2a4982182f7cbd554a5f"></script> +<script src="elementlist.js?e3d430db2653e14d9092ac05f398118c8552dbc7"></script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/collapsed.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/collapsed.png b/sdk/php/api/resources/collapsed.png new file mode 100644 index 0000000..56e7323 Binary files /dev/null and b/sdk/php/api/resources/collapsed.png differ
