Merge remote-tracking branch 'upstream/4.3' into 4.3-4.4-2013-10-21-22-31-28
[civicrm-core.git] / api / v3 / examples / OptionValue / SortOption.php
index 49329e67252031d9a859832626c605480baffdf5..367e3ce6b0d29cc41f9da3eb219d1db3fc604d23 100644 (file)
@@ -1,29 +1,37 @@
 <?php
-
-/*
- demonstrates use of Sort param (available in many api functions). Also, getsingle
+/**
+ * Test Generated example of using option_value getsingle API
+ * demonstrates use of Sort param (available in many api functions). Also, getsingle *
  */
 function option_value_getsingle_example(){
-$params = array( 
+$params = array(
   'option_group_id' => 1,
-  'version' => 3,
-  'options' => array( 
+  'options' => array(
       'sort' => 'label DESC',
       'limit' => 1,
     ),
 );
 
-  $result = civicrm_api( 'option_value','getsingle',$params );
+try{
+  $result = civicrm_api3('option_value', 'getsingle', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function option_value_getsingle_expectedresult(){
 
-  $expectedResult = array( 
+  $expectedResult = array(
   'id' => '4',
   'option_group_id' => '1',
   'label' => 'SMS',
@@ -35,7 +43,7 @@ function option_value_getsingle_expectedresult(){
   'is_active' => '1',
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }