Short array syntax - auto-convert api dir
[civicrm-core.git] / api / v3 / examples / GroupNesting / Create.php
CommitLineData
6a488035 1<?php
50fb255d 2/**
a828d7b8 3 * Test Generated example demonstrating the GroupNesting.create API.
50fb255d 4 *
50fb255d 5 * @return array
6 * API result array
7 */
8function group_nesting_create_example() {
cf8f0fff 9 $params = [
50fb255d 10 'parent_group_id' => 1,
11 'child_group_id' => 3,
cf8f0fff 12 ];
6a488035 13
50fb255d 14 try{
a828d7b8 15 $result = civicrm_api3('GroupNesting', 'create', $params);
50fb255d 16 }
17 catch (CiviCRM_API3_Exception $e) {
18 // Handle error here.
19 $errorMessage = $e->getMessage();
20 $errorCode = $e->getErrorCode();
21 $errorData = $e->getExtraParams();
cf8f0fff 22 return [
5be22f39 23 'is_error' => 1,
24 'error_message' => $errorMessage,
50fb255d 25 'error_code' => $errorCode,
26 'error_data' => $errorData,
cf8f0fff 27 ];
50fb255d 28 }
29
30 return $result;
6a488035
TO
31}
32
fb32de45 33/**
50fb255d 34 * Function returns array of result expected from previous function.
35 *
36 * @return array
37 * API result array
6a488035 38 */
50fb255d 39function group_nesting_create_expectedresult() {
6a488035 40
cf8f0fff 41 $expectedResult = [
50fb255d 42 'is_error' => 0,
43 'version' => 3,
44 'count' => 1,
45 'id' => 'is_error',
cf8f0fff 46 'values' => [
6a488035 47 'is_error' => 0,
cf8f0fff
CW
48 ],
49 ];
6a488035 50
fb32de45 51 return $expectedResult;
6a488035
TO
52}
53
a828d7b8 54/*
50fb255d 55* This example has been generated from the API test suite.
a828d7b8
CW
56* The test that created it is called "testCreate"
57* and can be found at:
69d79249 58* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupNestingTest.php
6a488035
TO
59*
60* You can see the outcome of the API tests at
69d79249 61* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
62*
63* To Learn about the API read
69d79249 64* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 65*
69d79249 66* Browse the api on your own site with the api explorer
41d4d31f 67* http://MYSITE.ORG/path/to/civicrm/api
6a488035
TO
68*
69* Read more about testing here
70* http://wiki.civicrm.org/confluence/display/CRM/Testing
71*
72* API Standards documentation:
73* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 74*/