Merge pull request #766 from eileenmcnaughton/test-fix
[civicrm-core.git] / api / v3 / Grant.php
1 <?php
2 // $Id$
3
4 /*
5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
11 | |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
20 | |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
28 */
29
30 /**
31 * File for the CiviCRM APIv3 group functions
32 *
33 * @package CiviCRM_APIv3
34 * @subpackage API_Grant
35 * @copyright CiviCRM LLC (c) 2004-2013
36 */
37
38 /**
39 * create/update grant
40 *
41 * This API is used to create new grant or update any of the existing
42 * In case of updating existing grant, id of that particular grant must
43 * be in $params array.
44 *
45 * @param array $params Associative array of property
46 * name/value pairs to insert in new 'grant'
47 *
48 * @return array grant array
49 * {@getfields grant_create}
50 * @access public
51 */
52 function civicrm_api3_grant_create($params) {
53 $values = array();
54 _civicrm_api3_custom_format_params($params, $values, 'Grant');
55 $params = array_merge($values, $params);
56 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'grant');
57 }
58
59 /**
60 * Adjust Metadata for Create action
61 *
62 * The metadata is used for setting defaults, documentation & validation
63 * @param array $params array or parameters determined by getfields
64 */
65 function _civicrm_api3_grant_create_spec(&$params) {
66 $params['grant_type_id']['api.required'] = 1;
67 }
68
69 /**
70 * Returns array of grants matching a set of one or more group properties
71 *
72 * @param array $params (referance) Array of one or more valid
73 * property_name=>value pairs. If $params is set
74 * as null, all grants will be returned
75 *
76 * @return array (referance) Array of matching grants
77 * {@getfields grant_get}
78 * @access public
79 */
80 function civicrm_api3_grant_get($params) {
81 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
82 }
83
84 /**
85 * delete an existing grant
86 *
87 * This method is used to delete any existing grant. id of the group
88 * to be deleted is required field in $params array
89 *
90 * @param array $params array containing id of the group
91 * to be deleted
92 *
93 * @return array API Result Array
94 * {@getfields grant_delete}
95 * @access public
96 */
97 function civicrm_api3_grant_delete($params) {
98 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
99 }
100