api/v3/examples/System/Flush.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the System.flush API.
   4  *
   5  * Flush all system caches
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function system_flush_example() {
  11   $params = [];
  12
  13   try{
  14     $result = civicrm_api3('System', 'flush', $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 [
  22       'is_error' => 1,
  23       'error_message' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     ];
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function system_flush_expectedresult() {
  39
  40   $expectedResult = [
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'values' => 1,
  45   ];
  46
  47   return $expectedResult;
  48 }
  49
  50 /*
  51 * This example has been generated from the API test suite.
  52 * The test that created it is called "testFlush"
  53 * and can be found at:
  54 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SystemTest.php
  55 *
  56 * You can see the outcome of the API tests at
  57 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  58 *
  59 * To Learn about the API read
  60 * https://docs.civicrm.org/dev/en/latest/api/
  61 *
  62 * Browse the API on your own site with the API Explorer. It is in the main
  63 * CiviCRM menu, under: Support > Development > API Explorer.
  64 *
  65 * Read more about testing here
  66 * https://docs.civicrm.org/dev/en/latest/testing/
  67 *
  68 * API Standards documentation:
  69 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  70 */