api/v3/System.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  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.   |
  14  |                                                                    |
  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.        |
  19  |                                                                    |
  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  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 domain functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Domain
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * Flush all system caches
  42  *
  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
  46  *
  47  * @return boolean        true if success, else false
  48  * @static void
  49  * @access public
  50  * @example SystemFlush.php
  51  *
  52  */
  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)
  57   );
  58   return civicrm_api3_create_success();
  59 }
  60
  61 /**
  62  * Adjust Metadata for Flush action
  63  *
  64  * The metadata is used for setting defaults, documentation & validation
  65  * @param array $params array or parameters determined by getfields
  66  */
  67 function _civicrm_api3_system_flush_spec(&$params){
  68   $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
  69   $params['session'] = array('title' => 'refresh sessions (boolean)');
  70 }
  71
  72 /**
  73  * System.Check API specification (optional)
  74  * This is used for documentation and validation.
  75  *
  76  * @param array $spec description of fields supported by this API call
  77  * @return void
  78  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  79  */
  80 function _civicrm_api3_system_check_spec(&$spec) {
  81   // $spec['magicword']['api.required'] = 1;
  82 }
  83
  84 /**
  85  * System.Check API
  86  *
  87  * @param array $params
  88  * @return array API result descriptor; return items are alert codes/messages
  89  * @see civicrm_api3_create_success
  90  * @see civicrm_api3_create_error
  91  * @throws API_Exception
  92  */
  93 function civicrm_api3_system_check($params) {
  94   $returnValues = array();
  95   foreach (CRM_Utils_Check_Security::singleton()->checkAll() as $message) {
  96     $returnValues[] = $message->toArray();
  97   }
  98
  99   // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
 100   return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
 101 }