3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM system functionality.
31 * Includes caching, logging, and checking system functionality.
33 * @package CiviCRM_APIv3
37 * Flush all system caches.
39 * @param array $params
41 * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
42 * - session: bool, whether to reset the CiviCRM session data; default: FALSE
46 function civicrm_api3_system_flush($params) {
47 CRM_Core_Invoke
::rebuildMenuAndCaches(
48 CRM_Utils_Array
::value('triggers', $params, FALSE),
49 CRM_Utils_Array
::value('session', $params, FALSE)
51 return civicrm_api3_create_success();
55 * Adjust Metadata for Flush action.
57 * The metadata is used for setting defaults, documentation & validation.
59 * @param array $params
60 * Array of parameters determined by getfields.
62 function _civicrm_api3_system_flush_spec(&$params) {
63 $params['triggers'] = array(
64 'title' => 'Triggers',
65 'description' => 'rebuild triggers (boolean)',
66 'type' => CRM_Utils_Type
::T_BOOLEAN
,
68 $params['session'] = array(
69 'title' => 'Sessions',
70 'description' => 'refresh sessions (boolean)',
71 'type' => CRM_Utils_Type
::T_BOOLEAN
,
76 * System.Check API specification (optional).
78 * This is used for documentation and validation.
81 * Description of fields supported by this API call.
83 * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
85 function _civicrm_api3_system_check_spec(&$spec) {
86 // $spec['magicword']['api.required'] = 1;
92 * @param array $params
95 * API result descriptor; return items are alert codes/messages
96 * @see civicrm_api3_create_success
97 * @see civicrm_api3_create_error
98 * @throws API_Exception
100 function civicrm_api3_system_check($params) {
101 $returnValues = array();
102 foreach (CRM_Utils_Check
::singleton()->checkAll() as $message) {
103 $returnValues[] = $message->toArray();
106 // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
107 return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
111 * Log entry to system log table.
113 * @param array $params
117 function civicrm_api3_system_log($params) {
118 $log = new CRM_Utils_SystemLogger();
119 // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
120 // because I felt like not doing this required a bunch of explanation in the spec function - but perhaps other won't see it as helpful?
121 if (!isset($params['context'])) {
122 $params['context'] = array();
124 $specialFields = array('contact_id', 'hostname');
125 foreach ($specialFields as $specialField) {
126 if (isset($params[$specialField]) && !isset($params['context'])) {
127 $params['context'][$specialField] = $params[$specialField];
130 $returnValues = $log->log($params['level'], $params['message'], $params['context']);
131 return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
135 * Metadata for log function.
137 * @param array $params
139 function _civicrm_api3_system_log_spec(&$params) {
140 $params['level'] = array(
141 'title' => 'Log Level',
142 'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
143 'type' => CRM_Utils_Type
::T_STRING
,
144 'api.required' => TRUE,
146 $params['message'] = array(
147 'title' => 'Log Message',
148 'description' => 'Standardised message string, you can also ',
149 'type' => CRM_Utils_Type
::T_STRING
,
150 'api.required' => TRUE,
152 $params['context'] = array(
153 'title' => 'Log Context',
154 'description' => 'An array of additional data to store.',
155 'type' => CRM_Utils_Type
::T_LONGTEXT
,
156 'api.default' => array(),
158 $params['contact_id'] = array(
159 'title' => 'Log Contact ID',
160 'description' => 'Optional ID of relevant contact',
161 'type' => CRM_Utils_Type
::T_INT
,
163 $params['hostname'] = array(
164 'title' => 'Log Hostname',
165 'description' => 'Optional name of host',
166 'type' => CRM_Utils_Type
::T_STRING
,
173 * @param array $params
177 function civicrm_api3_system_get($params) {
178 $returnValues = array(
180 'version' => CRM_Utils_System
::version(),
184 return civicrm_api3_create_success($returnValues, $params, 'System', 'get');