crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/UFField/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the UFField.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function uf_field_create_example() {
   9   $params = array(
  10     'field_name' => 'phone',
  11     'field_type' => 'Contact',
  12     'visibility' => 'Public Pages and Listings',
  13     'weight' => 1,
  14     'label' => 'Test Phone',
  15     'is_searchable' => 1,
  16     'is_active' => 1,
  17     'location_type_id' => 1,
  18     'phone_type_id' => 1,
  19     'uf_group_id' => 11,
  20   );
  21
  22   try{
  23     $result = civicrm_api3('UFField', 'create', $params);
  24   }
  25   catch (CiviCRM_API3_Exception $e) {
  26     // Handle error here.
  27     $errorMessage = $e->getMessage();
  28     $errorCode = $e->getErrorCode();
  29     $errorData = $e->getExtraParams();
  30     return array(
  31       'error' => $errorMessage,
  32       'error_code' => $errorCode,
  33       'error_data' => $errorData,
  34     );
  35   }
  36
  37   return $result;
  38 }
  39
  40 /**
  41  * Function returns array of result expected from previous function.
  42  *
  43  * @return array
  44  *   API result array
  45  */
  46 function uf_field_create_expectedresult() {
  47
  48   $expectedResult = array(
  49     'is_error' => 0,
  50     'version' => 3,
  51     'count' => 1,
  52     'id' => 1,
  53     'values' => array(
  54       '1' => array(
  55         'id' => '1',
  56         'uf_group_id' => '11',
  57         'field_name' => 'phone',
  58         'is_active' => '1',
  59         'is_view' => '',
  60         'is_required' => '',
  61         'weight' => '1',
  62         'help_post' => '',
  63         'help_pre' => '',
  64         'visibility' => 'Public Pages and Listings',
  65         'in_selector' => '',
  66         'is_searchable' => '1',
  67         'location_type_id' => '1',
  68         'phone_type_id' => '1',
  69         'website_type_id' => '',
  70         'label' => 'Test Phone',
  71         'field_type' => 'Contact',
  72         'is_reserved' => '',
  73         'is_multi_summary' => '',
  74       ),
  75     ),
  76   );
  77
  78   return $expectedResult;
  79 }
  80
  81 /*
  82 * This example has been generated from the API test suite.
  83 * The test that created it is called "testCreateUFField"
  84 * and can be found at:
  85 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFFieldTest.php
  86 *
  87 * You can see the outcome of the API tests at
  88 * https://test.civicrm.org/job/CiviCRM-master-git/
  89 *
  90 * To Learn about the API read
  91 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  92 *
  93 * Browse the api on your own site with the api explorer
  94 * http://MYSITE.ORG/path/to/civicrm/api
  95 *
  96 * Read more about testing here
  97 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  98 *
  99 * API Standards documentation:
 100 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
 101 */