updated examples

[civicrm-core.git] / api / v3 / examples / OptionValue / SortOption.php

diff --git a/api/v3/examples/OptionValue/SortOption.php b/api/v3/examples/OptionValue/SortOption.php
index 600344324312c6f4315a5f0394ad698e3836b1d8..49fb663faa420fa425151d99e8ba5d2e27bd580b 100644 (file)
--- a/api/v3/examples/OptionValue/SortOption.php
+++ b/api/v3/examples/OptionValue/SortOption.php
@@ -1,24 +1,32 @@
 <?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(
   'option_group_id' => 1,
-  'version' => 3,
   '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(){
@@ -35,7 +43,7 @@ function option_value_getsingle_expectedresult(){
   'is_active' => '1',
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -43,20 +51,20 @@ function option_value_getsingle_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetSingleValueOptionValueSort and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/OptionValueTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php
 *
 * You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api/explorer
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/