Merge pull request #14577 from mattwire/type_consolidation
[civicrm-core.git] / api / v3 / examples / GroupContact / Get.ex.php
CommitLineData
6a488035 1<?php
50fb255d 2/**
a828d7b8 3 * Test Generated example demonstrating the GroupContact.get API.
50fb255d 4 *
50fb255d 5 * @return array
6 * API result array
7 */
8function group_contact_get_example() {
cf8f0fff 9 $params = [
50fb255d 10 'contact_id' => 3,
cf8f0fff 11 ];
6a488035 12
50fb255d 13 try{
a828d7b8 14 $result = civicrm_api3('GroupContact', 'get', $params);
50fb255d 15 }
16 catch (CiviCRM_API3_Exception $e) {
17 // Handle error here.
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
cf8f0fff 21 return [
5be22f39 22 'is_error' => 1,
23 'error_message' => $errorMessage,
50fb255d 24 'error_code' => $errorCode,
25 'error_data' => $errorData,
cf8f0fff 26 ];
50fb255d 27 }
28
29 return $result;
6a488035
TO
30}
31
fb32de45 32/**
50fb255d 33 * Function returns array of result expected from previous function.
34 *
35 * @return array
36 * API result array
6a488035 37 */
50fb255d 38function group_contact_get_expectedresult() {
6a488035 39
cf8f0fff 40 $expectedResult = [
50fb255d 41 'is_error' => 0,
42 'version' => 3,
43 'count' => 1,
44 'id' => 1,
cf8f0fff
CW
45 'values' => [
46 '1' => [
50fb255d 47 'id' => '1',
48 'group_id' => '1',
49 'title' => 'New Test Group Created',
50 'visibility' => 'Public Pages',
51 'is_hidden' => 0,
52 'in_date' => '2013-07-28 08:50:19',
53 'in_method' => 'API',
cf8f0fff
CW
54 ],
55 ],
56 ];
6a488035 57
fb32de45 58 return $expectedResult;
6a488035
TO
59}
60
a828d7b8 61/*
50fb255d 62* This example has been generated from the API test suite.
a828d7b8
CW
63* The test that created it is called "testGet"
64* and can be found at:
69d79249 65* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
6a488035
TO
66*
67* You can see the outcome of the API tests at
8390b11b 68* https://test.civicrm.org/job/CiviCRM-Core-Matrix/
6a488035
TO
69*
70* To Learn about the API read
8390b11b 71* https://docs.civicrm.org/dev/en/latest/api/
6a488035 72*
8390b11b
SL
73* Browse the API on your own site with the API Explorer. It is in the main
74* CiviCRM menu, under: Support > Development > API Explorer.
6a488035
TO
75*
76* Read more about testing here
8390b11b 77* https://docs.civicrm.org/dev/en/latest/testing/
6a488035
TO
78*
79* API Standards documentation:
8390b11b 80* https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
b259a4ab 81*/