api/v3/examples/Event/IsCurrentOption.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  * demonstrates use of is.Current option
  12  *
  13  * @return array
  14  *   API result array
  15  */
  16 function event_get_example() {
  17   $params = array(
  18     'isCurrent' => 1,
  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' => 3,
  52     'values' => array(
  53       '3' => array(
  54         'id' => '3',
  55         'title' => 'Annual CiviCRM meet 2',
  56         'event_title' => 'Annual CiviCRM meet 2',
  57         'summary' => 'If you have any CiviCRM realted issues or want to track where CiviCRM is heading, Sign up now',
  58         'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
  59         'event_description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
  60         'event_type_id' => '1',
  61         'participant_listing_id' => 0,
  62         'is_public' => '1',
  63         'start_date' => '2013-07-29 00:00:00',
  64         'event_start_date' => '2013-07-29 00:00:00',
  65         'end_date' => '2013-08-04 00:00:00',
  66         'event_end_date' => '2013-08-04 00:00:00',
  67         'is_online_registration' => '1',
  68         'registration_start_date' => '2010-06-01 00:00:00',
  69         'registration_end_date' => '2010-10-15 00:00:00',
  70         'max_participants' => '100',
  71         'event_full_text' => 'Sorry! We are already full',
  72         'is_monetary' => 0,
  73         'is_map' => 0,
  74         'is_active' => '1',
  75         'is_show_location' => 0,
  76         'default_role_id' => '1',
  77         'is_email_confirm' => 0,
  78         'is_pay_later' => 0,
  79         'is_partial_payment' => 0,
  80         'is_multiple_registrations' => 0,
  81         'allow_same_participant_emails' => 0,
  82         'is_template' => 0,
  83         'created_date' => '2013-07-28 08:49:19',
  84         'is_share' => '1',
  85         'is_confirm_enabled' => '1',
  86         'is_billing_required' => 0,
  87       ),
  88     ),
  89   );
  90
  91   return $expectedResult;
  92 }
  93
  94 /**
  95 * This example has been generated from the API test suite.
  96 * The test that created it is called
  97 * testGetIsCurrent
  98 * and can be found in
  99 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
 100 *
 101 * You can see the outcome of the API tests at
 102 * https://test.civicrm.org/job/CiviCRM-master-git/
 103 *
 104 * To Learn about the API read
 105 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 106 *
 107 * Browse the api on your own site with the api explorer
 108 * http://MYSITE.ORG/path/to/civicrm/api/explorer
 109 *
 110 * Read more about testing here
 111 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 112 *
 113 * API Standards documentation:
 114 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
 115 */