infra updated incorrectly set public functions to private on payment classes
[civicrm-core.git] / api / v3 / examples / GroupContact / Get.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
50fb255d 3 * @file
4 * Test Generated API Example.
5 * See bottom of this file for more detail.
6a488035 6 */
6a488035 7
50fb255d 8/**
9 * Test Generated example of using group_contact get API.
10 *
11 *
12 * @return array
13 * API result array
14 */
15function group_contact_get_example() {
16 $params = array(
17 'contact_id' => 3,
18 );
6a488035 19
50fb255d 20 try{
21 $result = civicrm_api3('group_contact', 'get', $params);
22 }
23 catch (CiviCRM_API3_Exception $e) {
24 // Handle error here.
25 $errorMessage = $e->getMessage();
26 $errorCode = $e->getErrorCode();
27 $errorData = $e->getExtraParams();
28 return array(
29 'error' => $errorMessage,
30 'error_code' => $errorCode,
31 'error_data' => $errorData,
32 );
33 }
34
35 return $result;
6a488035
TO
36}
37
fb32de45 38/**
50fb255d 39 * Function returns array of result expected from previous function.
40 *
41 * @return array
42 * API result array
6a488035 43 */
50fb255d 44function group_contact_get_expectedresult() {
6a488035 45
53ca8fd7 46 $expectedResult = array(
50fb255d 47 'is_error' => 0,
48 'version' => 3,
49 'count' => 1,
50 'id' => 1,
51 'values' => array(
53ca8fd7 52 '1' => array(
50fb255d 53 'id' => '1',
54 'group_id' => '1',
55 'title' => 'New Test Group Created',
56 'visibility' => 'Public Pages',
57 'is_hidden' => 0,
58 'in_date' => '2013-07-28 08:50:19',
59 'in_method' => 'API',
60 ),
6a488035 61 ),
50fb255d 62 );
6a488035 63
fb32de45 64 return $expectedResult;
6a488035
TO
65}
66
50fb255d 67/**
68* This example has been generated from the API test suite.
69* The test that created it is called
70* testGet
71* and can be found in
69d79249 72* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
6a488035
TO
73*
74* You can see the outcome of the API tests at
69d79249 75* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
76*
77* To Learn about the API read
69d79249 78* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 79*
69d79249
E
80* Browse the api on your own site with the api explorer
81* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
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
b259a4ab 88*/