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