api/v3/examples/CustomGroupGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function custom_group_get_example(){
   7 $params = array(
   8   'version' => 3,
   9 );
  10
  11   $result = civicrm_api( 'custom_group','get',$params );
  12
  13   return $result;
  14 }
  15
  16 /*
  17  * Function returns array of result expected from previous function
  18  */
  19 function custom_group_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           'name' => 'test_group_1',
  30           'title' => 'Test_Group_1',
  31           'extends' => 'Individual',
  32           'style' => 'Inline',
  33           'collapse_display' => '1',
  34           'help_pre' => 'This is Pre Help For Test Group 1',
  35           'help_post' => 'This is Post Help For Test Group 1',
  36           'weight' => '2',
  37           'is_active' => '1',
  38           'table_name' => 'civicrm_value_test_group_1_1',
  39           'is_multiple' => 0,
  40           'collapse_adv_display' => 0,
  41         ),
  42     ),
  43 );
  44
  45   return $expectedResult  ;
  46 }
  47
  48
  49 /*
  50 * This example has been generated from the API test suite. The test that created it is called
  51 *
  52 * testGetCustomGroupSuccess and can be found in
  53 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/CustomGroupTest.php
  54 *
  55 * You can see the outcome of the API tests at
  56 * http://tests.dev.civicrm.org/trunk/results-api_v3
  57 *
  58 * To Learn about the API read
  59 * http://book.civicrm.org/developer/current/techniques/api/
  60 *
  61 * and review the wiki at
  62 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  63 *
  64 * Read more about testing here
  65 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  66 *
  67 * API Standards documentation:
  68 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  69 */