api/v3/examples/Membership/Get.php

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