Merge remote-tracking branch 'upstream/4.3' into 4.3-4.4-2013-10-28-14-52-15

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

<?php
/**
 * 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,
  'options' => array(
      'sort' => 'label DESC',
      'limit' => 1,
    ),
);

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;
}

/**
 * Function returns array of result expected from previous function
 */
function option_value_getsingle_expectedresult(){

  $expectedResult = array(
  'id' => '4',
  'option_group_id' => '1',
  'label' => 'SMS',
  'value' => '4',
  'filter' => 0,
  'weight' => '4',
  'is_optgroup' => 0,
  'is_reserved' => 0,
  'is_active' => '1',
);

  return $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
*
* You can see the outcome of the API tests at
* http://tests.dev.civicrm.org/trunk/results-api_v3
*
* To Learn about the API read
* http://book.civicrm.org/developer/current/techniques/api/
*
* and review the wiki at
* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
*
* 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
*/