Merge pull request #3679 from yashodha/CRM-14951
[civicrm-core.git] / api / v3 / examples / MembershipType / Get.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using membership_type get API
4 * *
6a488035
TO
5 */
6function membership_type_get_example(){
53ca8fd7 7$params = array(
6a488035 8 'id' => 1,
6a488035
TO
9);
10
fb32de45 11try{
12 $result = civicrm_api3('membership_type', 'get', $params);
13}
14catch (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}
6a488035 21
fb32de45 22return $result;
6a488035
TO
23}
24
fb32de45 25/**
6a488035
TO
26 * Function returns array of result expected from previous function
27 */
28function membership_type_get_expectedresult(){
29
53ca8fd7 30 $expectedResult = array(
6a488035
TO
31 'is_error' => 0,
32 'version' => 3,
33 'count' => 1,
34 'id' => 1,
53ca8fd7 35 'values' => array(
36 '1' => array(
6a488035
TO
37 'id' => '1',
38 'domain_id' => '1',
39 'name' => 'General',
40 'member_of_contact_id' => '1',
41 'financial_type_id' => '1',
42 'minimum_fee' => '0.00',
43 'duration_unit' => 'year',
44 'duration_interval' => '1',
45 'period_type' => 'rolling',
46 'visibility' => '1',
47 'auto_renew' => 0,
48 'is_active' => '1',
49 ),
50 ),
51);
52
fb32de45 53 return $expectedResult;
6a488035
TO
54}
55
56
57/*
58* This example has been generated from the API test suite. The test that created it is called
59*
60* testGet and can be found in
69d79249 61* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTypeTest.php
6a488035
TO
62*
63* You can see the outcome of the API tests at
69d79249 64* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
65*
66* To Learn about the API read
69d79249 67* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 68*
69d79249
E
69* Browse the api on your own site with the api explorer
70* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
71*
72* Read more about testing here
73* http://wiki.civicrm.org/confluence/display/CRM/Testing
74*
75* API Standards documentation:
76* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 77*/