projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 TO |
1 | <?php |
| 2 | ||
| 3 | /* | |
| 4 | This demonstrates use of the 'format.id_only' param. | |
| 5 | /* This param causes the id of the only entity to be returned as an integer. | |
| 6 | /* it will be ignored if there is not exactly 1 result | |
| 7 | */ | |
| 8 | function contact_get_example(){ | |
| 9 | $params = array( | |
| 10 | 'version' => 3, | |
| 11 | 'id' => 17, | |
| 12 | 'format.only_id' => 1, | |
| 13 | ); | |
| 14 | ||
| 15 | $result = civicrm_api( 'contact','get',$params ); | |
| 16 | ||
| 17 | return $result; | |
| 18 | } | |
| 19 | ||
| 20 | /* | |
| 21 | * Function returns array of result expected from previous function | |
| 22 | */ | |
| 23 | function contact_get_expectedresult(){ | |
| 24 | ||
| 25 | $expectedResult = 17; | |
| 26 | ||
| 27 | return $expectedResult ; | |
| 28 | } | |
| 29 | ||
| 30 | ||
| 31 | /* | |
| 32 | * This example has been generated from the API test suite. The test that created it is called | |
| 33 | * | |
| 34 | * testContactGetFormatID_only and can be found in | |
| 35 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php | |
| 36 | * | |
| 37 | * You can see the outcome of the API tests at | |
| 38 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
| 39 | * | |
| 40 | * To Learn about the API read | |
| 41 | * http://book.civicrm.org/developer/current/techniques/api/ | |
| 42 | * | |
| 43 | * and review the wiki at | |
| 44 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
| 45 | * | |
| 46 | * Read more about testing here | |
| 47 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
| 48 | * | |
| 49 | * API Standards documentation: | |
| 50 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
| 51 | */ |