X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FSystem.php;h=1c7875d58875b73d1037bf6849ba8eb89fed8aee;hb=a5cea5e90a3ad463c363d53c49ed0bb1b6868dbc;hp=f08aaf3351c09a586f7b6eac3ff01990f28602bc;hpb=13c1cf91881e22bbcc38024c645736a3fc6fad4a;p=civicrm-core.git

diff --git a/api/v3/System.php b/api/v3/System.php
index f08aaf3351..1c7875d588 100644
--- a/api/v3/System.php
+++ b/api/v3/System.php
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +32,7 @@
  * @package CiviCRM_APIv3
  * @subpackage API_Domain
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
  *
  */
@@ -67,5 +67,35 @@ function civicrm_api3_system_flush($params) {
 function _civicrm_api3_system_flush_spec(&$params){
   $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
   $params['session'] = array('title' => 'refresh sessions (boolean)');
+}
 
+/**
+ * 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) {
+  // $spec['magicword']['api.required'] = 1;
 }
+
+/**
+ * System.Check API
+ *
+ * @param array $params
+ * @return array API result descriptor; return items are alert codes/messages
+ * @see civicrm_api3_create_success
+ * @see civicrm_api3_create_error
+ * @throws API_Exception
+ */
+function civicrm_api3_system_check($params) {
+  $returnValues = array();
+  foreach (CRM_Utils_Check::singleton()->checkAll() as $message) {
+    $returnValues[] = $message->toArray();
+  }
+
+  // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
+  return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
+}
\ No newline at end of file