Merge pull request #5901 from colemanw/CRM-16557

[civicrm-core.git] / api / v3 / System.php

diff --git a/api/v3/System.php b/api/v3/System.php
index b456f94b780968aa233667ae4765eff7a8c50f83..b60d2d44a14a5dd760ac58cdd1916d1ce5d117d4 100644 (file)
--- a/api/v3/System.php
+++ b/api/v3/System.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,29 +26,22 @@
  */
 
 /**
- * File for the CiviCRM APIv3 domain functions
- *
- * @package CiviCRM_APIv3
- * @subpackage API_Domain
+ * This api exposes CiviCRM system functionality.
  *
- * @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.
- *                          - triggers: bool, whether to drop/create SQL triggers; default: FALSE
- *                          - session:  bool, whether to reset the CiviCRM session data; defaul: FALSE
- *
- * @return boolean        true if success, else false
- * @static void
- * @access public
- * @example SystemFlush.php
+ *   - triggers: bool, whether to drop/create SQL triggers; default: FALSE
+ *   - session:  bool, whether to reset the CiviCRM session data; default: FALSE
  *
+ * @return array
  */
 function civicrm_api3_system_flush($params) {
   CRM_Core_Invoke::rebuildMenuAndCaches(
@@ -60,24 +52,34 @@ 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
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
-function _civicrm_api3_system_flush_spec(&$params){
-  $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
-  $params['session'] = array('title' => 'refresh sessions (boolean)');
+function _civicrm_api3_system_flush_spec(&$params) {
+  $params['triggers'] = array(
+    'title' => 'Triggers',
+    'description' => 'rebuild triggers (boolean)',
+    'type' => CRM_Utils_Type::T_BOOLEAN,
+  );
+  $params['session'] = array(
+    'title' => 'Sessions',
+    'description' => 'refresh sessions (boolean)',
+    'type' => CRM_Utils_Type::T_BOOLEAN,
+  );
 }
 
 /**
- * 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.
- * @return void
+ *
  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  */
 function _civicrm_api3_system_check_spec(&$spec) {
@@ -85,10 +87,12 @@ function _civicrm_api3_system_check_spec(&$spec) {
 }
 
 /**
- * System.Check API
+ * System Check API.
  *
  * @param array $params
- * @return array API result descriptor; return items are alert codes/messages
+ *
+ * @return array
+ *   API result descriptor; return items are alert codes/messages
  * @see civicrm_api3_create_success
  * @see civicrm_api3_create_error
  * @throws API_Exception
@@ -104,20 +108,22 @@ 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();
-  // this part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
+  // This 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'])) {
+  if (!isset($params['context'])) {
     $params['context'] = array();
   }
   $specialFields = array('contact_id', 'hostname');
-  foreach($specialFields as $specialField) {
-    if(isset($params[$specialField]) && !isset($params['context'])) {
+  foreach ($specialFields as $specialField) {
+    if (isset($params[$specialField]) && !isset($params['context'])) {
       $params['context'][$specialField] = $params[$specialField];
     }
   }
@@ -126,7 +132,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) {
@@ -161,9 +168,11 @@ function _civicrm_api3_system_log_spec(&$params) {
 }
 
 /**
- * System.Get API
+ * System.Get API.
  *
- * @param arary $params
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_system_get($params) {
   $returnValues = array(
@@ -174,4 +183,3 @@ function civicrm_api3_system_get($params) {
   );
   return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
 }
-