api/v3/examples/Participant/NestedDelete.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Participant.get API.
   4  *
   5  * Criteria delete by nesting a GET & a DELETE.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function participant_get_example() {
  11   $params = array(
  12     'contact_id' => 4,
  13     'api.participant.delete' => 1,
  14   );
  15
  16   try{
  17     $result = civicrm_api3('Participant', 'get', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return array(
  25       'is_error' => 1,
  26       'error_message' => $errorMessage,
  27       'error_code' => $errorCode,
  28       'error_data' => $errorData,
  29     );
  30   }
  31
  32   return $result;
  33 }
  34
  35 /**
  36  * Function returns array of result expected from previous function.
  37  *
  38  * @return array
  39  *   API result array
  40  */
  41 function participant_get_expectedresult() {
  42
  43   $expectedResult = array(
  44     'is_error' => 0,
  45     'version' => 3,
  46     'count' => 2,
  47     'values' => array(
  48       '2' => array(
  49         'contact_id' => '4',
  50         'contact_type' => 'Individual',
  51         'contact_sub_type' => '',
  52         'sort_name' => 'Anderson, Anthony',
  53         'display_name' => 'Mr. Anthony Anderson II',
  54         'event_id' => '41',
  55         'event_title' => 'Annual CiviCRM meet',
  56         'event_start_date' => '2013-07-29 00:00:00',
  57         'event_end_date' => '2013-08-04 00:00:00',
  58         'participant_id' => '2',
  59         'participant_fee_level' => '',
  60         'participant_fee_amount' => '',
  61         'participant_fee_currency' => '',
  62         'event_type' => 'Conference',
  63         'participant_status_id' => '2',
  64         'participant_status' => 'Attended',
  65         'participant_role_id' => '1',
  66         'participant_role' => 'Attendee',
  67         'participant_register_date' => '2007-02-19 00:00:00',
  68         'participant_source' => 'Wimbeldon',
  69         'participant_note' => '',
  70         'participant_is_pay_later' => 0,
  71         'participant_is_test' => 0,
  72         'participant_registered_by_id' => '1',
  73         'participant_discount_name' => '',
  74         'participant_campaign_id' => '',
  75         'id' => '2',
  76         'api.participant.delete' => array(
  77           'is_error' => 0,
  78           'version' => 3,
  79           'count' => 1,
  80           'values' => 1,
  81         ),
  82       ),
  83       '3' => array(
  84         'contact_id' => '4',
  85         'contact_type' => 'Individual',
  86         'contact_sub_type' => '',
  87         'sort_name' => 'Anderson, Anthony',
  88         'display_name' => 'Mr. Anthony Anderson II',
  89         'event_id' => '41',
  90         'event_title' => 'Annual CiviCRM meet',
  91         'event_start_date' => '2013-07-29 00:00:00',
  92         'event_end_date' => '2013-08-04 00:00:00',
  93         'participant_id' => '3',
  94         'participant_fee_level' => '',
  95         'participant_fee_amount' => '',
  96         'participant_fee_currency' => '',
  97         'event_type' => 'Conference',
  98         'participant_status_id' => '2',
  99         'participant_status' => 'Attended',
 100         'participant_role_id' => '1',
 101         'participant_role' => 'Attendee',
 102         'participant_register_date' => '2007-02-19 00:00:00',
 103         'participant_source' => 'Wimbeldon',
 104         'participant_note' => '',
 105         'participant_is_pay_later' => 0,
 106         'participant_is_test' => 0,
 107         'participant_registered_by_id' => '',
 108         'participant_discount_name' => '',
 109         'participant_campaign_id' => '',
 110         'id' => '3',
 111         'api.participant.delete' => array(
 112           'is_error' => 0,
 113           'version' => 3,
 114           'count' => 1,
 115           'values' => 1,
 116         ),
 117       ),
 118     ),
 119   );
 120
 121   return $expectedResult;
 122 }
 123
 124 /*
 125 * This example has been generated from the API test suite.
 126 * The test that created it is called "testNestedDelete"
 127 * and can be found at:
 128 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php
 129 *
 130 * You can see the outcome of the API tests at
 131 * https://test.civicrm.org/job/CiviCRM-master-git/
 132 *
 133 * To Learn about the API read
 134 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 135 *
 136 * Browse the api on your own site with the api explorer
 137 * http://MYSITE.ORG/path/to/civicrm/api
 138 *
 139 * Read more about testing here
 140 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 141 *
 142 * API Standards documentation:
 143 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
 144 */