api/v3/examples/MembershipGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function membership_get_example(){
   7 $params = array(
   8   'version' => 3,
   9   'membership_type_id' => 8,
  10 );
  11
  12   $result = civicrm_api( 'membership','get',$params );
  13
  14   return $result;
  15 }
  16
  17 /*
  18  * Function returns array of result expected from previous function
  19  */
  20 function membership_get_expectedresult(){
  21
  22   $expectedResult = array(
  23   'is_error' => 0,
  24   'version' => 3,
  25   'count' => 1,
  26   'id' => 1,
  27   'values' => array(
  28       '1' => array(
  29           'id' => '1',
  30           'contact_id' => '10',
  31           'membership_type_id' => '8',
  32           'join_date' => '2009-01-21',
  33           'start_date' => '2009-01-21',
  34           'end_date' => '2009-12-21',
  35           'source' => 'Payment',
  36           'status_id' => '15',
  37           'is_override' => '1',
  38           'is_test' => 0,
  39           'is_pay_later' => 0,
  40           'membership_name' => 'General',
  41           'relationship_name' => 'Child of',
  42           'custom_1' => 'custom string',
  43           'custom_1_1' => 'custom string',
  44         ),
  45     ),
  46 );
  47
  48   return $expectedResult  ;
  49 }
  50
  51
  52 /*
  53 * This example has been generated from the API test suite. The test that created it is called
  54 *
  55 * testGetWithParamsMemberShipIdAndCustom and can be found in
  56 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MembershipTest.php
  57 *
  58 * You can see the outcome of the API tests at
  59 * http://tests.dev.civicrm.org/trunk/results-api_v3
  60 *
  61 * To Learn about the API read
  62 * http://book.civicrm.org/developer/current/techniques/api/
  63 *
  64 * and review the wiki at
  65 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  66 *
  67 * Read more about testing here
  68 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  69 *
  70 * API Standards documentation:
  71 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  72 */