api/v3/examples/System/Flush.php

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