api/v3/examples/UFFieldCreate.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function uf_field_create_example(){
   7 $params = array(
   8   'field_name' => 'phone',
   9   'field_type' => 'Contact',
  10   'visibility' => 'Public Pages and Listings',
  11   'weight' => 1,
  12   'label' => 'Test Phone',
  13   'is_searchable' => 1,
  14   'is_active' => 1,
  15   'location_type_id' => 1,
  16   'phone_type_id' => 1,
  17   'version' => 3,
  18   'uf_group_id' => 11,
  19 );
  20
  21   $result = civicrm_api( 'uf_field','create',$params );
  22
  23   return $result;
  24 }
  25
  26 /*
  27  * Function returns array of result expected from previous function
  28  */
  29 function uf_field_create_expectedresult(){
  30
  31   $expectedResult = array(
  32   'is_error' => 0,
  33   'version' => 3,
  34   'count' => 1,
  35   'id' => 1,
  36   'values' => array(
  37       '1' => array(
  38           'id' => '1',
  39           'uf_group_id' => '11',
  40           'field_name' => 'phone',
  41           'is_active' => '1',
  42           'is_view' => '',
  43           'is_required' => '',
  44           'weight' => '1',
  45           'help_post' => '',
  46           'help_pre' => '',
  47           'visibility' => 'Public Pages and Listings',
  48           'in_selector' => '',
  49           'is_searchable' => '1',
  50           'location_type_id' => '1',
  51           'phone_type_id' => '1',
  52           'label' => 'Test Phone',
  53           'field_type' => 'Contact',
  54           'is_reserved' => '',
  55           'is_multi_summary' => '',
  56         ),
  57     ),
  58 );
  59
  60   return $expectedResult  ;
  61 }
  62
  63
  64 /*
  65 * This example has been generated from the API test suite. The test that created it is called
  66 *
  67 * testCreateUFField and can be found in
  68 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/UFFieldTest.php
  69 *
  70 * You can see the outcome of the API tests at
  71 * http://tests.dev.civicrm.org/trunk/results-api_v3
  72 *
  73 * To Learn about the API read
  74 * http://book.civicrm.org/developer/current/techniques/api/
  75 *
  76 * and review the wiki at
  77 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  78 *
  79 * Read more about testing here
  80 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  81 *
  82 * API Standards documentation:
  83 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  84 */