api/v3/examples/OptionGroupGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function option_group_get_example(){
   7 $params = array(
   8   'name' => 'preferred_communication_method',
   9   'version' => 3,
  10   'debug' => 0,
  11 );
  12
  13   $result = civicrm_api( 'option_group','get',$params );
  14
  15   return $result;
  16 }
  17
  18 /*
  19  * Function returns array of result expected from previous function
  20  */
  21 function option_group_get_expectedresult(){
  22
  23   $expectedResult = array(
  24   'is_error' => 0,
  25   'version' => 3,
  26   'count' => 1,
  27   'id' => 1,
  28   'values' => array(
  29       '1' => array(
  30           'id' => '1',
  31           'name' => 'preferred_communication_method',
  32           'title' => 'Preferred Communication Method',
  33           'is_reserved' => '1',
  34           'is_active' => '1',
  35         ),
  36     ),
  37 );
  38
  39   return $expectedResult  ;
  40 }
  41
  42
  43 /*
  44 * This example has been generated from the API test suite. The test that created it is called
  45 *
  46 * testGetOptionGroupByName and can be found in
  47 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/OptionGroupTest.php
  48 *
  49 * You can see the outcome of the API tests at
  50 * http://tests.dev.civicrm.org/trunk/results-api_v3
  51 *
  52 * To Learn about the API read
  53 * http://book.civicrm.org/developer/current/techniques/api/
  54 *
  55 * and review the wiki at
  56 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  57 *
  58 * Read more about testing here
  59 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  60 *
  61 * API Standards documentation:
  62 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  63 */