Merge pull request #3679 from yashodha/CRM-14951
[civicrm-core.git] / api / v3 / SystemLog.php
1 <?php
2
3 /*
4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
10 | |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
19 | |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
27 */
28
29 /**
30 * File for the CiviCRM APIv3 SystemLog functions
31 *
32 * @package CiviCRM_APIv3
33 * @subpackage API_SystemLog
34 *
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: SystemLog.php 30171 2010-10-14 09:11:27Z mover $
37 *
38 */
39
40 /**
41 * @param $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
51 * It's arguable whether this function should exist as it fits our crud pattern and adding it meets our SyntaxConformance test requirements
52 * but it just wraps system.log which is more consistent with the PSR3 implemented.
53 * @param $params
54 *
55 * @return array
56 */
57 function civicrm_api3_system_log_create($params) {
58 return civicrm_api3('system', 'log', $params);
59 }
60
61 /**
62 * @param $params
63 *
64 * @return array
65 */
66 function _civicrm_api3_system_log_create_spec(&$params) {
67 require_once('api/v3/System.php');
68 _civicrm_api3_system_log_spec($params);
69 }
70
71 /**
72 * @param $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 }
79