+/**
+ * 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');
+}
+
+/**
+ * @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,
+ );
+}