3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 group functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Grant
33 * @copyright CiviCRM LLC (c) 2004-2014
39 * This API is used to create new grant or update any of the existing
40 * In case of updating existing grant, id of that particular grant must
41 * be in $params array.
43 * @param array $params
44 * Associative array of property.
45 * name/value pairs to insert in new 'grant'
49 * {@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.
60 * @param array $params
61 * Array or parameters determined by getfields.
63 function _civicrm_api3_grant_create_spec(&$params) {
64 $params['grant_type_id']['api.required'] = 1;
65 $params['status_id']['api.aliases'] = array('grant_status');
69 * Returns array of grants matching a set of one or more group properties
71 * @param array $params
72 * Array of one or more valid.
73 * property_name=>value pairs. If $params is set
74 * as null, all grants will be returned
77 * Array of matching grants
78 * {@getfields grant_get}
80 function civicrm_api3_grant_get($params) {
81 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Grant');
85 * delete an existing grant
87 * This method is used to delete any existing grant. id of the group
88 * to be deleted is required field in $params array
90 * @param array $params
91 * Array containing id of the group.
96 * {@getfields grant_delete}
98 function civicrm_api3_grant_delete($params) {
99 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);