crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/MembershipStatus/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MembershipStatus.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function membership_status_get_example() {
   9   $params = array(
  10     'name' => 'test status',
  11   );
  12
  13   try{
  14     $result = civicrm_api3('MembershipStatus', '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_status_get_expectedresult() {
  38
  39   $expectedResult = array(
  40     'is_error' => 0,
  41     'version' => 3,
  42     'count' => 1,
  43     'id' => 9,
  44     'values' => array(
  45       '9' => array(
  46         'id' => '9',
  47         'name' => 'test status',
  48         'label' => 'test status',
  49         'start_event' => 'start_date',
  50         'end_event' => 'end_date',
  51         'is_current_member' => '1',
  52         'is_admin' => 0,
  53         'is_default' => 0,
  54         'is_active' => '1',
  55         'is_reserved' => 0,
  56       ),
  57     ),
  58   );
  59
  60   return $expectedResult;
  61 }
  62
  63 /*
  64 * This example has been generated from the API test suite.
  65 * The test that created it is called "testGet"
  66 * and can be found at:
  67 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipStatusTest.php
  68 *
  69 * You can see the outcome of the API tests at
  70 * https://test.civicrm.org/job/CiviCRM-master-git/
  71 *
  72 * To Learn about the API read
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  74 *
  75 * Browse the api on your own site with the api explorer
  76 * http://MYSITE.ORG/path/to/civicrm/api
  77 *
  78 * Read more about testing here
  79 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  80 *
  81 * API Standards documentation:
  82 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  83 */