infra updated incorrectly set public functions to private on payment classes
[civicrm-core.git] / api / v3 / examples / Contact / Getoptions.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 contact getoptions API.
10 *
11 * Demonstrates retrieving options for a custom field
12 *
13 * @return array
14 * API result array
15 */
16function contact_getoptions_example() {
17 $params = array(
18 'field' => 'custom_1',
19 );
6a488035 20
50fb255d 21 try{
22 $result = civicrm_api3('contact', 'getoptions', $params);
23 }
24 catch (CiviCRM_API3_Exception $e) {
25 // Handle error here.
26 $errorMessage = $e->getMessage();
27 $errorCode = $e->getErrorCode();
28 $errorData = $e->getExtraParams();
29 return array(
30 'error' => $errorMessage,
31 'error_code' => $errorCode,
32 'error_data' => $errorData,
33 );
34 }
35
36 return $result;
6a488035
TO
37}
38
fb32de45 39/**
50fb255d 40 * Function returns array of result expected from previous function.
41 *
42 * @return array
43 * API result array
6a488035 44 */
50fb255d 45function contact_getoptions_expectedresult() {
6a488035 46
7a7cc10b 47 $expectedResult = array(
50fb255d 48 'is_error' => 0,
49 'version' => 3,
50 'count' => 2,
51 'values' => array(
6a488035
TO
52 '1' => 'Label1',
53 '2' => 'Label2',
54 ),
50fb255d 55 );
6a488035 56
fb32de45 57 return $expectedResult;
6a488035
TO
58}
59
50fb255d 60/**
61* This example has been generated from the API test suite.
62* The test that created it is called
63* testCustomFieldCreateWithOptionValues
64* and can be found in
69d79249 65* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
6a488035
TO
66*
67* You can see the outcome of the API tests at
69d79249 68* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
69*
70* To Learn about the API read
69d79249 71* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 72*
69d79249
E
73* Browse the api on your own site with the api explorer
74* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
75*
76* Read more about testing here
77* http://wiki.civicrm.org/confluence/display/CRM/Testing
78*
79* API Standards documentation:
80* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 81*/