1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: <?php
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace predictionio;
use GuzzleHttp\Client;
use \DateTime;
/**
* Client for connecting to an Event Server
*
*/
class EventClient extends BaseClient
{
const DATE_TIME_FORMAT = DateTime::ISO8601;
private $accessKey;
private $eventUrl;
/**
* @param string Access Key
* @param string Base URL to the Event Server. Default is localhost:7070.
* @param float Timeout of the request in seconds. Use 0 to wait indefinitely
* Default is 0.
* @param float Number of seconds to wait while trying to connect to a server.
* Default is 5.
*/
public function __construct(
$accessKey,
$baseUrl='http://localhost:7070',
$timeout=0,
$connectTimeout=5
) {
parent::__construct($baseUrl, $timeout, $connectTimeout);
$this->accessKey = $accessKey;
$this->eventUrl = "/events.json?accessKey=$this->accessKey";
}
private function getEventTime($eventTime)
{
$result = $eventTime;
if (!isset($eventTime)) {
$result = (new DateTime('NOW'))->format(self::DATE_TIME_FORMAT);
}
return $result;
}
/**
* Set a user entity
*
* @param int|string User Id
* @param array Properties of the user entity to set
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function setUser($uid, array $properties=array(), $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
// casting to object so that an empty array would be represented as {}
if (empty($properties)) {
$properties = (object)$properties;
}
$json = json_encode([
'event' => '$set',
'entityType' => 'user',
'entityId' => $uid,
'properties' => $properties,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Unset a user entity
*
* @param int|string User Id
* @param array Properties of the user entity to unset
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function unsetUser($uid, array $properties, $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
if (empty($properties)) {
throw new PredictionIOAPIError('Specify at least one property');
}
$json = json_encode([
'event' => '$unset',
'entityType' => 'user',
'entityId' => $uid,
'properties' => $properties,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Delete a user entity
*
* @param int|string User Id
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function deleteUser($uid, $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
$json = json_encode([
'event' => '$delete',
'entityType' => 'user',
'entityId' => $uid,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Set an item entity
*
* @param int|string Item Id
* @param array Properties of the item entity to set
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function setItem($iid, array $properties=array(), $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
if (empty($properties)) {
$properties = (object)$properties;
}
$json = json_encode([
'event' => '$set',
'entityType' => 'item',
'entityId' => $iid,
'properties' => $properties,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Unset an item entity
*
* @param int|string Item Id
* @param array Properties of the item entity to unset
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function unsetItem($iid, array $properties, $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
if (empty($properties)) {
throw new PredictionIOAPIError('Specify at least one property');
}
$json = json_encode([
'event' => '$unset',
'entityType' => 'item',
'entityId' => $iid,
'properties' => $properties,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Delete an item entity
*
* @param int|string Item Id
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function deleteItem($iid, $eventTime=null)
{
$eventTime = $this->getEventTime($eventTime);
$json = json_encode([
'event' => '$delete',
'entityType' => 'item',
'entityId' => $iid,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Record a user action on an item
*
* @param string Event name
* @param int|string User Id
* @param int|string Item Id
* @param array Properties of the event
* @param string Time of the event in ISO 8601 format
* (e.g. 2014-09-09T16:17:42.937-08:00).
* Default is the current time.
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function recordUserActionOnItem(
$event,
$uid,
$iid,
array $properties=array(),
$eventTime=null
) {
$eventTime = $this->getEventTime($eventTime);
if (empty($properties)) {
$properties = (object)$properties;
}
$json = json_encode([
'event' => $event,
'entityType' => 'user',
'entityId' => $uid,
'targetEntityType' => 'item',
'targetEntityId' => $iid,
'properties' => $properties,
'eventTime' => $eventTime,
]);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Create an event
*
* @param array An array describing the event
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function createEvent(array $data)
{
$json = json_encode($data);
return $this->sendRequest('POST', $this->eventUrl, $json);
}
/**
* Retrieve an event
*
* @param string Event ID
*
* @return string JSON response
*
* @throws PredictionIOAPIError Request error
*/
public function getEvent($eventId)
{
return $this->sendRequest(
'GET',
"/events/$eventId.json?accessKey=$this->accessKey",
''
);
}
}