4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Grant
34 * @copyright CiviCRM LLC (c) 2004-2014
40 * This API is used to create new grant or update any of the existing
41 * In case of updating existing grant, id of that particular grant must
42 * be in $params array.
44 * @param array $params Associative array of property
45 * name/value pairs to insert in new 'grant'
47 * @return array grant array
48 * {@getfields grant_create}
51 function civicrm_api3_grant_create($params) {
52 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Grant');
56 * Adjust Metadata for Create action
58 * The metadata is used for setting defaults, documentation & validation
59 * @param array $params array or parameters determined by getfields
61 function _civicrm_api3_grant_create_spec(&$params) {
62 $params['grant_type_id']['api.required'] = 1;
66 * Returns array of grants matching a set of one or more group properties
68 * @param array $params Array of one or more valid
69 * property_name=>value pairs. If $params is set
70 * as null, all grants will be returned
72 * @return array Array of matching grants
73 * {@getfields grant_get}
76 function civicrm_api3_grant_get($params) {
77 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Grant');
81 * delete an existing grant
83 * This method is used to delete any existing grant. id of the group
84 * to be deleted is required field in $params array
86 * @param array $params array containing id of the group
89 * @return array API Result Array
90 * {@getfields grant_delete}
93 function civicrm_api3_grant_delete($params) {
94 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);