api/v3/examples/UFFieldGet.php

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