Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM Grant records. |
b081365f CW |
30 | * |
31 | * @note Grant component must be enabled. | |
6a488035 TO |
32 | * |
33 | * @package CiviCRM_APIv3 | |
6a488035 TO |
34 | */ |
35 | ||
6a488035 | 36 | /** |
244bbdd8 | 37 | * Create/update Grant. |
6a488035 | 38 | * |
cf470720 | 39 | * @param array $params |
2e66abf8 | 40 | * Array per getfields metadata. |
6a488035 | 41 | * |
a6c01b45 | 42 | * @return array |
6a488035 TO |
43 | */ |
44 | function civicrm_api3_grant_create($params) { | |
9af2925b | 45 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant'); |
6a488035 | 46 | } |
11e09c59 TO |
47 | |
48 | /** | |
0aa0303c EM |
49 | * Adjust Metadata for Create action. |
50 | * | |
51 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 52 | * |
cf470720 | 53 | * @param array $params |
b081365f | 54 | * Array of parameters determined by getfields. |
6a488035 TO |
55 | */ |
56 | function _civicrm_api3_grant_create_spec(&$params) { | |
9988c6b3 | 57 | $params['contact_id']['api.required'] = 1; |
6a488035 | 58 | $params['grant_type_id']['api.required'] = 1; |
f4f2cb4c MM |
59 | $params['status_id']['api.required'] = 1; |
60 | $params['amount_total']['api.required'] = 1; | |
8ae90f85 | 61 | $params['status_id']['api.aliases'] = array('grant_status'); |
6a488035 TO |
62 | } |
63 | ||
64 | /** | |
c28e1768 | 65 | * Returns array of grants matching a set of one or more properties. |
6a488035 | 66 | * |
cf470720 | 67 | * @param array $params |
2e66abf8 | 68 | * Array per getfields metadata. |
6a488035 | 69 | * |
a6c01b45 | 70 | * @return array |
72b3a70c | 71 | * Array of matching grants |
6a488035 TO |
72 | */ |
73 | function civicrm_api3_grant_get($params) { | |
9af2925b | 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant'); |
6a488035 TO |
75 | } |
76 | ||
77 | /** | |
244bbdd8 | 78 | * This method is used to delete an existing Grant. |
6a488035 | 79 | * |
cf470720 | 80 | * @param array $params |
244bbdd8 | 81 | * Id of the Grant to be deleted is required. |
6a488035 | 82 | * |
a6c01b45 | 83 | * @return array |
72b3a70c | 84 | * API Result Array |
6a488035 TO |
85 | */ |
86 | function civicrm_api3_grant_delete($params) { | |
87 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
88 | } |