Merge pull request #5182 from colemanw/Cleanup

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

<?php
/**
 * Test Generated example of using contact getactions API.
 *
 * Getting the available actions for an entity.
 *
 * @return array
 *   API result array
 */
function contact_getactions_example() {
  $params = array();

  try{
    $result = civicrm_api3('contact', 'getactions', $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_getactions_expectedresult() {

  $expectedResult = array(
    'is_error' => 0,
    'version' => 3,
    'count' => 18,
    'values' => array(
      '0' => 'create',
      '1' => 'delete',
      '2' => 'get',
      '3' => 'getactions',
      '4' => 'getcount',
      '5' => 'getfields',
      '6' => 'getlist',
      '7' => 'getoptions',
      '8' => 'getquick',
      '9' => 'getrefcount',
      '10' => 'getsingle',
      '11' => 'getstat',
      '12' => 'getvalue',
      '13' => 'merge',
      '14' => 'proximity',
      '15' => 'replace',
      '16' => 'setvalue',
      '17' => 'update',
    ),
    'deprecated' => array(
      'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
      'update' => 'The "update" action is deprecated. Use "create" with an id instead.',
    ),
  );

  return $expectedResult;
}

/**
* This example has been generated from the API test suite.
* The test that created it is called
* testGetActions
* 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
*/