updated examples
[civicrm-core.git] / api / v3 / examples / GroupNesting / Delete.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using group_nesting delete API
4 * *
6a488035
TO
5 */
6function group_nesting_delete_example(){
53ca8fd7 7$params = array(
6a488035
TO
8 'id' => 1,
9);
10
fb32de45 11try{
12 $result = civicrm_api3('group_nesting', 'delete', $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 group_nesting_delete_expectedresult(){
29
53ca8fd7 30 $expectedResult = array(
6a488035
TO
31 'is_error' => 0,
32 'version' => 3,
33 'count' => 1,
34 'values' => 1,
35);
36
fb32de45 37 return $expectedResult;
6a488035
TO
38}
39
40
41/*
42* This example has been generated from the API test suite. The test that created it is called
43*
44* testDelete and can be found in
69d79249 45* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupNestingTest.php
6a488035
TO
46*
47* You can see the outcome of the API tests at
69d79249 48* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
49*
50* To Learn about the API read
69d79249 51* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 52*
69d79249
E
53* Browse the api on your own site with the api explorer
54* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
55*
56* Read more about testing here
57* http://wiki.civicrm.org/confluence/display/CRM/Testing
58*
59* API Standards documentation:
60* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 61*/