api/v3/examples/OptionValue/SortOption.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the OptionValue.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 = [
  12     'option_group_id' => 1,
  13     'options' => [
  14       'sort' => 'label DESC',
  15       'limit' => 1,
  16     ],
  17   ];
  18
  19   try{
  20     $result = civicrm_api3('OptionValue', '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 [
  28       'is_error' => 1,
  29       'error_message' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     ];
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function option_value_getsingle_expectedresult() {
  45
  46   $expectedResult = [
  47     'id' => '4',
  48     'option_group_id' => '1',
  49     'label' => 'SMS',
  50     'value' => '4',
  51     'name' => 'SMS',
  52     'filter' => 0,
  53     'weight' => '4',
  54     'is_optgroup' => 0,
  55     'is_reserved' => 0,
  56     'is_active' => '1',
  57   ];
  58
  59   return $expectedResult;
  60 }
  61
  62 /*
  63 * This example has been generated from the API test suite.
  64 * The test that created it is called "testGetSingleValueOptionValueSort"
  65 * and can be found at:
  66 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php
  67 *
  68 * You can see the outcome of the API tests at
  69 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  70 *
  71 * To Learn about the API read
  72 * https://docs.civicrm.org/dev/en/latest/api/
  73 *
  74 * Browse the API on your own site with the API Explorer. It is in the main
  75 * CiviCRM menu, under: Support > Development > API Explorer.
  76 *
  77 * Read more about testing here
  78 * https://docs.civicrm.org/dev/en/latest/testing/
  79 *
  80 * API Standards documentation:
  81 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  82 */