3 * Test Generated example demonstrating the Event.get API.
5 * Demonstrates use of is.Current option.
10 function event_get_example() {
16 $result = civicrm_api3('Event', 'get', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
25 'error_message' => $errorMessage,
26 'error_code' => $errorCode,
27 'error_data' => $errorData,
35 * Function returns array of result expected from previous function.
40 function event_get_expectedresult() {
42 $expectedResult = array(
50 'title' => 'Annual CiviCRM meet 2',
51 'event_title' => 'Annual CiviCRM meet 2',
52 'summary' => 'If you have any CiviCRM realted issues or want to track where CiviCRM is heading, Sign up now',
53 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
54 'event_description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
55 'event_type_id' => '1',
56 'participant_listing_id' => 0,
58 'start_date' => '2013-07-29 00:00:00',
59 'event_start_date' => '2013-07-29 00:00:00',
60 'end_date' => '2013-08-04 00:00:00',
61 'event_end_date' => '2013-08-04 00:00:00',
62 'is_online_registration' => '1',
63 'registration_start_date' => '2010-06-01 00:00:00',
64 'registration_end_date' => '2010-10-15 00:00:00',
65 'max_participants' => '100',
66 'event_full_text' => 'Sorry! We are already full',
70 'is_show_location' => 0,
71 'default_role_id' => '1',
72 'is_email_confirm' => 0,
74 'is_partial_payment' => 0,
75 'is_multiple_registrations' => 0,
76 'max_additional_participants' => 0,
77 'allow_same_participant_emails' => 0,
78 'allow_selfcancelxfer' => 0,
79 'selfcancelxfer_time' => 0,
81 'created_date' => '2013-07-28 08:49:19',
83 'is_confirm_enabled' => '1',
84 'is_billing_required' => 0,
89 return $expectedResult;
93 * This example has been generated from the API test suite.
94 * The test that created it is called "testGetIsCurrent"
95 * and can be found at:
96 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
98 * You can see the outcome of the API tests at
99 * https://test.civicrm.org/job/CiviCRM-master-git/
101 * To Learn about the API read
102 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
104 * Browse the api on your own site with the api explorer
105 * http://MYSITE.ORG/path/to/civicrm/api
107 * Read more about testing here
108 * http://wiki.civicrm.org/confluence/display/CRM/Testing
110 * API Standards documentation:
111 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards