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