api/v3/examples/Membership/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Membership.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function membership_get_example() {
   9   $params = array(
  10     'membership_type_id' => 23,
  11   );
  12
  13   try{
  14     $result = civicrm_api3('Membership', 'get', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return array(
  22       'is_error' => 1,
  23       'error_message' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function membership_get_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 1,
  45     'values' => array(
  46       '1' => array(
  47         'id' => '1',
  48         'contact_id' => '38',
  49         'membership_type_id' => '23',
  50         'join_date' => '2009-01-21',
  51         'start_date' => '2013-07-29 00:00:00',
  52         'end_date' => '2013-08-04 00:00:00',
  53         'source' => 'Payment',
  54         'status_id' => '19',
  55         'is_override' => '1',
  56         'is_test' => 0,
  57         'is_pay_later' => 0,
  58         'custom_1' => 'custom string',
  59         'membership_name' => 'General',
  60         'relationship_name' => 'Child of',
  61         'custom_1_1' => 'custom string',
  62       ),
  63     ),
  64   );
  65
  66   return $expectedResult;
  67 }
  68
  69 /*
  70 * This example has been generated from the API test suite.
  71 * The test that created it is called "testGetWithParamsMemberShipIdAndCustom"
  72 * and can be found at:
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-master-git/
  77 *
  78 * To Learn about the API read
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  80 *
  81 * Browse the api on your own site with the api explorer
  82 * http://MYSITE.ORG/path/to/civicrm/api
  83 *
  84 * Read more about testing here
  85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  86 *
  87 * API Standards documentation:
  88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  89 */