Merge pull request #519 from colbyw/fixBootstrap
[civicrm-core.git] / api / v3 / examples / ContactGetoptions.php
1 <?php
2
3 /*
4 Demonstrates retrieving options for a custom field
5 */
6 function contact_getoptions_example(){
7 $params = array(
8 'field' => 'custom_1',
9 'version' => 3,
10 );
11
12 $result = civicrm_api( 'contact','getoptions',$params );
13
14 return $result;
15 }
16
17 /*
18 * Function returns array of result expected from previous function
19 */
20 function contact_getoptions_expectedresult(){
21
22 $expectedResult = array(
23 'is_error' => 0,
24 'version' => 3,
25 'count' => 2,
26 'values' => array(
27 '1' => 'Label1',
28 '2' => 'Label2',
29 ),
30 );
31
32 return $expectedResult ;
33 }
34
35
36 /*
37 * This example has been generated from the API test suite. The test that created it is called
38 *
39 * testCustomFieldCreateWithOptionValues and can be found in
40 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
41 *
42 * You can see the outcome of the API tests at
43 * http://tests.dev.civicrm.org/trunk/results-api_v3
44 *
45 * To Learn about the API read
46 * http://book.civicrm.org/developer/current/techniques/api/
47 *
48 * and review the wiki at
49 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
50 *
51 * Read more about testing here
52 * http://wiki.civicrm.org/confluence/display/CRM/Testing
53 *
54 * API Standards documentation:
55 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
56 */