/CVENTTool/CventClient.class.php

https://github.com/mariothomas1/soflopmi · PHP · 345 lines · 276 code · 35 blank · 34 comment · 59 complexity · 6708cab437e2d8730263b6f7538ff518 MD5 · raw file 

    

  1. <?php
    2. 

  2. /*
    3. 

  3. ** CventClient.class.php
    4. 

  4. ** Author: github.com/gcanivet
    5. 

  5. ** Description: A php soap client for the Cvent API. 
    6. 

  6. **
    7. 

  7. ** To Do:
    8. 

  8. **     - add additional remote functions support
    9. 

  9. **     - add logging capabilities	 
    10. 

  10. **     - proper docs format
    11. 

  11. **     
    12. 

  12. ** Notes:
    13. 

  13. **     - Search - 25,000 IDs limit not handled
    14. 

  14. **     - CreateContact, UpdateContact, DeleteContact, CreateContactGroup, TransferInvitee, and SendEmail - 200 object limit not handled
    15. 

  15. **     - GetUpdated - 10,000 IDs limit not handled
    16. 

  16. ** ... Typicaly a limit of 25,000 ids returned, maximum 256 search filter, but depends on Client accounts
    17. 

  17. **
    18. 

  18. */
    19. 

  19. ini_set('soap.wsdl_cache_enabled', 1); 
    20. 

  20. ini_set('soap.wsdl_cache_ttl', 86400); //default: 86400, in seconds
    21. 

  21. 

  22. class CventClient extends SoapClient {
    23. 

  23. 	public $client;
    24. 

  24. 	public $ServerURL;
    25. 

  25. 	public $CventSessionHeader;
    26. 

  26. 	public $debug = false;
    27. 

  27. 	public $MAX_FILTER_SIZE = 100; # 256 doesn't seem to work.
    28. 

  28. 	public $RESULTS_PER_PAGE = 200;
    29. 

  29. 	
    30. 

  30. 	public function CventClient() {
    31. 

  31. 	
    32. 

  32. 	}
    33. 

  33. 

  34. 	public function Login($acct, $username, $password) {
    35. 

  35. 		$this->client = new SoapDebugClient("https://api.cvent.com/soap/V200611.ASMX?WSDL", array('trace' => true, 'exceptions' => true));
    36. 

  36. 		$cache = true;
    37. 

  37. 		$file = 'cvent_api_session.txt';
    38. 

  38. 		if($cache && file_exists($file) && time() <= strtotime("+1 hour", $last = filemtime($file))) { 
    39. 

  39. 			# a valid session is cached, use it
    40. 

  40. 			if($this->debug) print 'CventClient::Session already exists.<br/>';
    41. 

  41. 			$data = file_get_contents($file);
    42. 

  42. 			$arr_response = array();
    43. 

  43. 			$arr_response = explode(',', $data);
    44. 

  44. 			$this->ServerURL = $arr_response[0];
    45. 

  45. 			$this->CventSessionHeader = $arr_response[1];					
    46. 

  46. 		} else { # sessions expire 1hr after CREATION
    47. 

  47. 			if($this->debug) print 'CventClient::Session does not exist. Get new one.<br/>';
    48. 

  48. 			$params = array();
    49. 

  49. 			$params['AccountNumber'] = $acct;
    50. 

  50. 			$params['UserName']		= $username;
    51. 

  51. 			$params['Password']		= $password;
    52. 

  52. 			
    53. 

  53. 			//herehere
    54. 

  54. 			var_dump('deleteme', $params);
    55. 

  55. 			
    56. 

  56. 			$response = $this->client->Login($params);
    57. 

  57. 			if(!$response->LoginResult->LoginSuccess) {
    58. 

  58. 				throw new Exception("CventClient:: Login unsuccessful");
    59. 

  59. 			}
    60. 

  60. 			$arr_response = array();
    61. 

  61. 			$arr_response[] = $response->LoginResult->ServerURL;
    62. 

  62. 			$arr_response[] = $response->LoginResult->CventSessionHeader;
    63. 

  63. 			$data = implode(',', $arr_response);
    64. 

  64. 			file_put_contents($file, $data);
    65. 

  65. 			$this->ServerURL = $arr_response[0];
    66. 

  66. 			$this->CventSessionHeader = $arr_response[1];
    67. 

  67. 		}
    68. 

  68. 		$this->client->__setLocation($this->ServerURL);
    69. 

  69. 		$header_body = array('CventSessionValue' => $this->CventSessionHeader);
    70. 

  70. 		$header = new SoapHeader('http://api.cvent.com/2006-11', 'CventSessionHeader', $header_body);
    71. 

  71. 		$this->client->__setSoapHeaders($header);
    72. 

  72. 		if($this->debug) print 'CventClient:: ServerURL: '.$this->ServerURL.', CventSessionHeader: '.$this->CventSessionHeader.'<br/>';
    73. 

  73. 	}
    74. 

  74. 	
    75. 

  75. 	public function DescribeGlobal() {
    76. 

  76. 		$response = $this->client->DescribeGlobal();
    77. 

  77. 		return $response;
    78. 

  78. 	}
    79. 

  79. 	
    80. 

  80. 	public function DescribeCvObject($objectTypes) {
    81. 

  81. 		$params->ObjectTypes = $objectTypes;
    82. 

  82. 		$response = $this->client->DescribeCvObject($params);
    83. 

  83. 		return $response;
    84. 

  84. 	}		
    85. 

  85. 	
    86. 

  86. 	public function GetEventById($eventId) {
    87. 

  87. 		$events = $this->RetrieveEvents($eventId);	
    88. 

  88. 		if(sizeof($events) != 1) throw new Exception('CventClient::GetEventById: EventId '.$eventId.' not found');
    89. 

  89. 		return $events[0];
    90. 

  90. 	}
    91. 

  91. 	
    92. 

  92. 	public function GetUpcomingEvents() {
    93. 

  93. 		// needs to be tested
    94. 

  94. 		$v = date('Y-m-d', strtotime('-14 days')).'T00:00:00'; // '2011-10-31T00:00:00';
    95. 

  95. 		$response = $this->SearchByFilter('Event', 'AndSearch', array((object) array('Field' => 'EventStartDate', 'Operator' => 'Greater than', 'Value' => $v)));
    96. 

  96. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    97. 

  97. 		return false;
    98. 

  98. 	}
    99. 

  99. 	
    100. 

  100. 	public function GetNumberOfRegistrations($eventId) {
    101. 

  101. 		// needs to be tested
    102. 

  102. 		$response = $this->SearchByFilter('Registration', 'AndSearch', array((object) array('Field' => 'EventId', 'Operator' => 'Equals', 'Value' => $eventId)));
    103. 

  103. 		if(isset($response->SearchResult->Id)) return count($response->SearchResult->Id);
    104. 

  104. 		return false;
    105. 

  105. 	}
    106. 

  106. 	
    107. 

  107. 	public function GetNumberOfGuests($eventId) {
    108. 

  108. 		// needs to be tested
    109. 

  109. 		$response = $this->SearchByFilter('Guest', 'AndSearch', array((object) array('Field' => 'EventId', 'Operator' => 'Equals', 'Value' => $eventId)));
    110. 

  110. 		if(isset($response->SearchResult->Id)) return count($response->SearchResult->Id);
    111. 

  111. 		return false;
    112. 

  112. 	}
    113. 

  113. 	
    114. 

  114. 	public function SearchAllDistributionLists() {
    115. 

  115. 		$response = $this->SearchByFilter('DistributionList', 'OrSearch', array(
    116. 

  116. 							(object) array('Field' => 'DistributionListName', 'Operator' => 'Equals', 'Value' => 'Something'),
    117. 

  117. 			      				(object) array('Field' => 'DistributionListName', 'Operator' => 'Not Equal to', 'Value' => 'Something')));
    118. 

  118. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    119. 

  119. 		return false;
    120. 

  120. 	}
    121. 

  121. 

  122. 	public function SearchContactBySourceId($remaxId) {
    123. 

  123. 		$response = $this->SearchByFilter('Contact', 'AndSearch', array((object) array('Field' => 'SourceId', 'Operator' => 'Equals', 'Value' => $remaxId)));
    124. 

  124. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    125. 

  125. 		return false;
    126. 

  126. 	}
    127. 

  127. 	
    128. 

  128. 	public function SearchContactsByGroupId($groupId) {
    129. 

  129. 		$response = $this->SearchByFilter('Contact', 'AndSearch', array((object) array('Field' => 'GroupId', 'Operator' => 'Equals', 'Value' => $groupId)));
    130. 

  130. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    131. 

  131. 		return false;
    132. 

  132. 	}
    133. 

  133. 

  134. 	public function SearchContactsByDistributionListId($distId) {
    135. 

  135. 		$response = $this->SearchByFilter('Contact', 'AndSearch', array((object) array('Field' => 'DistId', 'Operator' => 'Equals', 'Value' => $distId)));
    136. 

  136. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    137. 

  137. 		return false;
    138. 

  138. 	}
    139. 

  139. 

  140. 	public function SearchContactByDistributionListIdAndEmail($distId, $email) {
    141. 

  141. 		// name implies email is unique
    142. 

  142. 		$response = $this->SearchByFilter('Contact', 'AndSearch', array(
    143. 

  143. 							(object) array('Field' => 'DistId', 'Operator' => 'Equals', 'Value' => $distId),
    144. 

  144. 							(object) array('Field' => 'EmailAddress', 'Operator' => 'Equals', 'Value' => $email)));
    145. 

  145. 		if(isset($response->SearchResult->Id)) return $response->SearchResult->Id;
    146. 

  146. 		return false;
    147. 

  147. 	}
    148. 

  148. 	
    149. 

  149. 

  150. 	# Retrieve 
    151. 

  151. 	public function RetrieveEvents($ids) {
    152. 

  152. 		return $this->RetrieveAllPages('Event', $ids);
    153. 

  153. 	}
    154. 

  154. 

  155. 	public function RetrieveContacts($ids) {
    156. 

  156. 		return $this->RetrieveAllPages('Contact', $ids);
    157. 

  157. 	}
    158. 

  158. 	public function RetrieveDistributionLists($ids) {
    159. 

  159. 		return $this->RetrieveAllPages('DistributionList', $ids);
    160. 

  160. 	}
    161. 

  161. 	public function RetrieveContactBySourceId($remaxid) {
    162. 

  162. 		$result = $this->SearchContactBySourceId($remaxid);		
    163. 

  163. 		if($result === false) throw new Exception("CventClient::RetrieveContactBySourceId::$remaxid not found, cannot retrieve");
    164. 

  164. 		$ids[] = $result->SearchResult->Id;
    165. 

  165. 		$result = $this->RetrieveContacts($ids);		
    166. 

  166. 		return $result;
    167. 

  167. 	}
    168. 

  168. 	
    169. 

  169. 	public function RetrieveContactIdsBySourceIds($sourceIds) {
    170. 

  170. 		// needs to be tested
    171. 

  171. 		// this returns Ids, not Objects, for consistency should be renamed SearchContactsBySourceIds($sourceIds)
    172. 

  172. 		$total = count($sourceIds);
    173. 

  173. 		$contactIds = array();
    174. 

  174. 		for($i = 0; $i < count($sourceIds); $i += $this->MAX_FILTER_SIZE) {
    175. 

  175. 			if ($this->debug) print "CventClient::RetrieveContactIdsBySourceIds:: retrieving contactIds from $i to ".($i + $this->MAX_FILTER_SIZE)."<br/>";
    176. 

  176. 			$batch = array_slice($sourceIds, $i, $i + $this->MAX_FILTER_SIZE);		
    177. 

  177. 			$criteria = NULL;
    178. 

  178. 			$criteria->ObjectType = 'Contact';
    179. 

  179. 			$criteria->CvSearchObject->SearchType = 'OrSearch';	
    180. 

  180. 			for($j=0; $j < sizeof($batch); $j++) {
    181. 

  181. 				$criteria->CvSearchObject->Filter[$j]->Field = 'SourceId';
    182. 

  182. 				$criteria->CvSearchObject->Filter[$j]->Operator = 'Equals';
    183. 

  183. 				$criteria->CvSearchObject->Filter[$j]->Value = $batch[$j];
    184. 

  184. 			}
    185. 

  185. 			$tmp = $this->client->Search($criteria);
    186. 

  186. 			$tmp = $tmp->SearchResult->Id;
    187. 

  187. 			if(is_array($tmp)) {
    188. 

  188. 				$contactIds = array_merge($contactIds, $tmp);
    189. 

  189. 			} else {
    190. 

  190. 				$contactIds = array_merge($contactIds, array($tmp));
    191. 

  191. 			}
    192. 

  192. 		}
    193. 

  193. 		return $contactIds;			
    194. 

  194. 	}
    195. 

  195. 		
    196. 

  196. 	
    197. 

  197. 	# Create or Updates
    198. 

  198. 	
    199. 

  199. 	public function AddContactsToDistributionList($distId, $contactIds) {
    200. 

  200. 		if(!is_array($contactIds)) $contactIds = array($contactIds); // safety measure, contactId must be CvObject type
    201. 

  201. 		$response = $this->client->ManageDistributionListMembers((object) array('DistListId' => $distId, 'Action' => 'Add', 'CvObjects' => $contactIds));	
    202. 

  202. 		if(isset($response->ManageDistributionListMembersResult->ManageDistributionListResult)) return $response->ManageDistributionListMembersResult->ManageDistributionListResult;
    203. 

  203. 		return false;
    204. 

  204. 	}
    205. 

  205.  	public function AddContactToDistributionListByEmailAddress($distId, $email) {
    206. 

  206. 		$response = $this->SearchByFilter('Contact', 'AndSearch', array((object) array('Field' => 'EmailAddress', 'Operator' => 'Equals', 'Value' => $email)));
    207. 

  207. 		if(!isset($response->SearchResult->Id)) return false;
    208. 

  208. 		$contactId =  $response->SearchResult->Id;
    209. 

  209. 		return $this->AddContactsToDistributionList($distId, array((object) array('Id' => $contactId, 'MessageId' => '')));
    210. 

  210. 	}	
    211. 

  211. 	public function CreateContactAndAddToDistributionList($contact, $distId) {	
    212. 

  212. 		// pre: contact is an array with appropriate contact fields 
    213. 

  213. 		$contacts = array($contact);	
    214. 

  214. 		$results = $this->CreateUpdateContacts('Create', $contacts);
    215. 

  215. 	 	print "<br/>create contacts<pre>";
    216. 

  216. 		print_r($results);
    217. 

  217. 		print "</pre><br/>";
    218. 

  218. 		
    219. 

  219. 		if(sizeof($results['passed']) == 1) { // new contact
    220. 

  220. 			$contactId = $results['passed'][0]['result']->Id;
    221. 

  221. 			print "contactId: ".$contactId;
    222. 

  222. 			return $this->AddContactsToDistributionList($distId, array((object) array('Id' => $contactId, 'MessageId' => '')));
    223. 

  223. 		} elseif (sizeof($results['failed']) == 1) { // error adding contact
    224. 

  224. 			$errcode = $results['failed'][0]['result']->Errors->Error[0]->Code;
    225. 

  225. 			if($errcode == 'CV40104' || $errcode == 'CV40103') { // contact already exists | duplicated contact object
    226. 

  226. 				$emailaddress = $results['failed'][0]['contact']['EmailAddress'];
    227. 

  227. 				print "emailaddress: ".$emailaddress;
    228. 

  228. 				return $this->AddContactToDistributionListByEmailAddress($distId, $emailaddress);		
    229. 

  229. 			}
    230. 

  230. 		} 
    231. 

  231. 		return false;
    232. 

  232. 	}
    233. 

  233. 

  234. 	
    235. 

  235. 	public function CreateUpdateContacts($type, $contacts) {
    236. 

  236. 		# type = 'Create' or 'Update'
    237. 

  237. 		// this could be improved A LOT
    238. 

  238. 		if(!is_array($contacts)) $contacts = array($contacts);
    239. 

  239. 		$total = sizeof($contacts);
    240. 

  240. 		$pages = ceil($total / $this->RESULTS_PER_PAGE);
    241. 

  241. 		$remainder = $total % $this->RESULTS_PER_PAGE;
    242. 

  242. 		$passed = array();
    243. 

  243. 		$failed = array();
    244. 

  244. 		for($i = 0; $i < $pages; $i++) {
    245. 

  245. 			$x = $i * $this->RESULTS_PER_PAGE;
    246. 

  246. 			$y = $this->RESULTS_PER_PAGE;
    247. 

  247. 			if($pages == $i + 1) $y = $remainder;
    248. 

  248. 			if ($this->debug) print "CventClient::CreateUpdateContacts::Page $i, creating $y Ids starting at array index $x<br/>";
    249. 

  249. 			$batch = array_slice($contacts, $x, $y);		
    250. 

  250. 			$criteria =  NULL;
    251. 

  251. 			$tmp = NULL;
    252. 

  252. 			$criteria->Contacts = $batch;		
    253. 

  253. 			# process batch
    254. 

  254. 			if($type == 'Create') {
    255. 

  255. 				$tmp = $this->client->CreateContact($criteria);
    256. 

  256. 				$tmp = @$tmp->CreateContactResult->CreateContactResult;
    257. 

  257. 			} elseif ($type == 'Update') {
    258. 

  258. 				$tmp = $this->client->UpdateContact($criteria);
    259. 

  259. 				$tmp = @$tmp->UpdateContactResult->UpdateContactResult;
    260. 

  260. 			} else {
    261. 

  261. 				throw new Exception("CventClient::CreateUpdateContacts:: Invalid $type for this method");
    262. 

  262. 			}
    263. 

  263. 			if(isset($tmp)) {
    264. 

  264. 				if(is_array($tmp)) {
    265. 

  265. 					$result = $tmp;				
    266. 

  266. 				} else {
    267. 

  267. 					$result = array($tmp);
    268. 

  268. 				}
    269. 

  269. 				if(sizeof($result) != sizeof($batch)) throw new Exception("CventClient::CreateUpdateContacts:: Size of results mismatch with size of batch");
    270. 

  270. 				# organize pass/fails
    271. 

  271. 				$pass = array();
    272. 

  272. 				$fail = array();
    273. 

  273. 				for($j = 0; $j < sizeof($result); $j++) {
    274. 

  274. 					if(isset($result[$j]->Errors->Error)) {
    275. 

  275. 						$fail[] = array('contact' => $batch[$j], 'result' => $result[$j]);
    276. 

  276. 					} else {
    277. 

  277. 						$pass[] = array('contact' => $batch[$j], 'result' => $result[$j]);
    278. 

  278. 					}
    279. 

  279. 				}
    280. 

  280. 				$failed = array_merge($failed, $fail);
    281. 

  281. 				$passed = array_merge($passed, $pass);				
    282. 

  282. 			} 
    283. 

  283. 		}
    284. 

  284. 		if(sizeof($passed) + sizeof($failed) != $total) throw new Exception("CventClient::CreateUpdateContacts:: Total pass+fails does not match total contacts.");
    285. 

  285. 		return array('passed' => $passed, 'failed' => $failed); 
    286. 

  286. 	}
    287. 

  287. 

  288. 	# helpers
    289. 

  289. 	private function RetrieveAllPages($objecttype, $ids) {
    290. 

  290. 		if(!is_array($ids)) $ids = array($ids); // safety measure
    291. 

  291. 		$results = array();
    292. 

  292. 		for($i=0; $i < count($ids); $i += $this->RESULTS_PER_PAGE) {
    293. 

  293. 			if ($this->debug) print "CventClient::RetrievePages:: retrieving $objecttype using Ids from $i to ".($i+$this->RESULTS_PER_PAGE)."<br/>";
    294. 

  294. 			$batch = array_slice($ids, $i, $i + $this->RESULTS_PER_PAGE);
    295. 

  295. 			$criteria = (object) array('ObjectType' => $objecttype, 'Ids' => $batch);
    296. 

  296. 			$tmp = $this->client->Retrieve($criteria);
    297. 

  297. 			if(is_array($tmp->RetrieveResult->CvObject)) {
    298. 

  298. 				$results = array_merge($results, $tmp->RetrieveResult->CvObject);
    299. 

  299. 			} else {
    300. 

  300. 				$results = array_merge($results, array($tmp->RetrieveResult->CvObject));
    301. 

  301. 			}
    302. 

  302. 		}
    303. 

  303. 		return $results;
    304. 

  304. 	}
    305. 

  305. 

  306.  	public function SearchByFilter($objecttype, $type, $filters)  {
    307. 

  307. 		$response = $this->client->Search((object) array('ObjectType' => $objecttype, 'CvSearchObject' => (object) array('SearchType' => $type, 'Filter' => $filters)));
    308. 

  308. 		return $response;
    309. 

  309. 	}	
    310. 

  310. }
    311. 

  311. 

  312. 

  313. class SoapDebugClient extends SoapClient {
    314. 

  314. 	public function __doRequest($request, $location, $action, $version, $one_way = 0) {
    315. 

  315. 		//if (DEBUG) print htmlspecialchars($request);
    316. 

  316. 		flush();
    317. 

  317. 		return parent::__doRequest($request, $location, $action, $version);
    318. 

  318. 	}
    319. 

  319. 

  320. 	public function webServiceDetails() {
    321. 

  321. 		print "<strong>Functions:</strong><pre>";
    322. 

  322. 		print_r($this->client->__getFunctions());
    323. 

  323. 		print "</pre>";
    324. 

  324. 		
    325. 

  325. 		print "<strong>Types:</strong><pre>";
    326. 

  326. 		print_r($this->client->__getTypes());
    327. 

  327. 		print "</pre>";
    328. 

  328. 	}
    329. 

  329. 	public function debug() {
    330. 

  330. 		print "<pre>";
    331. 

  331. 		print htmlspecialchars($this->client->__getLastRequestHeaders());
    332. 

  332. 		print "</pre>";
    333. 

  333. 		print "<pre>";		
    334. 

  334. 		print htmlspecialchars($this->client->__getLastRequest());
    335. 

  335. 		print "</pre>";
    336. 

  336. 		print "<pre>";
    337. 

  337. 		print htmlspecialchars($this->client->__getLastResponseHeaders());
    338. 

  338. 		print "</pre>";
    339. 

  339. 		print "<pre>";
    340. 

  340. 		print htmlspecialchars($this->client->__getLastResponse());
    341. 

  341. 		print "</pre>";
    342. 

  342. 	}
    343. 

  343. 

  344. }
    345.