Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Event.get API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function event_get_example() { | |
9 | $params = array( | |
10 | 'event_title' => 'Annual CiviCRM meet', | |
11 | 'sequential' => TRUE, | |
12 | ); | |
6a488035 | 13 | |
50fb255d | 14 | try{ |
a828d7b8 | 15 | $result = civicrm_api3('Event', 'get', $params); |
50fb255d | 16 | } |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // Handle error here. | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
22 | return array( | |
5be22f39 | 23 | 'is_error' => 1, |
24 | 'error_message' => $errorMessage, | |
50fb255d | 25 | 'error_code' => $errorCode, |
26 | 'error_data' => $errorData, | |
27 | ); | |
28 | } | |
29 | ||
30 | return $result; | |
6a488035 TO |
31 | } |
32 | ||
fb32de45 | 33 | /** |
50fb255d | 34 | * Function returns array of result expected from previous function. |
35 | * | |
36 | * @return array | |
37 | * API result array | |
6a488035 | 38 | */ |
50fb255d | 39 | function event_get_expectedresult() { |
6a488035 | 40 | |
53ca8fd7 | 41 | $expectedResult = array( |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'id' => 1, | |
46 | 'values' => array( | |
53ca8fd7 | 47 | '0' => array( |
50fb255d | 48 | 'id' => '1', |
49 | 'title' => 'Annual CiviCRM meet', | |
50 | 'event_title' => 'Annual CiviCRM meet', | |
5be22f39 | 51 | 'event_description' => '', |
50fb255d | 52 | 'event_type_id' => '1', |
53 | 'participant_listing_id' => 0, | |
54 | 'is_public' => '1', | |
55 | 'start_date' => '2013-07-29 00:00:00', | |
56 | 'event_start_date' => '2013-07-29 00:00:00', | |
5be22f39 | 57 | 'event_end_date' => '', |
50fb255d | 58 | 'is_online_registration' => 0, |
59 | 'is_monetary' => 0, | |
60 | 'is_map' => 0, | |
61 | 'is_active' => '1', | |
62 | 'is_show_location' => '1', | |
63 | 'default_role_id' => '1', | |
64 | 'is_email_confirm' => 0, | |
65 | 'is_pay_later' => 0, | |
66 | 'is_partial_payment' => 0, | |
67 | 'is_multiple_registrations' => 0, | |
5be22f39 | 68 | 'max_additional_participants' => 0, |
50fb255d | 69 | 'allow_same_participant_emails' => 0, |
5be22f39 | 70 | 'allow_selfcancelxfer' => 0, |
71 | 'selfcancelxfer_time' => 0, | |
50fb255d | 72 | 'is_template' => 0, |
73 | 'created_date' => '2013-07-28 08:49:19', | |
74 | 'is_share' => '1', | |
75 | 'is_confirm_enabled' => '1', | |
76 | 'is_billing_required' => 0, | |
77 | ), | |
6a488035 | 78 | ), |
50fb255d | 79 | ); |
6a488035 | 80 | |
fb32de45 | 81 | return $expectedResult; |
6a488035 TO |
82 | } |
83 | ||
a828d7b8 | 84 | /* |
50fb255d | 85 | * This example has been generated from the API test suite. |
a828d7b8 CW |
86 | * The test that created it is called "testGetEventByEventTitle" |
87 | * and can be found at: | |
69d79249 | 88 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php |
6a488035 TO |
89 | * |
90 | * You can see the outcome of the API tests at | |
69d79249 | 91 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
92 | * |
93 | * To Learn about the API read | |
69d79249 | 94 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 95 | * |
69d79249 | 96 | * Browse the api on your own site with the api explorer |
41d4d31f | 97 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
98 | * |
99 | * Read more about testing here | |
100 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
101 | * | |
102 | * API Standards documentation: | |
103 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 104 | */ |