CRM-13072 more test class upgrades
[civicrm-core.git] / api / v3 / examples / Contact / CustomFieldGet.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using contact get API
4 * /*this demonstrates setting a custom field through the API *
6a488035
TO
5 */
6function contact_get_example(){
edb0d67a 7$params = array(
fb32de45 8 'return.custom_1' => 1,
9 'id' => 1,
6a488035
TO
10);
11
fb32de45 12try{
13 $result = civicrm_api3('contact', 'get', $params);
14}
15catch (CiviCRM_API3_Exception $e) {
16 // handle error here
17 $errorMessage = $e->getMessage();
18 $errorCode = $e->getErrorCode();
19 $errorData = $e->getExtraParams();
20 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
21}
6a488035 22
fb32de45 23return $result;
6a488035
TO
24}
25
fb32de45 26/**
6a488035
TO
27 * Function returns array of result expected from previous function
28 */
29function contact_get_expectedresult(){
30
edb0d67a 31 $expectedResult = array(
6a488035
TO
32 'is_error' => 0,
33 'version' => 3,
34 'count' => 1,
35 'id' => 1,
edb0d67a 36 'values' => array(
37 '1' => array(
6a488035 38 'contact_id' => '1',
fb32de45 39 'civicrm_value_testgetwithcu_1_id' => '1',
40 'custom_1' => 'custom string',
6a488035
TO
41 'id' => '1',
42 ),
43 ),
44);
45
fb32de45 46 return $expectedResult;
6a488035
TO
47}
48
49
50/*
51* This example has been generated from the API test suite. The test that created it is called
52*
53* testGetWithCustom and can be found in
54* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
55*
56* You can see the outcome of the API tests at
57* http://tests.dev.civicrm.org/trunk/results-api_v3
58*
59* To Learn about the API read
60* http://book.civicrm.org/developer/current/techniques/api/
61*
62* and review the wiki at
63* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
64*
65* Read more about testing here
66* http://wiki.civicrm.org/confluence/display/CRM/Testing
67*
68* API Standards documentation:
69* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
70*/