<?php
/**
- * Test Generated example of using event get API
- * *
+ * Test Generated example of using event get API.
+ *
+ * @return array
+ * API result array
*/
-function event_get_example(){
-$params = array(
- 'event_title' => 'Annual CiviCRM meet',
- 'sequential' => true,
-);
+function event_get_example() {
+ $params = array(
+ 'event_title' => 'Annual CiviCRM meet',
+ 'sequential' => TRUE,
+ );
-try{
- $result = civicrm_api3('event', '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);
-}
+ try{
+ $result = civicrm_api3('event', '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 returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
*/
-function event_get_expectedresult(){
+function event_get_expectedresult() {
$expectedResult = array(
- 'is_error' => 0,
- 'version' => 3,
- 'count' => 1,
- 'id' => 1,
- 'values' => array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
'0' => array(
- 'id' => '1',
- 'title' => 'Annual CiviCRM meet',
- 'event_title' => 'Annual CiviCRM meet',
- 'event_type_id' => '1',
- 'participant_listing_id' => 0,
- 'is_public' => '1',
- 'start_date' => '2013-07-29 00:00:00',
- 'event_start_date' => '2013-07-29 00:00:00',
- 'is_online_registration' => 0,
- 'is_monetary' => 0,
- 'is_map' => 0,
- 'is_active' => '1',
- 'is_show_location' => '1',
- 'default_role_id' => '1',
- 'is_email_confirm' => 0,
- 'is_pay_later' => 0,
- 'is_partial_payment' => 0,
- 'is_multiple_registrations' => 0,
- 'allow_same_participant_emails' => 0,
- 'is_template' => 0,
- 'created_date' => '2013-07-28 08:49:19',
- 'is_share' => '1',
- 'is_confirm_enabled' => '1',
- ),
+ 'id' => '1',
+ 'title' => 'Annual CiviCRM meet',
+ 'event_title' => 'Annual CiviCRM meet',
+ 'event_type_id' => '1',
+ 'participant_listing_id' => 0,
+ 'is_public' => '1',
+ 'start_date' => '2013-07-29 00:00:00',
+ 'event_start_date' => '2013-07-29 00:00:00',
+ 'is_online_registration' => 0,
+ 'is_monetary' => 0,
+ 'is_map' => 0,
+ 'is_active' => '1',
+ 'is_show_location' => '1',
+ 'default_role_id' => '1',
+ 'is_email_confirm' => 0,
+ 'is_pay_later' => 0,
+ 'is_partial_payment' => 0,
+ 'is_multiple_registrations' => 0,
+ 'allow_same_participant_emails' => 0,
+ 'is_template' => 0,
+ 'created_date' => '2013-07-28 08:49:19',
+ 'is_share' => '1',
+ 'is_confirm_enabled' => '1',
+ 'is_billing_required' => 0,
+ ),
),
-);
+ );
return $expectedResult;
}
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetEventByEventTitle and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testGetEventByEventTitle
+* and can be found in
* 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://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
-* http://MYSITE.ORG/path/to/civicrm/api/explorer
+* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing