Merge pull request #2704 from jitendrapurohit/CRM_TestFix
[civicrm-core.git] / api / v3 / examples / Relationship / Get.php
... / ...
CommitLineData
1<?php
2/**
3 * Test Generated example of using relationship get API
4 * *
5 */
6function relationship_get_example(){
7$params = array(
8 'id' => 1,
9);
10
11try{
12 $result = civicrm_api3('relationship', '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}
21
22return $result;
23}
24
25/**
26 * Function returns array of result expected from previous function
27 */
28function relationship_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_a' => '47',
39 'contact_id_b' => '49',
40 'relationship_type_id' => '22',
41 'start_date' => '2013-07-29 00:00:00',
42 'is_active' => '1',
43 'description' => '',
44 'is_permission_a_b' => 0,
45 'is_permission_b_a' => 0,
46 'custom_1' => 'custom string',
47 'custom_1_1' => 'custom string',
48 ),
49 ),
50);
51
52 return $expectedResult;
53}
54
55
56/*
57* This example has been generated from the API test suite. The test that created it is called
58*
59* testGetWithCustom and can be found in
60* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
61*
62* You can see the outcome of the API tests at
63* https://test.civicrm.org/job/CiviCRM-master-git/
64*
65* To Learn about the API read
66* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
67*
68* Browse the api on your own site with the api explorer
69* http://MYSITE.ORG/path/to/civicrm/api/explorer
70*
71* Read more about testing here
72* http://wiki.civicrm.org/confluence/display/CRM/Testing
73*
74* API Standards documentation:
75* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
76*/