Merge pull request #5174 from joannechester/patch-2

[civicrm-core.git] / api / v3 / examples / Contact / GetCountContact.php

<?php
/**
 * Test Generated example of using contact getcount API.
 *
 * This demonstrates use of the 'getCount' action.
 * This param causes the count of the only function to be returned as an integer.
 *
 * @return array
 *   API result array
 */
function contact_getcount_example() {
  $params = array(
    'id' => 17,
  );

  try{
    $result = civicrm_api3('contact', 'getcount', $params);
  }
  catch (CiviCRM_API3_Exception $e) {
    // Handle error here.
    $errorMessage = $e->getMessage();
    $errorCode = $e->getErrorCode();
    $errorData = $e->getExtraParams();
    return array(
      'error' => $errorMessage,
      'error_code' => $errorCode,
      'error_data' => $errorData,
    );
  }

  return $result;
}

/**
 * Function returns array of result expected from previous function.
 *
 * @return array
 *   API result array
 */
function contact_getcount_expectedresult() {

  $expectedResult = 1;

  return $expectedResult;
}

/**
* This example has been generated from the API test suite.
* The test that created it is called
* testContactGetFormatCountOnly
* and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
*
* You can see the outcome of the API tests at
* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/