Merge pull request #3679 from yashodha/CRM-14951

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

diff --git a/api/v3/System.php b/api/v3/System.php
index 9a8d092e839c5ac6cdc760aa2af182ae960ff8b1..79c66f264578aa539992a62d01dbf1bbe2e35cda 100644 (file)
--- 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 $
  *
  */
@@ -92,10 +92,67 @@ function _civicrm_api3_system_check_spec(&$spec) {
  */
 function civicrm_api3_system_check($params) {
   $returnValues = array();
-  foreach (CRM_Utils_Check_Security::singleton()->checkAll() as $message) {
+  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
+}
+
+/**
+ * @param $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
+  // 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();
+  }
+  $specialFields = array('contact_id', 'hostname');
+  foreach($specialFields as $specialField) {
+    if(isset($params[$specialField]) && !isset($params['context'])) {
+      $params['context'][$specialField] = $params[$specialField];
+    }
+  }
+  $returnValues = $log->log($params['level'], $params['message'], $params['context']);
+  return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
+}
+
+/**
+ * Metadata for log function
+ * @param $params
+ */
+function _civicrm_api3_system_log_spec(&$params) {
+  $params['level'] = array(
+    'title' => 'Log Level',
+    'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
+    'type' => CRM_Utils_Type::T_STRING,
+    'api.required' => TRUE,
+  );
+  $params['message'] = array(
+    'title' => 'Log Message',
+    'description' => 'Standardised message string, you can also ',
+    'type' => CRM_Utils_Type::T_STRING,
+    'api.required' => TRUE,
+  );
+  $params['context'] = array(
+    'title' => 'Log Context',
+    'description' => 'An array of additional data to store.',
+    'type' => CRM_Utils_Type::T_LONGTEXT,
+    'api.default' => array(),
+  );
+  $params['contact_id'] = array(
+    'title' => 'Log Contact ID',
+    'description' => 'Optional ID of relevant contact',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['hostname'] = array(
+    'title' => 'Log Hostname',
+    'description' => 'Optional name of host',
+    'type' => CRM_Utils_Type::T_STRING,
+  );
+}