projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
CRM-15934: more host patterns
[civicrm-core.git]
/
api
/
v3
/
System.php
diff --git
a/api/v3/System.php
b/api/v3/System.php
index 6c0f33425067df7afe756f257207e2127b85d5c5..661e0caf340577e12f4fec501bfd8fe53a54f46a 100644
(file)
--- a/
api/v3/System.php
+++ b/
api/v3/System.php
@@
-26,23
+26,20
@@
*/
/**
*/
/**
- *
File for the CiviCRM APIv3 domain functions
+ *
This api exposes CiviCRM system functionality.
*
*
- * @package CiviCRM_APIv3
- * @subpackage API_Domain
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
+ * Includes caching, logging, and checking system functionality.
*
*
+ * @package CiviCRM_APIv3
*/
/**
*/
/**
- * Flush all system caches
+ * Flush all system caches
.
*
* @param array $params
* Input parameters.
*
* @param array $params
* Input parameters.
- *
- triggers: bool, whether to drop/create SQL triggers; default: FALSE
- *
- session: bool, whether to reset the CiviCRM session data; defaul
: FALSE
+ * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
+ *
- session: bool, whether to reset the CiviCRM session data; default
: FALSE
*
* @return array
*/
*
* @return array
*/
@@
-55,11
+52,12
@@
function civicrm_api3_system_flush($params) {
}
/**
}
/**
- * Adjust Metadata for Flush action
+ * Adjust Metadata for Flush action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
parameters determined by getfields.
*/
function _civicrm_api3_system_flush_spec(&$params) {
$params['triggers'] = array('title' => 'rebuild triggers (boolean)');
*/
function _civicrm_api3_system_flush_spec(&$params) {
$params['triggers'] = array('title' => 'rebuild triggers (boolean)');
@@
-67,12
+65,13
@@
function _civicrm_api3_system_flush_spec(&$params) {
}
/**
}
/**
- * System.Check API specification (optional)
+ * System.Check API specification (optional).
+ *
* This is used for documentation and validation.
*
* @param array $spec
* Description of fields supported by this API call.
* This is used for documentation and validation.
*
* @param array $spec
* Description of fields supported by this API call.
- *
@return void
+ *
* @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
function _civicrm_api3_system_check_spec(&$spec) {
* @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
function _civicrm_api3_system_check_spec(&$spec) {
@@
-80,9
+79,10
@@
function _civicrm_api3_system_check_spec(&$spec) {
}
/**
}
/**
- * System
.Check API
+ * System
Check API.
*
* @param array $params
*
* @param array $params
+ *
* @return array
* API result descriptor; return items are alert codes/messages
* @see civicrm_api3_create_success
* @return array
* API result descriptor; return items are alert codes/messages
* @see civicrm_api3_create_success
@@
-100,13
+100,15
@@
function civicrm_api3_system_check($params) {
}
/**
}
/**
+ * Log entry to system log table.
+ *
* @param array $params
*
* @return array
*/
function civicrm_api3_system_log($params) {
$log = new CRM_Utils_SystemLogger();
* @param array $params
*
* @return array
*/
function civicrm_api3_system_log($params) {
$log = new CRM_Utils_SystemLogger();
- //
t
his part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
+ //
T
his part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
// 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?
if (!isset($params['context'])) {
$params['context'] = array();
// 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?
if (!isset($params['context'])) {
$params['context'] = array();
@@
-122,7
+124,8
@@
function civicrm_api3_system_log($params) {
}
/**
}
/**
- * Metadata for log function
+ * Metadata for log function.
+ *
* @param array $params
*/
function _civicrm_api3_system_log_spec(&$params) {
* @param array $params
*/
function _civicrm_api3_system_log_spec(&$params) {
@@
-157,9
+160,10
@@
function _civicrm_api3_system_log_spec(&$params) {
}
/**
}
/**
- * System.Get API
+ * System.Get API
.
*
* @param array $params
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_system_get($params) {
* @return array
*/
function civicrm_api3_system_get($params) {