api/v3/examples/UFField/Delete.php

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