api/v3/examples/Contact/GetCountContact.php

   1 <?php
   2 /**
   3  * Test Generated example of using contact getcount API.
   4  *
   5  * This demonstrates use of the 'getCount' action.
   6  *
   7  * This param causes the count of the only function to be returned as an integer.
   8  *
   9  * @return array
  10  *   API result array
  11  */
  12 function contact_getcount_example() {
  13   $params = array(
  14     'id' => 17,
  15   );
  16
  17   try{
  18     $result = civicrm_api3('contact', 'getcount', $params);
  19   }
  20   catch (CiviCRM_API3_Exception $e) {
  21     // Handle error here.
  22     $errorMessage = $e->getMessage();
  23     $errorCode = $e->getErrorCode();
  24     $errorData = $e->getExtraParams();
  25     return array(
  26       'error' => $errorMessage,
  27       'error_code' => $errorCode,
  28       'error_data' => $errorData,
  29     );
  30   }
  31
  32   return $result;
  33 }
  34
  35 /**
  36  * Function returns array of result expected from previous function.
  37  *
  38  * @return array
  39  *   API result array
  40  */
  41 function contact_getcount_expectedresult() {
  42
  43   $expectedResult = 1;
  44
  45   return $expectedResult;
  46 }
  47
  48 /**
  49 * This example has been generated from the API test suite.
  50 * The test that created it is called
  51 * testContactGetFormatCount_only
  52 * and can be found in
  53 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  54 *
  55 * You can see the outcome of the API tests at
  56 * https://test.civicrm.org/job/CiviCRM-master-git/
  57 *
  58 * To Learn about the API read
  59 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  60 *
  61 * Browse the api on your own site with the api explorer
  62 * http://MYSITE.ORG/path/to/civicrm/api
  63 *
  64 * Read more about testing here
  65 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  66 *
  67 * API Standards documentation:
  68 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  69 */