api/v3/SystemLog.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * This api exposes CiviCRM SystemLog.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Delete system log record.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  */
  41 function civicrm_api3_system_log_delete($params) {
  42   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  43 }
  44
  45 /**
  46  * Create system log record.
  47  *
  48  * It's arguable whether this function should exist as it fits our crud pattern and adding it meets our SyntaxConformance test requirements
  49  * but it just wraps system.log which is more consistent with the PSR3 implemented.
  50  *
  51  * @param array $params
  52  *
  53  * @return array
  54  */
  55 function civicrm_api3_system_log_create($params) {
  56   return civicrm_api3('system', 'log', $params);
  57 }
  58
  59 /**
  60  * Adjust system log create metadata.
  61  *
  62  * @param array $params
  63  */
  64 function _civicrm_api3_system_log_create_spec(&$params) {
  65   require_once 'api/v3/System.php';
  66   _civicrm_api3_system_log_spec($params);
  67 }
  68
  69 /**
  70  * Get system log record.
  71  *
  72  * @param array $params
  73  *
  74  * @return array
  75  */
  76 function civicrm_api3_system_log_get($params) {
  77   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'SystemLog');
  78 }