api/v3/examples/Contact/GetActions.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Contact.getactions API.
   4  *
   5  * Getting the available actions for an entity.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function contact_getactions_example() {
  11   $params = array();
  12
  13   try{
  14     $result = civicrm_api3('Contact', 'getactions', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return array(
  22       'error' => $errorMessage,
  23       'error_code' => $errorCode,
  24       'error_data' => $errorData,
  25     );
  26   }
  27
  28   return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function.
  33  *
  34  * @return array
  35  *   API result array
  36  */
  37 function contact_getactions_expectedresult() {
  38
  39   $expectedResult = array(
  40     'is_error' => 0,
  41     'version' => 3,
  42     'count' => 23,
  43     'values' => array(
  44       '0' => 'create',
  45       '1' => 'delete',
  46       '2' => 'example_action1',
  47       '3' => 'example_action2',
  48       '4' => 'get',
  49       '5' => 'getactions',
  50       '6' => 'getcount',
  51       '7' => 'getfields',
  52       '8' => 'getlist',
  53       '9' => 'getoptions',
  54       '10' => 'getquick',
  55       '11' => 'getrefcount',
  56       '12' => 'getsingle',
  57       '13' => 'getstat',
  58       '14' => 'getvalue',
  59       '15' => 'merge',
  60       '16' => 'proximity',
  61       '17' => 'replace',
  62       '18' => 'setvalue',
  63       '19' => 'type_create',
  64       '20' => 'type_delete',
  65       '21' => 'type_get',
  66       '22' => 'update',
  67     ),
  68     'deprecated' => array(
  69       'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
  70       'setvalue' => 'The "setvalue" action is deprecated. Use "create" with an id instead.',
  71       'update' => 'The "update" action is deprecated. Use "create" with an id instead.',
  72     ),
  73   );
  74
  75   return $expectedResult;
  76 }
  77
  78 /*
  79 * This example has been generated from the API test suite.
  80 * The test that created it is called "testGetActions"
  81 * and can be found at:
  82 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  83 *
  84 * You can see the outcome of the API tests at
  85 * https://test.civicrm.org/job/CiviCRM-master-git/
  86 *
  87 * To Learn about the API read
  88 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  89 *
  90 * Browse the api on your own site with the api explorer
  91 * http://MYSITE.ORG/path/to/civicrm/api
  92 *
  93 * Read more about testing here
  94 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  95 *
  96 * API Standards documentation:
  97 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  98 */