Merge pull request #3229 from eileenmcnaughton/e-notice
[civicrm-core.git] / api / v3 / examples / Participant / NestedDelete.php
index d786d42fe2288f95f58a538e047b41bebb40b654..bdeabddd7f1349f66de8f8a7201b927c63c58280 100644 (file)
@@ -1,21 +1,29 @@
 <?php
-
-/*
- Criteria delete by nesting a GET & a DELETE
+/**
+ * Test Generated example of using participant Get API
+ * Criteria delete by nesting a GET & a DELETE *
  */
 function participant_get_example(){
 $params = array(
-  'version' => 3,
   'contact_id' => 4,
   'api.participant.delete' => 1,
 );
 
-  $result = civicrm_api( 'participant','Get',$params );
+try{
+  $result = civicrm_api3('participant', 'Get', $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 participant_get_expectedresult(){
@@ -31,10 +39,10 @@ function participant_get_expectedresult(){
           'contact_sub_type' => '',
           'sort_name' => 'Anderson, Anthony',
           'display_name' => 'Mr. Anthony Anderson II',
-          'event_id' => '37',
+          'event_id' => '38',
           'event_title' => 'Annual CiviCRM meet',
-          'event_start_date' => '2008-10-21 00:00:00',
-          'event_end_date' => '2008-10-23 00:00:00',
+          'event_start_date' => '2013-07-29 00:00:00',
+          'event_end_date' => '2013-08-04 00:00:00',
           'participant_id' => '2',
           'participant_fee_level' => '',
           'participant_fee_amount' => '',
@@ -65,10 +73,10 @@ function participant_get_expectedresult(){
           'contact_sub_type' => '',
           'sort_name' => 'Anderson, Anthony',
           'display_name' => 'Mr. Anthony Anderson II',
-          'event_id' => '37',
+          'event_id' => '38',
           'event_title' => 'Annual CiviCRM meet',
-          'event_start_date' => '2008-10-21 00:00:00',
-          'event_end_date' => '2008-10-23 00:00:00',
+          'event_start_date' => '2013-07-29 00:00:00',
+          'event_end_date' => '2013-08-04 00:00:00',
           'participant_id' => '3',
           'participant_fee_level' => '',
           'participant_fee_amount' => '',
@@ -96,7 +104,7 @@ function participant_get_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -104,20 +112,20 @@ function participant_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testNestedDelete and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ParticipantTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.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
+*/