Merge pull request #2749 from monishdeb/HR-317
[civicrm-core.git] / api / v3 / examples / Event / IsFullOption.php
index f45d08f40a4a47a656a7e38e8562c374449fd79f..b12cddd3a2fb8c48da45cc85ada1884794db90d9 100644 (file)
@@ -1,26 +1,34 @@
 <?php
-
-/*
- demonstrates use of return is_full 
+/**
+ * Test Generated example of using event getsingle API
+ * demonstrates use of return is_full  *
  */
 function event_getsingle_example(){
-$params = array( 
+$params = array(
   'id' => 1,
-  'version' => 3,
   'return.is_full' => 1,
 );
 
-  $result = civicrm_api( 'event','getsingle',$params );
+try{
+  $result = civicrm_api3('event', 'getsingle', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function event_getsingle_expectedresult(){
 
-  $expectedResult = array( 
+  $expectedResult = array(
   'id' => '1',
   'title' => 'Annual CiviCRM meet',
   'event_title' => 'Annual CiviCRM meet',
@@ -42,13 +50,13 @@ function event_getsingle_expectedresult(){
   'is_multiple_registrations' => 0,
   'allow_same_participant_emails' => 0,
   'is_template' => 0,
-  'created_date' => '2013-02-04 22:31:24',
+  'created_date' => '2014-02-13 00:22:14',
   'is_share' => '1',
   'available_places' => 0,
   'is_full' => '1',
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -56,20 +64,20 @@ function event_getsingle_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetSingleReturnIsFull and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/EventTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
 *
 * You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api/explorer
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/