api/v3/examples/Event/Get.php

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