api/v3/examples/OptionValue/SortOption.php

   1 <?php
   2 /**
   3  * Test Generated example of using option_value getsingle API
   4  * demonstrates use of Sort param (available in many api functions). Also, getsingle *
   5  */
   6 function option_value_getsingle_example(){
   7 $params = array(
   8   'option_group_id' => 1,
   9   'options' => array(
  10       'sort' => 'label DESC',
  11       'limit' => 1,
  12     ),
  13 );
  14
  15 try{
  16   $result = civicrm_api3('option_value', 'getsingle', $params);
  17 }
  18 catch (CiviCRM_API3_Exception $e) {
  19   // handle error here
  20   $errorMessage = $e->getMessage();
  21   $errorCode = $e->getErrorCode();
  22   $errorData = $e->getExtraParams();
  23   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  24 }
  25
  26 return $result;
  27 }
  28
  29 /**
  30  * Function returns array of result expected from previous function
  31  */
  32 function option_value_getsingle_expectedresult(){
  33
  34   $expectedResult = array(
  35   'id' => '4',
  36   'option_group_id' => '1',
  37   'label' => 'SMS',
  38   'value' => '4',
  39   'filter' => 0,
  40   'weight' => '4',
  41   'is_optgroup' => 0,
  42   'is_reserved' => 0,
  43   'is_active' => '1',
  44 );
  45
  46   return $expectedResult;
  47 }
  48
  49
  50 /*
  51 * This example has been generated from the API test suite. The test that created it is called
  52 *
  53 * testGetSingleValueOptionValueSort and can be found in
  54 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php
  55 *
  56 * You can see the outcome of the API tests at
  57 * https://test.civicrm.org/job/CiviCRM-master-git/
  58 *
  59 * To Learn about the API read
  60 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  61 *
  62 * Browse the api on your own site with the api explorer
  63 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  64 *
  65 * Read more about testing here
  66 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  67 *
  68 * API Standards documentation:
  69 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  70 */