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