api/v3/examples/OptionValue/SortOption.php

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