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