102 lines
2.6 KiB
PHP
102 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* Test Generated example demonstrating the Event.getsingle API.
|
|
*
|
|
* Demonstrates use of return is_full .
|
|
*
|
|
* @return array
|
|
* API result array
|
|
*/
|
|
function event_getsingle_example() {
|
|
$params = array(
|
|
'id' => 1,
|
|
'return.is_full' => 1,
|
|
);
|
|
|
|
try{
|
|
$result = civicrm_api3('Event', 'getsingle', $params);
|
|
}
|
|
catch (CiviCRM_API3_Exception $e) {
|
|
// Handle error here.
|
|
$errorMessage = $e->getMessage();
|
|
$errorCode = $e->getErrorCode();
|
|
$errorData = $e->getExtraParams();
|
|
return array(
|
|
'is_error' => 1,
|
|
'error_message' => $errorMessage,
|
|
'error_code' => $errorCode,
|
|
'error_data' => $errorData,
|
|
);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Function returns array of result expected from previous function.
|
|
*
|
|
* @return array
|
|
* API result array
|
|
*/
|
|
function event_getsingle_expectedresult() {
|
|
|
|
$expectedResult = array(
|
|
'id' => '1',
|
|
'title' => 'Annual CiviCRM meet',
|
|
'event_title' => 'Annual CiviCRM meet',
|
|
'event_description' => '',
|
|
'event_type_id' => '1',
|
|
'participant_listing_id' => 0,
|
|
'is_public' => '1',
|
|
'start_date' => '2008-10-21 00:00:00',
|
|
'event_start_date' => '2008-10-21 00:00:00',
|
|
'event_end_date' => '',
|
|
'is_online_registration' => 0,
|
|
'max_participants' => '1',
|
|
'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,
|
|
'max_additional_participants' => 0,
|
|
'allow_same_participant_emails' => 0,
|
|
'allow_selfcancelxfer' => 0,
|
|
'selfcancelxfer_time' => 0,
|
|
'is_template' => 0,
|
|
'created_date' => '2017-02-07 02:22:22',
|
|
'is_share' => '1',
|
|
'is_confirm_enabled' => '1',
|
|
'is_billing_required' => 0,
|
|
'available_places' => 0,
|
|
'is_full' => '1',
|
|
);
|
|
|
|
return $expectedResult;
|
|
}
|
|
|
|
/*
|
|
* This example has been generated from the API test suite.
|
|
* The test that created it is called "testGetSingleReturnIsFull"
|
|
* and can be found at:
|
|
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
|
|
*
|
|
* You can see the outcome of the API tests at
|
|
* https://test.civicrm.org/job/CiviCRM-master-git/
|
|
*
|
|
* To Learn about the API read
|
|
* 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
|
|
*
|
|
* 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
|
|
*/
|