http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/inherit.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/inherit.png b/sdk/php/api/resources/inherit.png new file mode 100644 index 0000000..957079b Binary files /dev/null and b/sdk/php/api/resources/inherit.png differ
http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/resize.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/resize.png b/sdk/php/api/resources/resize.png new file mode 100644 index 0000000..fb98a7a Binary files /dev/null and b/sdk/php/api/resources/resize.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/sort.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/sort.png b/sdk/php/api/resources/sort.png new file mode 100644 index 0000000..0d0fea1 Binary files /dev/null and b/sdk/php/api/resources/sort.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/style.css ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/style.css b/sdk/php/api/resources/style.css new file mode 100644 index 0000000..8bf17b5 --- /dev/null +++ b/sdk/php/api/resources/style.css @@ -0,0 +1,619 @@ +body { + font: 13px/1.5 Verdana, 'Geneva CE', lucida, sans-serif; + margin: 0; + padding: 0; + background: #ffffff; + color: #333333; +} + +h1, h2, h3, h4, caption { + font-family: 'Trebuchet MS', 'Geneva CE', lucida, sans-serif; + color: #053368; +} + +h1 { + color: #1e5eb6; + font-size: 230%; + font-weight: normal; + margin: .3em 0; +} + +h2 { + color: #1e5eb6; + font-size: 150%; + font-weight: normal; + margin: -.3em 0 .3em 0; +} + +h3 { + font-size: 1.6em; + font-weight: normal; + margin-bottom: 2px; +} + +h4 { + font-size: 100%; + font-weight: bold; + padding: 0; + margin: 0; +} + +caption { + border: 1px solid #cccccc; + background: #ecede5; + font-weight: bold; + font-size: 1.2em; + padding: 3px 5px; + text-align: left; + margin-bottom: 0; +} + +p { + margin: .7em 0 1em; + padding: 0; +} + +hr { + margin: 2em 0 1em; + border: none; + border-top: 1px solid #cccccc; + height: 0; +} + +a { + color: #006aeb; + padding: 3px 1px; + text-decoration: none; +} + +h1 a { + color: #1e5eb6; +} + +a:hover, a:active, a:focus, a:hover b, a:hover var { + background-color: #006aeb; + color: #ffffff !important; +} + +code, var, pre { + font-family: monospace; +} + +var { + font-weight: bold; + font-style: normal; + color: #ca8a04; +} + +pre { + margin: 0; +} + +code a b { + color: #000000; +} + +.deprecated { + text-decoration: line-through; + opacity: .5; +} + +.invalid { + color: #e71818; +} + +.hidden { + display: none; +} + +/* Left side */ +#left { + overflow: auto; + width: 270px; + height: 100%; + position: fixed; +} + +/* Menu */ +#menu { + padding: 10px; +} + +#menu ul { + list-style: none; + padding: 0; + margin: 0; +} + +#menu ul ul { + padding-left: 10px; +} + +#menu li { + white-space: nowrap; + position: relative; +} + +#menu a { + display: block; + padding: 0 2px; +} + +#menu .active > a, #menu > span { + color: #333333; + background: none; + font-weight: bold; +} + +#menu .active > a.invalid { + color: #e71818; +} + +#menu .active > a:hover, #menu .active > a:active, #menu .active > a:focus { + background-color: #006aeb; +} + +#menu #groups span { + position: absolute; + top: 4px; + right: 2px; + cursor: pointer; + display: block; + width: 12px; + height: 12px; + background: url('collapsed.png') transparent 0 0 no-repeat; +} + +#menu #groups span:hover { + background-position: -12px 0; +} + +#menu #groups span.collapsed { + background-position: 0 -12px; +} + +#menu #groups span.collapsed:hover { + background-position: -12px -12px; +} + +#menu #groups ul.collapsed { + display: none; +} + +/* Right side */ +#right { + overflow: auto; + margin-left: 275px; + height: 100%; + position: relative; + left: 0; + right: 0; +} + +#rightInner { + max-width: 1000px; + min-width: 350px; +} + +/* Search */ +#search { + float: right; + margin: 3px 8px; +} + +#search input.text { + padding: 3px 5px; + width: 250px; +} + +/* Autocomplete */ +.ac_results { + padding: 0; + border: 1px solid #cccccc; + background-color: #ffffff; + overflow: hidden; + z-index: 99999; +} + +.ac_results ul { + width: 100%; + list-style-position: outside; + list-style: none; + padding: 0; + margin: 0; +} + +.ac_results li { + margin: 0; + padding: 2px 5px; + cursor: default; + display: block; + font: 12px 'Trebuchet MS', 'Geneva CE', lucida, sans-serif; + line-height: 16px; + overflow: hidden; + white-space: nowrap; +} + +.ac_results li strong { + color: #000000; +} + +.ac_odd { + background-color: #eeeeee; +} + +.ac_over { + background-color: #006aeb; + color: #ffffff; +} + +.ac_results li.ac_over strong { + color: #ffffff; +} + +/* Navigation */ +#navigation { + padding: 3px 8px; + background-color: #f6f6f4; + height: 26px; +} + +#navigation ul { + list-style: none; + margin: 0 8px 4px 0; + padding: 0; + overflow: hidden; + float: left; +} + +#navigation ul + ul { + border-left: 1px solid #000000; + padding-left: 8px; +} + +#navigation ul li { + float: left; + margin: 2px; + padding: 0 3px; + font-family: Verdana, 'Geneva CE', lucida, sans-serif; + color: #808080; +} + +#navigation ul li.active { + background-color: #053368; + color: #ffffff; + font-weight: bold; +} + +#navigation ul li a { + color: #000000; + font-weight: bold; + padding: 0; +} + +#navigation ul li span { + float: left; + padding: 0 3px; +} + +#navigation ul li a:hover span, #navigation ul li a:active span, #navigation ul li a:focus span { + background-color: #006aeb; +} + +/* Content */ +#content { + clear: both; + padding: 5px 15px; +} + +.description pre { + padding: .6em; + background: #fcfcf7; +} + +#content > .description { + background: #ecede5; + padding: 1px 8px; + margin: 1.2em 0; +} + +#content > .description pre { + margin: .5em 0; +} + +dl.tree { + margin: 1.2em 0; +} + +dl.tree dd { + margin: 0; + padding: 0; +} + +.info { + margin: 1.2em 0; +} + +.summary { + border: 1px solid #cccccc; + border-collapse: collapse; + font-size: 1em; + width: 100%; + margin: 1.2em 0 2.4em; +} + +.summary caption { + border-width: 1px 1px 0; +} + +.summary caption.switchable { + background: #ecede5 url('sort.png') no-repeat center right; + cursor: pointer; +} + +.summary td { + border: 1px solid #cccccc; + margin: 0; + padding: 3px 10px; + font-size: 1em; + vertical-align: top; +} + +.summary td:first-child { + text-align: right; +} + +.summary td hr { + margin: 3px -10px; +} + +#packages.summary td:first-child, #namespaces.summary td:first-child, .inherited.summary td:first-child, .used.summary td:first-child { + text-align: left; +} + +.summary tr:hover td { + background: #f6f6f4; +} + +.summary .description pre { + border: .5em solid #ecede5; +} + +.summary .description p { + margin: 0; +} + +.summary .description p + p, .summary .description ul { + margin: 3px 0 0 0; +} + +.summary .description.detailed h4 { + margin-top: 3px; +} + +.summary dl { + margin: 0; +} + +.summary dd { + margin: 0 0 0 25px; +} + +.name, .attributes { + white-space: nowrap; +} + +.value code { + white-space: pre-wrap; +} + +td.name, td.attributes { + width: 1%; +} + +td.attributes { + width: 1%; +} + +.class .methods .name, .class .properties .name, .class .constants .name { + width: auto; + white-space: normal; +} + +.class .methods .name > div > code { + white-space: pre-wrap; +} + +.class .methods .name > div > code span, .function .value > code { + white-space: nowrap; + display: inline-block; +} + +.class .methods td.name > div, .class td.value > div { + position: relative; + padding-right: 1em; +} + +.anchor { + position: absolute; + top: 0; + right: 0; + line-height: 1; + font-size: 85%; + margin: 0; + color: #006aeb !important; +} + +.list { + margin: 0 0 5px 25px; +} + +div.invalid { + background-color: #fae4e0; + padding: 10px; +} + +/* Splitter */ +#splitter { + position: fixed; + height: 100%; + width: 5px; + left: 270px; + background: #1e5eb6 url('resize.png') left center no-repeat; + cursor: e-resize; +} + +#splitter.active { + opacity: .5; +} + +/* Footer */ +#footer { + border-top: 1px solid #e9eeef; + clear: both; + color: #a7a7a7; + font-size: 8pt; + text-align: center; + padding: 20px 0 0; + margin: 3em 0 0; + height: 90px; + background: #ffffff url('footer.png') no-repeat center top; +} + +/* Tree */ +div.tree ul { + list-style: none; + background: url('tree-vertical.png') left repeat-y; + padding: 0; + margin-left: 20px; +} + +div.tree li { + margin: 0; + padding: 0; +} + +div.tree div { + padding-left: 30px; +} + +div.tree div.notlast { + background: url('tree-hasnext.png') left 10px no-repeat; +} + +div.tree div.last { + background: url('tree-last.png') left -240px no-repeat; +} + +div.tree li.last { + background: url('tree-cleaner.png') left center repeat-y; +} + +div.tree span.padding { + padding-left: 15px; +} + +/* Source code */ +.php-keyword1 { + color: #e71818; + font-weight: bold; +} + +.php-keyword2 { + font-weight: bold; +} + +.php-var { + color: #d59401; + font-weight: bold; +} + +.php-num { + color: #cd0673; +} + +.php-quote { + color: #008000; +} + +.php-comment { + color: #929292; +} + +.xlang { + color: #ff0000; + font-weight: bold; +} + +pre.numbers { + float: left; +} + +span.l { + display: block; +} + +span.l.selected { + background: #f6f6f4; +} + +span.l a { + color: #333333; +} + +span.l a:hover, div.l a:active, div.l a:focus { + background: transparent; + color: #333333 !important; +} + +span.l .php-var a { + color: #d59401; +} + +span.l .php-var a:hover, span.l .php-var a:active, span.l .php-var a:focus { + color: #d59401 !important; +} + +span.l a.l { + padding-left: 2px; + color: #c0c0c0; +} + +span.l a.l:hover, span.l a.l:active, span.l a.l:focus { + background: transparent; + color: #c0c0c0 !important; +} + +#rightInner.medium #navigation { + height: 52px; +} + +#rightInner.medium #navigation ul:first-child + ul { + clear: left; + border: none; + padding: 0; +} + +#rightInner.medium .name, #rightInner.medium .attributes { + white-space: normal; +} + +#rightInner.small #search { + float: left; +} + +#rightInner.small #navigation { + height: 78px; +} + +#rightInner.small #navigation ul:first-child { + clear: both; +} + +/* global style */ +.left, .summary td.left { + text-align: left; +} +.right, .summary td.right { + text-align: right; +} http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/tree-cleaner.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/tree-cleaner.png b/sdk/php/api/resources/tree-cleaner.png new file mode 100644 index 0000000..2eb9085 Binary files /dev/null and b/sdk/php/api/resources/tree-cleaner.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/tree-hasnext.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/tree-hasnext.png b/sdk/php/api/resources/tree-hasnext.png new file mode 100644 index 0000000..91d6b79 Binary files /dev/null and b/sdk/php/api/resources/tree-hasnext.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/tree-last.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/tree-last.png b/sdk/php/api/resources/tree-last.png new file mode 100644 index 0000000..7f319f8 Binary files /dev/null and b/sdk/php/api/resources/tree-last.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/resources/tree-vertical.png ---------------------------------------------------------------------- diff --git a/sdk/php/api/resources/tree-vertical.png b/sdk/php/api/resources/tree-vertical.png new file mode 100644 index 0000000..384908b Binary files /dev/null and b/sdk/php/api/resources/tree-vertical.png differ http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/721427d5/sdk/php/api/source-class-predictionio.BaseClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/source-class-predictionio.BaseClient.html b/sdk/php/api/source-class-predictionio.BaseClient.html new file mode 100644 index 0000000..769c71d --- /dev/null +++ b/sdk/php/api/source-class-predictionio.BaseClient.html @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + <meta name="robots" content="noindex"> + + <title>File predictionio/BaseClient.php | 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> + +<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10">10: </a></span></span><span class="l"><a href="#11">11: </a></span></span><span class="l"><a href="#12">12: </a></span></span><span class="l"><a href="#13">13: </a></span></span><span class="l"><a href="#14">14: </a></span></span><span class="l"><a href="#15">15: </a></span></span><span class="l"><a href="#16">16: </a></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span><span class="l"><a href="#22">22: </a></span><span class="l"><a href="#23">23: </a></span></span><span class="l"><a href="#24">24: </a></span></span><span class="l"><a href="#25">25: </a></span></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span><span class="l"><a href="#28">28: </a></span><span class="l"><a href="#29">29: </a></span><span class="l"><a href="#30">30: </a></span><span class="l"><a href="#31">31: </a></span><span class="l"><a href="#32">32: </a></span></span><span class="l"><a href="#33">33: </a></span></span><span class="l"><a href="#34">34: </a></span></span><span class="l"><a href="#35">35: </a></span></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span><span class="l"><a href="#39">39: </a></span><span class="l"><a href="#40">40: </a></span><span class="l"><a href="#41">41: </ a></span><span class="l"><a href="#42">42: </a></span><span class="l"><a href="#43">43: </a></span><span class="l"><a href="#44">44: </a></span><span class="l"><a href="#45">45: </a></span><span class="l"><a href="#46">46: </a></span><span class="l"><a href="#47">47: </a></span></span><span class="l"><a href="#48">48: </a></span></span><span class="l"><a href="#49">49: </a></span></span><span class="l"><a href="#50">50: </a></span></span><span class="l"><a href="#51">51: </a></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span><span class="l"><a href="#57">57: </a></span></span><span class="l"><a href="#58">58: </a></span></span><span class="l"><a href="#59">59: </a></span></span><span class="l"><a href="#60">60: </a></span></span><span class="l"><a href="#61">61: </a></span></span><span class="l"><a href=" #62">62: </a></span></span><span class="l"><a href="#63">63: </a></span></span><span class="l"><a href="#64">64: </a></span></span><span class="l"><a href="#65">65: </a></span></span><span class="l"><a href="#66">66: </a></span><span class="l"><a href="#67">67: </a></span><span class="l"><a href="#68">68: </a></span><span class="l"><a href="#69">69: </a></span><span class="l"><a href="#70">70: </a></span><span class="l"><a href="#71">71: </a></span><span class="l"><a href="#72">72: </a></span><span class="l"><a href="#73">73: </a></span><span class="l"><a href="#74">74: </a></span><span class="l"><a href="#75">75: </a></span><span class="l"><a href="#76">76: </a></span><span class="l"><a href="#77">77: </a></span><span class="l"><a href="#78">78: </a></span><span class="l"><a href="#79">79: </a></span><span class="l"><a href="#80">80: </a></span><span class="l"><a href="#81">81: </a></span><span class="l"><a href="#82">82: </a></span><span class="l"><a href="#83">83: </a></span><spa n class="l"><a href="#84">84: </a></span><span class="l"><a href="#85">85: </a></span></code></pre> +<pre class="code"><code><span id="1" class="l"><span class="xlang"><?php</span> +</span><span id="2" class="l"> +</span><span id="3" class="l"><span class="php-comment">/** +</span></span><span id="4" class="l"><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more +</span></span><span id="5" class="l"><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with +</span></span><span id="6" class="l"><span class="php-comment"> * this work for additional information regarding copyright ownership. +</span></span><span id="7" class="l"><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0 +</span></span><span id="8" class="l"><span class="php-comment"> * (the "License"); you may not use this file except in compliance with +</span></span><span id="9" class="l"><span class="php-comment"> * the License. You may obtain a copy of the License at +</span></span><span id="10" class="l"><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0 +</span></span><span id="11" class="l"><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software +</span></span><span id="12" class="l"><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS, +</span></span><span id="13" class="l"><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +</span></span><span id="14" class="l"><span class="php-comment"> * See the License for the specific language governing permissions and +</span></span><span id="15" class="l"><span class="php-comment"> * limitations under the License. +</span></span><span id="16" class="l"><span class="php-comment"> */</span> +</span><span id="17" class="l"> +</span><span id="18" class="l"><span class="php-keyword1">namespace</span> predictionio; +</span><span id="19" class="l"> +</span><span id="20" class="l"><span class="php-keyword1">use</span> GuzzleHttp\Client; +</span><span id="21" class="l"><span class="php-keyword1">use</span> GuzzleHttp\Exception\ClientException; +</span><span id="22" class="l"> +</span><span id="23" class="l"><span class="php-comment">/** +</span></span><span id="24" class="l"><span class="php-comment"> * Base client for Event and Engine client +</span></span><span id="25" class="l"><span class="php-comment"> * +</span></span><span id="26" class="l"><span class="php-comment"> */</span> +</span><span id="27" class="l"><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> BaseClient +</span><span id="28" class="l">{ +</span><span id="29" class="l"> <span class="php-keyword1">private</span> <span class="php-var">$baseUrl</span>; +</span><span id="30" class="l"> <span class="php-keyword1">public</span> <span class="php-var">$client</span>; +</span><span id="31" class="l"> +</span><span id="32" class="l"> <span class="php-comment">/** +</span></span><span id="33" class="l"><span class="php-comment"> * @param string $baseUrl Base URL to the server +</span></span><span id="34" class="l"><span class="php-comment"> * @param float $timeout Timeout of the request in seconds. Use 0 to wait indefinitely +</span></span><span id="35" class="l"><span class="php-comment"> * @param float $connectTimeout Number of seconds to wait while trying to connect to a server +</span></span><span id="36" class="l"><span class="php-comment"> */</span> +</span><span id="37" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct(<span class="php-var">$baseUrl</span>, <span class="php-var">$timeout</span>, <span class="php-var">$connectTimeout</span>) +</span><span id="38" class="l"> { +</span><span id="39" class="l"> <span class="php-var">$this</span>->baseUrl = <span class="php-var">$baseUrl</span>; +</span><span id="40" class="l"> <span class="php-var">$this</span>->client = <span class="php-keyword1">new</span> Client([ +</span><span id="41" class="l"> <span class="php-quote">'base_uri'</span> => <span class="php-var">$this</span>->baseUrl, +</span><span id="42" class="l"> <span class="php-quote">'timeout'</span> => <span class="php-var">$timeout</span>, +</span><span id="43" class="l"> <span class="php-quote">'connect_timeout'</span> => <span class="php-var">$connectTimeout</span> +</span><span id="44" class="l"> ]); +</span><span id="45" class="l"> } +</span><span id="46" class="l"> +</span><span id="47" class="l"> <span class="php-comment">/** +</span></span><span id="48" class="l"><span class="php-comment"> * Get the status of the Event Server or Engine Instance +</span></span><span id="49" class="l"><span class="php-comment"> * +</span></span><span id="50" class="l"><span class="php-comment"> * @return string status +</span></span><span id="51" class="l"><span class="php-comment"> */</span> +</span><span id="52" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getStatus() +</span><span id="53" class="l"> { +</span><span id="54" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->client->get(<span class="php-quote">'/'</span>)->getBody(); +</span><span id="55" class="l"> } +</span><span id="56" class="l"> +</span><span id="57" class="l"> <span class="php-comment">/** +</span></span><span id="58" class="l"><span class="php-comment"> * Send a HTTP request to the server +</span></span><span id="59" class="l"><span class="php-comment"> * +</span></span><span id="60" class="l"><span class="php-comment"> * @param string $method HTTP request method +</span></span><span id="61" class="l"><span class="php-comment"> * @param string $url Relative or absolute url +</span></span><span id="62" class="l"><span class="php-comment"> * @param string $body HTTP request body +</span></span><span id="63" class="l"><span class="php-comment"> * +</span></span><span id="64" class="l"><span class="php-comment"> * @return array JSON response +</span></span><span id="65" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="66" class="l"><span class="php-comment"> */</span> +</span><span id="67" class="l"> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> sendRequest(<span class="php-var">$method</span>, <span class="php-var">$url</span>, <span class="php-var">$body</span>) +</span><span id="68" class="l"> { +</span><span id="69" class="l"> <span class="php-var">$options</span> = [ +</span><span id="70" class="l"> <span class="php-quote">'headers'</span> => [ +</span><span id="71" class="l"> <span class="php-quote">'Accept-Encoding'</span> => <span class="php-quote">'gzip'</span>, +</span><span id="72" class="l"> <span class="php-quote">'Content-Type'</span> => <span class="php-quote">'application/json'</span>, +</span><span id="73" class="l"> ], +</span><span id="74" class="l"> <span class="php-quote">'body'</span> => <span class="php-var">$body</span>, +</span><span id="75" class="l"> ]; +</span><span id="76" class="l"> +</span><span id="77" class="l"> <span class="php-keyword1">try</span> { +</span><span id="78" class="l"> <span class="php-var">$response</span> = <span class="php-var">$this</span>->client->request(<span class="php-var">$method</span>, <span class="php-var">$url</span>, <span class="php-var">$options</span>); +</span><span id="79" class="l"> <span class="php-keyword1">return</span> <span class="php-keyword2">json_decode</span>(<span class="php-var">$response</span>->getBody(), <span class="php-keyword1">true</span>); +</span><span id="80" class="l"> } <span class="php-keyword1">catch</span> (ClientException <span class="php-var">$e</span>) { +</span><span id="81" class="l"> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> PredictionIOAPIError(<span class="php-var">$e</span>->getMessage()); +</span><span id="82" class="l"> } +</span><span id="83" class="l"> } +</span><span id="84" class="l">} +</span><span id="85" class="l"></span></code></pre> + + <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/source-class-predictionio.EngineClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/source-class-predictionio.EngineClient.html b/sdk/php/api/source-class-predictionio.EngineClient.html new file mode 100644 index 0000000..a13e894 --- /dev/null +++ b/sdk/php/api/source-class-predictionio.EngineClient.html @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + <meta name="robots" content="noindex"> + + <title>File predictionio/EngineClient.php | 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> + +<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10">10: </a></span></span><span class="l"><a href="#11">11: </a></span></span><span class="l"><a href="#12">12: </a></span></span><span class="l"><a href="#13">13: </a></span></span><span class="l"><a href="#14">14: </a></span></span><span class="l"><a href="#15">15: </a></span></span><span class="l"><a href="#16">16: </a></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span></span><span class="l"><a href="#21">21: </a></span></span><span class="l"><a href="#22">22: </a></span></span><span class="l"><a href="#23">23: </a></span><span class="l"><a href="#24">24: </a></span><span class="l"><a href="#25">25: </a></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span></span><span class="l"><a href="#28">28: </a></span></span><span class="l"><a href="#29">29: </a></span></span><span class="l"><a href="#30">30: </a></span></span><span class="l"><a href="#31">31: </a></span></span><span class="l"><a href="#32">32: </a></span></span><span class="l"><a href="#33">33: </a></span><span class="l"><a href="#34">34: </a></span><span class="l"><a href="#35">35: </a></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span><span class="l"><a href="#39">39: </a></span><span class="l"><a href="#40">40: </a></span><span class="l"><a hre f="#41">41: </a></span><span class="l"><a href="#42">42: </a></span></span><span class="l"><a href="#43">43: </a></span></span><span class="l"><a href="#44">44: </a></span></span><span class="l"><a href="#45">45: </a></span></span><span class="l"><a href="#46">46: </a></span></span><span class="l"><a href="#47">47: </a></span></span><span class="l"><a href="#48">48: </a></span></span><span class="l"><a href="#49">49: </a></span></span><span class="l"><a href="#50">50: </a></span><span class="l"><a href="#51">51: </a></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span></code></pre> +<pre class="code"><code><span id="1" class="l"><span class="xlang"><?php</span> +</span><span id="2" class="l"> +</span><span id="3" class="l"><span class="php-comment">/** +</span></span><span id="4" class="l"><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more +</span></span><span id="5" class="l"><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with +</span></span><span id="6" class="l"><span class="php-comment"> * this work for additional information regarding copyright ownership. +</span></span><span id="7" class="l"><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0 +</span></span><span id="8" class="l"><span class="php-comment"> * (the "License"); you may not use this file except in compliance with +</span></span><span id="9" class="l"><span class="php-comment"> * the License. You may obtain a copy of the License at +</span></span><span id="10" class="l"><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0 +</span></span><span id="11" class="l"><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software +</span></span><span id="12" class="l"><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS, +</span></span><span id="13" class="l"><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +</span></span><span id="14" class="l"><span class="php-comment"> * See the License for the specific language governing permissions and +</span></span><span id="15" class="l"><span class="php-comment"> * limitations under the License. +</span></span><span id="16" class="l"><span class="php-comment"> */</span> +</span><span id="17" class="l"> +</span><span id="18" class="l"><span class="php-keyword1">namespace</span> predictionio; +</span><span id="19" class="l"> +</span><span id="20" class="l"><span class="php-comment">/** +</span></span><span id="21" class="l"><span class="php-comment"> * Client for connecting to an Engine Instance +</span></span><span id="22" class="l"><span class="php-comment"> * +</span></span><span id="23" class="l"><span class="php-comment"> */</span> +</span><span id="24" class="l"><span class="php-keyword1">class</span> EngineClient <span class="php-keyword1">extends</span> BaseClient +</span><span id="25" class="l">{ +</span><span id="26" class="l"> +</span><span id="27" class="l"> <span class="php-comment">/** +</span></span><span id="28" class="l"><span class="php-comment"> * @param string Base URL to the Engine Instance. Default is localhost:8000. +</span></span><span id="29" class="l"><span class="php-comment"> * @param float Timeout of the request in seconds. Use 0 to wait indefinitely +</span></span><span id="30" class="l"><span class="php-comment"> * Default is 0. +</span></span><span id="31" class="l"><span class="php-comment"> * @param float Number of seconds to wait while trying to connect to a server. +</span></span><span id="32" class="l"><span class="php-comment"> * Default is 5. +</span></span><span id="33" class="l"><span class="php-comment"> */</span> +</span><span id="34" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct( +</span><span id="35" class="l"> <span class="php-var">$baseUrl</span>=<span class="php-quote">"http://localhost:8000"</span>, +</span><span id="36" class="l"> <span class="php-var">$timeout</span>=<span class="php-num">0</span>, +</span><span id="37" class="l"> <span class="php-var">$connectTimeout</span>=<span class="php-num">5</span> +</span><span id="38" class="l"> ) { +</span><span id="39" class="l"> parent::__construct(<span class="php-var">$baseUrl</span>, <span class="php-var">$timeout</span>, <span class="php-var">$connectTimeout</span>); +</span><span id="40" class="l"> } +</span><span id="41" class="l"> +</span><span id="42" class="l"> <span class="php-comment">/** +</span></span><span id="43" class="l"><span class="php-comment"> * Send prediction query to an Engine Instance +</span></span><span id="44" class="l"><span class="php-comment"> * +</span></span><span id="45" class="l"><span class="php-comment"> * @param array Query +</span></span><span id="46" class="l"><span class="php-comment"> * +</span></span><span id="47" class="l"><span class="php-comment"> * @return array JSON response +</span></span><span id="48" class="l"><span class="php-comment"> * +</span></span><span id="49" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="50" class="l"><span class="php-comment"> */</span> +</span><span id="51" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> sendQuery(<span class="php-keyword1">array</span> <span class="php-var">$query</span>) +</span><span id="52" class="l"> { +</span><span id="53" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">"POST"</span>, <span class="php-quote">"/queries.json"</span>, <span class="php-keyword2">json_encode</span>(<span class="php-var">$query</span>)); +</span><span id="54" class="l"> } +</span><span id="55" class="l">} +</span><span id="56" class="l"></span></code></pre> + + <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/source-class-predictionio.EventClient.html ---------------------------------------------------------------------- diff --git a/sdk/php/api/source-class-predictionio.EventClient.html b/sdk/php/api/source-class-predictionio.EventClient.html new file mode 100644 index 0000000..0247443 --- /dev/null +++ b/sdk/php/api/source-class-predictionio.EventClient.html @@ -0,0 +1,405 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + <meta name="robots" content="noindex"> + + <title>File predictionio/EventClient.php | 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> + +<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10"> 10: </a></span></span><span class="l"><a href="#11"> 11: </a></span></span><span class="l"><a href="#12"> 12: </a></span></span><span class="l"><a href="#13"> 13: </a></span></span><span class="l"><a href="#14"> 14: </a></span></span><span class="l"><a href="#15"> 15: </a></span></span><span class="l"><a href="#16"> 16: </a></span><span class="l"><a href="#17"> 17: </a></span><span class="l"><a href="#18"> 18: </a></span><span class="l"><a href="#19"> 19: </a></span><span class="l "><a href="#20"> 20: </a></span><span class="l"><a href="#21"> 21: </a></span><span class="l"><a href="#22"> 22: </a></span><span class="l"><a href="#23"> 23: </a></span></span><span class="l"><a href="#24"> 24: </a></span></span><span class="l"><a href="#25"> 25: </a></span></span><span class="l"><a href="#26"> 26: </a></span><span class="l"><a href="#27"> 27: </a></span><span class="l"><a href="#28"> 28: </a></span><span class="l"><a href="#29"> 29: </a></span><span class="l"><a href="#30"> 30: </a></span><span class="l"><a href="#31"> 31: </a></span><span class="l"><a href="#32"> 32: </a></span><span class="l"><a href="#33"> 33: </a></span></span><span class="l"><a href="#34"> 34: </a></span></span><span class="l"><a href="#35"> 35: </a></span></span><span class="l"><a href="#36"> 36: </a></span></span><span class="l"><a href="#37"> 37: </a></span></span><span class="l"><a href="#38"> 38: </a></span></span><span class="l"><a href="#39"> 39: </a></span></span><span class="l"><a hr ef="#40"> 40: </a></span><span class="l"><a href="#41"> 41: </a></span><span class="l"><a href="#42"> 42: </a></span><span class="l"><a href="#43"> 43: </a></span><span class="l"><a href="#44"> 44: </a></span><span class="l"><a href="#45"> 45: </a></span><span class="l"><a href="#46"> 46: </a></span><span class="l"><a href="#47"> 47: </a></span><span class="l"><a href="#48"> 48: </a></span><span class="l"><a href="#49"> 49: </a></span><span class="l"><a href="#50"> 50: </a></span><span class="l"><a href="#51"> 51: </a></span><span class="l"><a href="#52"> 52: </a></span><span class="l"><a href="#53"> 53: </a></span><span class="l"><a href="#54"> 54: </a></span><span class="l"><a href="#55"> 55: </a></span><span class="l"><a href="#56"> 56: </a></span><span class="l"><a href="#57"> 57: </a></span><span class="l"><a href="#58"> 58: </a></span><span class="l"><a href="#59"> 59: </a></span><span class="l"><a href="#60"> 60: </a></span><span class="l"><a href="#61"> 61: </a></span><span class="l"><a href="#62"> 62: </a></span></span><span class="l"><a href="#63"> 63: </a></span></span><span class="l"><a href="#64"> 64: </a></span></span><span class="l"><a href="#65"> 65: </a></span></span><span class="l"><a href="#66"> 66: </a></span></span><span class="l"><a href="#67"> 67: </a></span></span><span class="l"><a href="#68"> 68: </a></span></span><span class="l"><a href="#69"> 69: </a></span></span><span class="l"><a href="#70"> 70: </a></span></span><span class="l"><a href="#71"> 71: </a></span></span><span class="l"><a href="#72"> 72: </a></span></span><span class="l"><a href="#73"> 73: </a></span></span><span class="l"><a href="#74"> 74: </a></span><span class="l"><a href="#75"> 75: </a></span><span class="l"><a href="#76"> 76: </a></span><span class="l"><a href="#77"> 77: </a></span><span class="l"><a href="#78"> 78: </a></span><span class="l"><a href="#79"> 79: </a></span><span class="l"><a href="#80"> 80: </a></span><span class="l"><a href="#81"> 81: </a></span ><span class="l"><a href="#82"> 82: </a></span><span class="l"><a href="#83"> >83: </a></span><span class="l"><a href="#84"> 84: </a></span><span >class="l"><a href="#85"> 85: </a></span><span class="l"><a href="#86"> 86: ></a></span><span class="l"><a href="#87"> 87: </a></span><span class="l"><a >href="#88"> 88: </a></span><span class="l"><a href="#89"> 89: ></a></span><span class="l"><a href="#90"> 90: </a></span><span class="l"><a >href="#91"> 91: </a></span><span class="l"><a href="#92"> 92: ></a></span><span class="l"><a href="#93"> 93: </a></span><span class="l"><a >href="#94"> 94: </a></span><span class="l"><a href="#95"> 95: ></a></span></span><span class="l"><a href="#96"> 96: </a></span></span><span >class="l"><a href="#97"> 97: </a></span></span><span class="l"><a href="#98"> >98: </a></span></span><span class="l"><a href="#99"> 99: ></a></span></span><span class="l"><a href="#100">100: </a></span></span><span >class="l"><a href="#101">101: </a></span></span><span class="l"><a href=" #102">102: </a></span></span><span class="l"><a href="#103">103: </a></span></span><span class="l"><a href="#104">104: </a></span></span><span class="l"><a href="#105">105: </a></span></span><span class="l"><a href="#106">106: </a></span></span><span class="l"><a href="#107">107: </a></span><span class="l"><a href="#108">108: </a></span><span class="l"><a href="#109">109: </a></span><span class="l"><a href="#110">110: </a></span><span class="l"><a href="#111">111: </a></span><span class="l"><a href="#112">112: </a></span><span class="l"><a href="#113">113: </a></span><span class="l"><a href="#114">114: </a></span><span class="l"><a href="#115">115: </a></span><span class="l"><a href="#116">116: </a></span><span class="l"><a href="#117">117: </a></span><span class="l"><a href="#118">118: </a></span><span class="l"><a href="#119">119: </a></span><span class="l"><a href="#120">120: </a></span><span class="l"><a href="#121">121: </a></span><span class="l"><a href="#122">122: </a></span> <span class="l"><a href="#123">123: </a></span><span class="l"><a href="#124">124: </a></span><span class="l"><a href="#125">125: </a></span><span class="l"><a href="#126">126: </a></span></span><span class="l"><a href="#127">127: </a></span></span><span class="l"><a href="#128">128: </a></span></span><span class="l"><a href="#129">129: </a></span></span><span class="l"><a href="#130">130: </a></span></span><span class="l"><a href="#131">131: </a></span></span><span class="l"><a href="#132">132: </a></span></span><span class="l"><a href="#133">133: </a></span></span><span class="l"><a href="#134">134: </a></span></span><span class="l"><a href="#135">135: </a></span></span><span class="l"><a href="#136">136: </a></span></span><span class="l"><a href="#137">137: </a></span><span class="l"><a href="#138">138: </a></span><span class="l"><a href="#139">139: </a></span><span class="l"><a href="#140">140: </a></span><span class="l"><a href="#141">141: </a></span><span class="l"><a href="#1 42">142: </a></span><span class="l"><a href="#143">143: </a></span><span class="l"><a href="#144">144: </a></span><span class="l"><a href="#145">145: </a></span><span class="l"><a href="#146">146: </a></span><span class="l"><a href="#147">147: </a></span><span class="l"><a href="#148">148: </a></span><span class="l"><a href="#149">149: </a></span><span class="l"><a href="#150">150: </a></span><span class="l"><a href="#151">151: </a></span><span class="l"><a href="#152">152: </a></span></span><span class="l"><a href="#153">153: </a></span></span><span class="l"><a href="#154">154: </a></span></span><span class="l"><a href="#155">155: </a></span></span><span class="l"><a href="#156">156: </a></span></span><span class="l"><a href="#157">157: </a></span></span><span class="l"><a href="#158">158: </a></span></span><span class="l"><a href="#159">159: </a></span></span><span class="l"><a href="#160">160: </a></span></span><span class="l"><a href="#161">161: </a></span></span><span class="l "><a href="#162">162: </a></span></span><span class="l"><a href="#163">163: </a></span></span><span class="l"><a href="#164">164: </a></span><span class="l"><a href="#165">165: </a></span><span class="l"><a href="#166">166: </a></span><span class="l"><a href="#167">167: </a></span><span class="l"><a href="#168">168: </a></span><span class="l"><a href="#169">169: </a></span><span class="l"><a href="#170">170: </a></span><span class="l"><a href="#171">171: </a></span><span class="l"><a href="#172">172: </a></span><span class="l"><a href="#173">173: </a></span><span class="l"><a href="#174">174: </a></span><span class="l"><a href="#175">175: </a></span><span class="l"><a href="#176">176: </a></span><span class="l"><a href="#177">177: </a></span><span class="l"><a href="#178">178: </a></span><span class="l"><a href="#179">179: </a></span><span class="l"><a href="#180">180: </a></span><span class="l"><a href="#181">181: </a></span><span class="l"><a href="#182">182: </a></span></span><sp an class="l"><a href="#183">183: </a></span></span><span class="l"><a href="#184">184: </a></span></span><span class="l"><a href="#185">185: </a></span></span><span class="l"><a href="#186">186: </a></span></span><span class="l"><a href="#187">187: </a></span></span><span class="l"><a href="#188">188: </a></span></span><span class="l"><a href="#189">189: </a></span></span><span class="l"><a href="#190">190: </a></span></span><span class="l"><a href="#191">191: </a></span></span><span class="l"><a href="#192">192: </a></span></span><span class="l"><a href="#193">193: </a></span></span><span class="l"><a href="#194">194: </a></span><span class="l"><a href="#195">195: </a></span><span class="l"><a href="#196">196: </a></span><span class="l"><a href="#197">197: </a></span><span class="l"><a href="#198">198: </a></span><span class="l"><a href="#199">199: </a></span><span class="l"><a href="#200">200: </a></span><span class="l"><a href="#201">201: </a></span><span class="l"><a href="#202" >202: </a></span><span class="l"><a href="#203">203: </a></span><span >class="l"><a href="#204">204: </a></span><span class="l"><a href="#205">205: ></a></span><span class="l"><a href="#206">206: </a></span><span class="l"><a >href="#207">207: </a></span><span class="l"><a href="#208">208: ></a></span><span class="l"><a href="#209">209: </a></span><span class="l"><a >href="#210">210: </a></span><span class="l"><a href="#211">211: ></a></span><span class="l"><a href="#212">212: </a></span></span><span >class="l"><a href="#213">213: </a></span></span><span class="l"><a >href="#214">214: </a></span></span><span class="l"><a href="#215">215: ></a></span></span><span class="l"><a href="#216">216: </a></span></span><span >class="l"><a href="#217">217: </a></span></span><span class="l"><a >href="#218">218: </a></span></span><span class="l"><a href="#219">219: ></a></span></span><span class="l"><a href="#220">220: </a></span></span><span >class="l"><a href="#221">221: </a></span></span><span class="l">< a href="#222">222: </a></span></span><span class="l"><a href="#223">223: </a></span><span class="l"><a href="#224">224: </a></span><span class="l"><a href="#225">225: </a></span><span class="l"><a href="#226">226: </a></span><span class="l"><a href="#227">227: </a></span><span class="l"><a href="#228">228: </a></span><span class="l"><a href="#229">229: </a></span><span class="l"><a href="#230">230: </a></span><span class="l"><a href="#231">231: </a></span><span class="l"><a href="#232">232: </a></span><span class="l"><a href="#233">233: </a></span><span class="l"><a href="#234">234: </a></span><span class="l"><a href="#235">235: </a></span><span class="l"><a href="#236">236: </a></span><span class="l"><a href="#237">237: </a></span><span class="l"><a href="#238">238: </a></span></span><span class="l"><a href="#239">239: </a></span></span><span class="l"><a href="#240">240: </a></span></span><span class="l"><a href="#241">241: </a></span></span><span class="l"><a href="#242">242: </a ></span></span><span class="l"><a href="#243">243: </a></span></span><span >class="l"><a href="#244">244: </a></span></span><span class="l"><a >href="#245">245: </a></span></span><span class="l"><a href="#246">246: ></a></span></span><span class="l"><a href="#247">247: </a></span></span><span >class="l"><a href="#248">248: </a></span></span><span class="l"><a >href="#249">249: </a></span></span><span class="l"><a href="#250">250: ></a></span></span><span class="l"><a href="#251">251: </a></span></span><span >class="l"><a href="#252">252: </a></span><span class="l"><a href="#253">253: ></a></span><span class="l"><a href="#254">254: </a></span><span class="l"><a >href="#255">255: </a></span><span class="l"><a href="#256">256: ></a></span><span class="l"><a href="#257">257: </a></span><span class="l"><a >href="#258">258: </a></span><span class="l"><a href="#259">259: ></a></span><span class="l"><a href="#260">260: </a></span><span class="l"><a >href="#261">261: </a></span><span class="l"><a href="# 262">262: </a></span><span class="l"><a href="#263">263: </a></span><span class="l"><a href="#264">264: </a></span><span class="l"><a href="#265">265: </a></span><span class="l"><a href="#266">266: </a></span><span class="l"><a href="#267">267: </a></span><span class="l"><a href="#268">268: </a></span><span class="l"><a href="#269">269: </a></span><span class="l"><a href="#270">270: </a></span><span class="l"><a href="#271">271: </a></span><span class="l"><a href="#272">272: </a></span><span class="l"><a href="#273">273: </a></span><span class="l"><a href="#274">274: </a></span><span class="l"><a href="#275">275: </a></span><span class="l"><a href="#276">276: </a></span><span class="l"><a href="#277">277: </a></span></span><span class="l"><a href="#278">278: </a></span></span><span class="l"><a href="#279">279: </a></span></span><span class="l"><a href="#280">280: </a></span></span><span class="l"><a href="#281">281: </a></span></span><span class="l"><a href="#282">282: </a></span>< /span><span class="l"><a href="#283">283: </a></span></span><span class="l"><a href="#284">284: </a></span></span><span class="l"><a href="#285">285: </a></span><span class="l"><a href="#286">286: </a></span><span class="l"><a href="#287">287: </a></span><span class="l"><a href="#288">288: </a></span><span class="l"><a href="#289">289: </a></span><span class="l"><a href="#290">290: </a></span><span class="l"><a href="#291">291: </a></span><span class="l"><a href="#292">292: </a></span><span class="l"><a href="#293">293: </a></span></span><span class="l"><a href="#294">294: </a></span></span><span class="l"><a href="#295">295: </a></span></span><span class="l"><a href="#296">296: </a></span></span><span class="l"><a href="#297">297: </a></span></span><span class="l"><a href="#298">298: </a></span></span><span class="l"><a href="#299">299: </a></span></span><span class="l"><a href="#300">300: </a></span></span><span class="l"><a href="#301">301: </a></span><span class="l"><a href="#30 2">302: </a></span><span class="l"><a href="#303">303: </a></span><span class="l"><a href="#304">304: </a></span><span class="l"><a href="#305">305: </a></span><span class="l"><a href="#306">306: </a></span><span class="l"><a href="#307">307: </a></span><span class="l"><a href="#308">308: </a></span><span class="l"><a href="#309">309: </a></span><span class="l"><a href="#310">310: </a></span><span class="l"><a href="#311">311: </a></span></code></pre> +<pre class="code"><code><span id="1" class="l"><span class="xlang"><?php</span> +</span><span id="2" class="l"> +</span><span id="3" class="l"><span class="php-comment">/** +</span></span><span id="4" class="l"><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more +</span></span><span id="5" class="l"><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with +</span></span><span id="6" class="l"><span class="php-comment"> * this work for additional information regarding copyright ownership. +</span></span><span id="7" class="l"><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0 +</span></span><span id="8" class="l"><span class="php-comment"> * (the "License"); you may not use this file except in compliance with +</span></span><span id="9" class="l"><span class="php-comment"> * the License. You may obtain a copy of the License at +</span></span><span id="10" class="l"><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0 +</span></span><span id="11" class="l"><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software +</span></span><span id="12" class="l"><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS, +</span></span><span id="13" class="l"><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +</span></span><span id="14" class="l"><span class="php-comment"> * See the License for the specific language governing permissions and +</span></span><span id="15" class="l"><span class="php-comment"> * limitations under the License. +</span></span><span id="16" class="l"><span class="php-comment"> */</span> +</span><span id="17" class="l"> +</span><span id="18" class="l"><span class="php-keyword1">namespace</span> predictionio; +</span><span id="19" class="l"> +</span><span id="20" class="l"><span class="php-keyword1">use</span> GuzzleHttp\Client; +</span><span id="21" class="l"><span class="php-keyword1">use</span> \DateTime; +</span><span id="22" class="l"> +</span><span id="23" class="l"><span class="php-comment">/** +</span></span><span id="24" class="l"><span class="php-comment"> * Client for connecting to an Event Server +</span></span><span id="25" class="l"><span class="php-comment"> * +</span></span><span id="26" class="l"><span class="php-comment"> */</span> +</span><span id="27" class="l"><span class="php-keyword1">class</span> EventClient <span class="php-keyword1">extends</span> BaseClient +</span><span id="28" class="l">{ +</span><span id="29" class="l"> <span class="php-keyword1">const</span> DATE_TIME_FORMAT = DateTime::ISO8601; +</span><span id="30" class="l"> <span class="php-keyword1">private</span> <span class="php-var">$accessKey</span>; +</span><span id="31" class="l"> <span class="php-keyword1">private</span> <span class="php-var">$eventUrl</span>; +</span><span id="32" class="l"> +</span><span id="33" class="l"> <span class="php-comment">/** +</span></span><span id="34" class="l"><span class="php-comment"> * @param string Access Key +</span></span><span id="35" class="l"><span class="php-comment"> * @param string Base URL to the Event Server. Default is localhost:7070. +</span></span><span id="36" class="l"><span class="php-comment"> * @param float Timeout of the request in seconds. Use 0 to wait indefinitely +</span></span><span id="37" class="l"><span class="php-comment"> * Default is 0. +</span></span><span id="38" class="l"><span class="php-comment"> * @param float Number of seconds to wait while trying to connect to a server. +</span></span><span id="39" class="l"><span class="php-comment"> * Default is 5. +</span></span><span id="40" class="l"><span class="php-comment"> */</span> +</span><span id="41" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct( +</span><span id="42" class="l"> <span class="php-var">$accessKey</span>, +</span><span id="43" class="l"> <span class="php-var">$baseUrl</span>=<span class="php-quote">'http://localhost:7070'</span>, +</span><span id="44" class="l"> <span class="php-var">$timeout</span>=<span class="php-num">0</span>, +</span><span id="45" class="l"> <span class="php-var">$connectTimeout</span>=<span class="php-num">5</span> +</span><span id="46" class="l"> ) { +</span><span id="47" class="l"> parent::__construct(<span class="php-var">$baseUrl</span>, <span class="php-var">$timeout</span>, <span class="php-var">$connectTimeout</span>); +</span><span id="48" class="l"> <span class="php-var">$this</span>->accessKey = <span class="php-var">$accessKey</span>; +</span><span id="49" class="l"> <span class="php-var">$this</span>->eventUrl = <span class="php-quote">"/events.json?accessKey=</span><span class="php-var">$this</span><span class="php-quote">->accessKey"</span>; +</span><span id="50" class="l"> } +</span><span id="51" class="l"> +</span><span id="52" class="l"> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> getEventTime(<span class="php-var">$eventTime</span>) +</span><span id="53" class="l"> { +</span><span id="54" class="l"> <span class="php-var">$result</span> = <span class="php-var">$eventTime</span>; +</span><span id="55" class="l"> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$eventTime</span>)) { +</span><span id="56" class="l"> <span class="php-var">$result</span> = (<span class="php-keyword1">new</span> DateTime(<span class="php-quote">'NOW'</span>))->format(self::DATE_TIME_FORMAT); +</span><span id="57" class="l"> } +</span><span id="58" class="l"> +</span><span id="59" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$result</span>; +</span><span id="60" class="l"> } +</span><span id="61" class="l"> +</span><span id="62" class="l"> <span class="php-comment">/** +</span></span><span id="63" class="l"><span class="php-comment"> * Set a user entity +</span></span><span id="64" class="l"><span class="php-comment"> * +</span></span><span id="65" class="l"><span class="php-comment"> * @param int|string User Id +</span></span><span id="66" class="l"><span class="php-comment"> * @param array Properties of the user entity to set +</span></span><span id="67" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="68" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="69" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="70" class="l"><span class="php-comment"> * +</span></span><span id="71" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="72" class="l"><span class="php-comment"> * +</span></span><span id="73" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="74" class="l"><span class="php-comment"> */</span> +</span><span id="75" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setUser(<span class="php-var">$uid</span>, <span class="php-keyword1">array</span> <span class="php-var">$properties</span>=<span class="php-keyword1">array</span>(), <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="76" class="l"> { +</span><span id="77" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="78" class="l"> +</span><span id="79" class="l"> <span class="php-comment">// casting to object so that an empty array would be represented as {}</span> +</span><span id="80" class="l"> <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$properties</span>)) { +</span><span id="81" class="l"> <span class="php-var">$properties</span> = (object)<span class="php-var">$properties</span>; +</span><span id="82" class="l"> } +</span><span id="83" class="l"> +</span><span id="84" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="85" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$set'</span>, +</span><span id="86" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'user'</span>, +</span><span id="87" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$uid</span>, +</span><span id="88" class="l"> <span class="php-quote">'properties'</span> => <span class="php-var">$properties</span>, +</span><span id="89" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="90" class="l"> ]); +</span><span id="91" class="l"> +</span><span id="92" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="93" class="l"> } +</span><span id="94" class="l"> +</span><span id="95" class="l"> <span class="php-comment">/** +</span></span><span id="96" class="l"><span class="php-comment"> * Unset a user entity +</span></span><span id="97" class="l"><span class="php-comment"> * +</span></span><span id="98" class="l"><span class="php-comment"> * @param int|string User Id +</span></span><span id="99" class="l"><span class="php-comment"> * @param array Properties of the user entity to unset +</span></span><span id="100" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="101" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="102" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="103" class="l"><span class="php-comment"> * +</span></span><span id="104" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="105" class="l"><span class="php-comment"> * +</span></span><span id="106" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="107" class="l"><span class="php-comment"> */</span> +</span><span id="108" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> unsetUser(<span class="php-var">$uid</span>, <span class="php-keyword1">array</span> <span class="php-var">$properties</span>, <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="109" class="l"> { +</span><span id="110" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="111" class="l"> <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$properties</span>)) { +</span><span id="112" class="l"> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> PredictionIOAPIError(<span class="php-quote">'Specify at least one property'</span>); +</span><span id="113" class="l"> } +</span><span id="114" class="l"> +</span><span id="115" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="116" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$unset'</span>, +</span><span id="117" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'user'</span>, +</span><span id="118" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$uid</span>, +</span><span id="119" class="l"> <span class="php-quote">'properties'</span> => <span class="php-var">$properties</span>, +</span><span id="120" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="121" class="l"> ]); +</span><span id="122" class="l"> +</span><span id="123" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="124" class="l"> } +</span><span id="125" class="l"> +</span><span id="126" class="l"> <span class="php-comment">/** +</span></span><span id="127" class="l"><span class="php-comment"> * Delete a user entity +</span></span><span id="128" class="l"><span class="php-comment"> * +</span></span><span id="129" class="l"><span class="php-comment"> * @param int|string User Id +</span></span><span id="130" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="131" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="132" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="133" class="l"><span class="php-comment"> * +</span></span><span id="134" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="135" class="l"><span class="php-comment"> * +</span></span><span id="136" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="137" class="l"><span class="php-comment"> */</span> +</span><span id="138" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> deleteUser(<span class="php-var">$uid</span>, <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="139" class="l"> { +</span><span id="140" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="141" class="l"> +</span><span id="142" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="143" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$delete'</span>, +</span><span id="144" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'user'</span>, +</span><span id="145" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$uid</span>, +</span><span id="146" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="147" class="l"> ]); +</span><span id="148" class="l"> +</span><span id="149" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="150" class="l"> } +</span><span id="151" class="l"> +</span><span id="152" class="l"> <span class="php-comment">/** +</span></span><span id="153" class="l"><span class="php-comment"> * Set an item entity +</span></span><span id="154" class="l"><span class="php-comment"> * +</span></span><span id="155" class="l"><span class="php-comment"> * @param int|string Item Id +</span></span><span id="156" class="l"><span class="php-comment"> * @param array Properties of the item entity to set +</span></span><span id="157" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="158" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="159" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="160" class="l"><span class="php-comment"> * +</span></span><span id="161" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="162" class="l"><span class="php-comment"> * +</span></span><span id="163" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="164" class="l"><span class="php-comment"> */</span> +</span><span id="165" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setItem(<span class="php-var">$iid</span>, <span class="php-keyword1">array</span> <span class="php-var">$properties</span>=<span class="php-keyword1">array</span>(), <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="166" class="l"> { +</span><span id="167" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="168" class="l"> <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$properties</span>)) { +</span><span id="169" class="l"> <span class="php-var">$properties</span> = (object)<span class="php-var">$properties</span>; +</span><span id="170" class="l"> } +</span><span id="171" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="172" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$set'</span>, +</span><span id="173" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'item'</span>, +</span><span id="174" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$iid</span>, +</span><span id="175" class="l"> <span class="php-quote">'properties'</span> => <span class="php-var">$properties</span>, +</span><span id="176" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="177" class="l"> ]); +</span><span id="178" class="l"> +</span><span id="179" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="180" class="l"> } +</span><span id="181" class="l"> +</span><span id="182" class="l"> <span class="php-comment">/** +</span></span><span id="183" class="l"><span class="php-comment"> * Unset an item entity +</span></span><span id="184" class="l"><span class="php-comment"> * +</span></span><span id="185" class="l"><span class="php-comment"> * @param int|string Item Id +</span></span><span id="186" class="l"><span class="php-comment"> * @param array Properties of the item entity to unset +</span></span><span id="187" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="188" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="189" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="190" class="l"><span class="php-comment"> * +</span></span><span id="191" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="192" class="l"><span class="php-comment"> * +</span></span><span id="193" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="194" class="l"><span class="php-comment"> */</span> +</span><span id="195" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> unsetItem(<span class="php-var">$iid</span>, <span class="php-keyword1">array</span> <span class="php-var">$properties</span>, <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="196" class="l"> { +</span><span id="197" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="198" class="l"> <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$properties</span>)) { +</span><span id="199" class="l"> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> PredictionIOAPIError(<span class="php-quote">'Specify at least one property'</span>); +</span><span id="200" class="l"> } +</span><span id="201" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="202" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$unset'</span>, +</span><span id="203" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'item'</span>, +</span><span id="204" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$iid</span>, +</span><span id="205" class="l"> <span class="php-quote">'properties'</span> => <span class="php-var">$properties</span>, +</span><span id="206" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="207" class="l"> ]); +</span><span id="208" class="l"> +</span><span id="209" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="210" class="l"> } +</span><span id="211" class="l"> +</span><span id="212" class="l"> <span class="php-comment">/** +</span></span><span id="213" class="l"><span class="php-comment"> * Delete an item entity +</span></span><span id="214" class="l"><span class="php-comment"> * +</span></span><span id="215" class="l"><span class="php-comment"> * @param int|string Item Id +</span></span><span id="216" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="217" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="218" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="219" class="l"><span class="php-comment"> * +</span></span><span id="220" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="221" class="l"><span class="php-comment"> * +</span></span><span id="222" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="223" class="l"><span class="php-comment"> */</span> +</span><span id="224" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> deleteItem(<span class="php-var">$iid</span>, <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span>) +</span><span id="225" class="l"> { +</span><span id="226" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="227" class="l"> +</span><span id="228" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="229" class="l"> <span class="php-quote">'event'</span> => <span class="php-quote">'$delete'</span>, +</span><span id="230" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'item'</span>, +</span><span id="231" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$iid</span>, +</span><span id="232" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="233" class="l"> ]); +</span><span id="234" class="l"> +</span><span id="235" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="236" class="l"> } +</span><span id="237" class="l"> +</span><span id="238" class="l"> <span class="php-comment">/** +</span></span><span id="239" class="l"><span class="php-comment"> * Record a user action on an item +</span></span><span id="240" class="l"><span class="php-comment"> * +</span></span><span id="241" class="l"><span class="php-comment"> * @param string Event name +</span></span><span id="242" class="l"><span class="php-comment"> * @param int|string User Id +</span></span><span id="243" class="l"><span class="php-comment"> * @param int|string Item Id +</span></span><span id="244" class="l"><span class="php-comment"> * @param array Properties of the event +</span></span><span id="245" class="l"><span class="php-comment"> * @param string Time of the event in ISO 8601 format +</span></span><span id="246" class="l"><span class="php-comment"> * (e.g. 2014-09-09T16:17:42.937-08:00). +</span></span><span id="247" class="l"><span class="php-comment"> * Default is the current time. +</span></span><span id="248" class="l"><span class="php-comment"> * +</span></span><span id="249" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="250" class="l"><span class="php-comment"> * +</span></span><span id="251" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="252" class="l"><span class="php-comment"> */</span> +</span><span id="253" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> recordUserActionOnItem( +</span><span id="254" class="l"> <span class="php-var">$event</span>, +</span><span id="255" class="l"> <span class="php-var">$uid</span>, +</span><span id="256" class="l"> <span class="php-var">$iid</span>, +</span><span id="257" class="l"> <span class="php-keyword1">array</span> <span class="php-var">$properties</span>=<span class="php-keyword1">array</span>(), +</span><span id="258" class="l"> <span class="php-var">$eventTime</span>=<span class="php-keyword1">null</span> +</span><span id="259" class="l"> ) { +</span><span id="260" class="l"> <span class="php-var">$eventTime</span> = <span class="php-var">$this</span>->getEventTime(<span class="php-var">$eventTime</span>); +</span><span id="261" class="l"> <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$properties</span>)) { +</span><span id="262" class="l"> <span class="php-var">$properties</span> = (object)<span class="php-var">$properties</span>; +</span><span id="263" class="l"> } +</span><span id="264" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>([ +</span><span id="265" class="l"> <span class="php-quote">'event'</span> => <span class="php-var">$event</span>, +</span><span id="266" class="l"> <span class="php-quote">'entityType'</span> => <span class="php-quote">'user'</span>, +</span><span id="267" class="l"> <span class="php-quote">'entityId'</span> => <span class="php-var">$uid</span>, +</span><span id="268" class="l"> <span class="php-quote">'targetEntityType'</span> => <span class="php-quote">'item'</span>, +</span><span id="269" class="l"> <span class="php-quote">'targetEntityId'</span> => <span class="php-var">$iid</span>, +</span><span id="270" class="l"> <span class="php-quote">'properties'</span> => <span class="php-var">$properties</span>, +</span><span id="271" class="l"> <span class="php-quote">'eventTime'</span> => <span class="php-var">$eventTime</span>, +</span><span id="272" class="l"> ]); +</span><span id="273" class="l"> +</span><span id="274" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="275" class="l"> } +</span><span id="276" class="l"> +</span><span id="277" class="l"> <span class="php-comment">/** +</span></span><span id="278" class="l"><span class="php-comment"> * Create an event +</span></span><span id="279" class="l"><span class="php-comment"> * +</span></span><span id="280" class="l"><span class="php-comment"> * @param array An array describing the event +</span></span><span id="281" class="l"><span class="php-comment"> * +</span></span><span id="282" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="283" class="l"><span class="php-comment"> * +</span></span><span id="284" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="285" class="l"><span class="php-comment"> */</span> +</span><span id="286" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> createEvent(<span class="php-keyword1">array</span> <span class="php-var">$data</span>) +</span><span id="287" class="l"> { +</span><span id="288" class="l"> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>(<span class="php-var">$data</span>); +</span><span id="289" class="l"> +</span><span id="290" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest(<span class="php-quote">'POST'</span>, <span class="php-var">$this</span>->eventUrl, <span class="php-var">$json</span>); +</span><span id="291" class="l"> } +</span><span id="292" class="l"> +</span><span id="293" class="l"> <span class="php-comment">/** +</span></span><span id="294" class="l"><span class="php-comment"> * Retrieve an event +</span></span><span id="295" class="l"><span class="php-comment"> * +</span></span><span id="296" class="l"><span class="php-comment"> * @param string Event ID +</span></span><span id="297" class="l"><span class="php-comment"> * +</span></span><span id="298" class="l"><span class="php-comment"> * @return string JSON response +</span></span><span id="299" class="l"><span class="php-comment"> * +</span></span><span id="300" class="l"><span class="php-comment"> * @throws PredictionIOAPIError Request error +</span></span><span id="301" class="l"><span class="php-comment"> */</span> +</span><span id="302" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getEvent(<span class="php-var">$eventId</span>) +</span><span id="303" class="l"> { +</span><span id="304" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->sendRequest( +</span><span id="305" class="l"> <span class="php-quote">'GET'</span>, +</span><span id="306" class="l"> <span class="php-quote">"/events/</span><span class="php-var">$eventId</span><span class="php-quote">.json?accessKey=</span><span class="php-var">$this</span><span class="php-quote">->accessKey"</span>, +</span><span id="307" class="l"> <span class="php-quote">''</span> +</span><span id="308" class="l"> ); +</span><span id="309" class="l"> } +</span><span id="310" class="l">} +</span><span id="311" class="l"></span></code></pre> + + <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>
