CRM-13072 Update examples
[civicrm-core.git] / api / v3 / examples / System / Flush.php
1 <?php
2 /**
3 * Test Generated example of using system flush API
4 * Flush all system caches *
5 */
6 function system_flush_example(){
7 $params = array();
8
9 try{
10 $result = civicrm_api3('system', 'flush', $params);
11 }
12 catch (CiviCRM_API3_Exception $e) {
13 // handle error here
14 $errorMessage = $e->getMessage();
15 $errorCode = $e->getErrorCode();
16 $errorData = $e->getExtraParams();
17 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
18 }
19
20 return $result;
21 }
22
23 /**
24 * Function returns array of result expected from previous function
25 */
26 function system_flush_expectedresult(){
27
28 $expectedResult = array(
29 'is_error' => 0,
30 'version' => 3,
31 'count' => 1,
32 'values' => 1,
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 * testFlush and can be found in
43 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SystemTest.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 */