crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/MailSettings/GetOptions.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MailSettings.getoptions API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mail_settings_getoptions_example() {
   9   $params = array(
  10     'field' => 'protocol',
  11   );
  12
  13   try{
  14     $result = civicrm_api3('MailSettings', 'getoptions', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return array(
  22       'error' => $errorMessage,
  23       'error_code' => $errorCode,
  24       'error_data' => $errorData,
  25     );
  26   }
  27
  28   return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function.
  33  *
  34  * @return array
  35  *   API result array
  36  */
  37 function mail_settings_getoptions_expectedresult() {
  38
  39   $expectedResult = array(
  40     'is_error' => 0,
  41     'version' => 3,
  42     'count' => 4,
  43     'values' => array(
  44       '1' => 'IMAP',
  45       '2' => 'Maildir',
  46       '3' => 'POP3',
  47       '4' => 'Localdir',
  48     ),
  49   );
  50
  51   return $expectedResult;
  52 }
  53
  54 /*
  55 * This example has been generated from the API test suite.
  56 * The test that created it is called "testmailProtocol"
  57 * and can be found at:
  58 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ConstantTest.php
  59 *
  60 * You can see the outcome of the API tests at
  61 * https://test.civicrm.org/job/CiviCRM-master-git/
  62 *
  63 * To Learn about the API read
  64 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  65 *
  66 * Browse the api on your own site with the api explorer
  67 * http://MYSITE.ORG/path/to/civicrm/api
  68 *
  69 * Read more about testing here
  70 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  71 *
  72 * API Standards documentation:
  73 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  74 */