3 * Test Generated example demonstrating the Contact.getcount API.
5 * This demonstrates use of the 'getCount' action.
6 * This param causes the count of the only function to be returned as an integer.
11 function contact_getcount_example() {
17 $result = civicrm_api3('Contact', 'getcount', $params);
19 catch (CiviCRM_API3_Exception
$e) {
21 $errorMessage = $e->getMessage();
22 $errorCode = $e->getErrorCode();
23 $errorData = $e->getExtraParams();
25 'error' => $errorMessage,
26 'error_code' => $errorCode,
27 'error_data' => $errorData,
35 * Function returns array of result expected from previous function.
40 function contact_getcount_expectedresult() {
44 return $expectedResult;
48 * This example has been generated from the API test suite.
49 * The test that created it is called "testContactGetFormatCountOnly"
50 * and can be found at:
51 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
53 * You can see the outcome of the API tests at
54 * https://test.civicrm.org/job/CiviCRM-master-git/
56 * To Learn about the API read
57 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
59 * Browse the api on your own site with the api explorer
60 * http://MYSITE.ORG/path/to/civicrm/api
62 * Read more about testing here
63 * http://wiki.civicrm.org/confluence/display/CRM/Testing
65 * API Standards documentation:
66 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards