api/v3/examples/SettingGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function setting_get_example(){
   7 $params = array(
   8   'version' => 3,
   9   'domain_id' => 2,
  10   'return' => 'uniq_email_per_site',
  11 );
  12
  13   $result = civicrm_api( 'setting','get',$params );
  14
  15   return $result;
  16 }
  17
  18 /*
  19  * Function returns array of result expected from previous function
  20  */
  21 function setting_get_expectedresult(){
  22
  23   $expectedResult = array(
  24   'is_error' => 0,
  25   'version' => 3,
  26   'count' => 1,
  27   'id' => 2,
  28   'values' => array(
  29       '2' => array(
  30           'uniq_email_per_site' => '1',
  31         ),
  32     ),
  33 );
  34
  35   return $expectedResult  ;
  36 }
  37
  38
  39 /*
  40 * This example has been generated from the API test suite. The test that created it is called
  41 *
  42 * testGetSetting and can be found in
  43 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
  44 *
  45 * You can see the outcome of the API tests at
  46 * http://tests.dev.civicrm.org/trunk/results-api_v3
  47 *
  48 * To Learn about the API read
  49 * http://book.civicrm.org/developer/current/techniques/api/
  50 *
  51 * and review the wiki at
  52 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  53 *
  54 * Read more about testing here
  55 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  56 *
  57 * API Standards documentation:
  58 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  59 */