4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.3 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 domain functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Domain
35 * @copyright CiviCRM LLC (c) 2004-2013
36 * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
41 * Flush all system caches
43 * @param array $params input parameters
44 * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
45 * - session: bool, whether to reset the CiviCRM session data; defaul: FALSE
47 * @return boolean true if success, else false
50 * @example SystemFlush.php
53 function civicrm_api3_system_flush($params) {
54 CRM_Core_Invoke
::rebuildMenuAndCaches(
55 CRM_Utils_Array
::value('triggers', $params, FALSE),
56 CRM_Utils_Array
::value('session', $params, FALSE)
58 return civicrm_api3_create_success();
62 * Adjust Metadata for Flush action
64 * The metadata is used for setting defaults, documentation & validation
65 * @param array $params array or parameters determined by getfields
67 function _civicrm_api3_system_flush_spec(&$params){
68 $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
69 $params['session'] = array('title' => 'refresh sessions (boolean)');