3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * This api exposes CiviCRM Grant records.
31 * @note Grant component must be enabled.
33 * @package CiviCRM_APIv3
37 * Create/update Grant.
39 * @param array $params
40 * Array per getfields metadata.
44 function civicrm_api3_grant_create($params) {
45 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Grant');
49 * Adjust Metadata for Create action.
51 * The metadata is used for setting defaults, documentation & validation.
53 * @param array $params
54 * Array of parameters determined by getfields.
56 function _civicrm_api3_grant_create_spec(&$params) {
57 $params['contact_id']['api.required'] = 1;
58 $params['grant_type_id']['api.required'] = 1;
59 $params['status_id']['api.required'] = 1;
60 $params['amount_total']['api.required'] = 1;
61 $params['status_id']['api.aliases'] = array('grant_status');
65 * Returns array of grants matching a set of one or more properties.
67 * @param array $params
68 * Array per getfields metadata.
71 * Array of matching grants
73 function civicrm_api3_grant_get($params) {
74 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Grant');
78 * This method is used to delete an existing Grant.
80 * @param array $params
81 * Id of the Grant to be deleted is required.
86 function civicrm_api3_grant_delete($params) {
87 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);