api/v3/System.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * File for the CiviCRM APIv3 domain functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Domain
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
  36  *
  37  */
  38
  39 /**
  40  * Flush all system caches
  41  *
  42  * @param array $params
  43  *   Input parameters.
  44  *                          - triggers: bool, whether to drop/create SQL triggers; default: FALSE
  45  *                          - session:  bool, whether to reset the CiviCRM session data; defaul: FALSE
  46  *
  47  * @return array
  48  */
  49 function civicrm_api3_system_flush($params) {
  50   CRM_Core_Invoke::rebuildMenuAndCaches(
  51     CRM_Utils_Array::value('triggers', $params, FALSE),
  52     CRM_Utils_Array::value('session', $params, FALSE)
  53   );
  54   return civicrm_api3_create_success();
  55 }
  56
  57 /**
  58  * Adjust Metadata for Flush action
  59  *
  60  * The metadata is used for setting defaults, documentation & validation.
  61  *
  62  * @param array $params
  63  *   Array or parameters determined by getfields.
  64  */
  65 function _civicrm_api3_system_flush_spec(&$params) {
  66   $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
  67   $params['session'] = array('title' => 'refresh sessions (boolean)');
  68 }
  69
  70 /**
  71  * System.Check API specification (optional)
  72  * This is used for documentation and validation.
  73  *
  74  * @param array $spec
  75  *   Description of fields supported by this API call.
  76  * @return void
  77  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  78  */
  79 function _civicrm_api3_system_check_spec(&$spec) {
  80   // $spec['magicword']['api.required'] = 1;
  81 }
  82
  83 /**
  84  * System.Check API
  85  *
  86  * @param array $params
  87  * @return array
  88  *   API result descriptor; return items are alert codes/messages
  89  * @see civicrm_api3_create_success
  90  * @see civicrm_api3_create_error
  91  * @throws API_Exception
  92  */
  93 function civicrm_api3_system_check($params) {
  94   $returnValues = array();
  95   foreach (CRM_Utils_Check::singleton()->checkAll() as $message) {
  96     $returnValues[] = $message->toArray();
  97   }
  98
  99   // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
 100   return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
 101 }
 102
 103 /**
 104  * @param array $params
 105  *
 106  * @return array
 107  */
 108 function civicrm_api3_system_log($params) {
 109   $log = new CRM_Utils_SystemLogger();
 110   // this part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
 111   // 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?
 112   if (!isset($params['context'])) {
 113     $params['context'] = array();
 114   }
 115   $specialFields = array('contact_id', 'hostname');
 116   foreach ($specialFields as $specialField) {
 117     if (isset($params[$specialField]) && !isset($params['context'])) {
 118       $params['context'][$specialField] = $params[$specialField];
 119     }
 120   }
 121   $returnValues = $log->log($params['level'], $params['message'], $params['context']);
 122   return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
 123 }
 124
 125 /**
 126  * Metadata for log function
 127  * @param array $params
 128  */
 129 function _civicrm_api3_system_log_spec(&$params) {
 130   $params['level'] = array(
 131     'title' => 'Log Level',
 132     'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
 133     'type' => CRM_Utils_Type::T_STRING,
 134     'api.required' => TRUE,
 135   );
 136   $params['message'] = array(
 137     'title' => 'Log Message',
 138     'description' => 'Standardised message string, you can also ',
 139     'type' => CRM_Utils_Type::T_STRING,
 140     'api.required' => TRUE,
 141   );
 142   $params['context'] = array(
 143     'title' => 'Log Context',
 144     'description' => 'An array of additional data to store.',
 145     'type' => CRM_Utils_Type::T_LONGTEXT,
 146     'api.default' => array(),
 147   );
 148   $params['contact_id'] = array(
 149     'title' => 'Log Contact ID',
 150     'description' => 'Optional ID of relevant contact',
 151     'type' => CRM_Utils_Type::T_INT,
 152   );
 153   $params['hostname'] = array(
 154     'title' => 'Log Hostname',
 155     'description' => 'Optional name of host',
 156     'type' => CRM_Utils_Type::T_STRING,
 157   );
 158 }
 159
 160 /**
 161  * System.Get API
 162  *
 163  * @param array $params
 164  * @return array
 165  */
 166 function civicrm_api3_system_get($params) {
 167   $returnValues = array(
 168     array(
 169       'version' => CRM_Utils_System::version(),
 170       'uf' => CIVICRM_UF,
 171     ),
 172   );
 173   return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
 174 }