api/v3/examples/Contact/GetCountContact.php

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