api/v3/examples/Event/Get.php

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