Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | /** | |
29 | * File for the CiviCRM APIv3 group functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Grant | |
731a0992 | 33 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
34 | */ |
35 | ||
6a488035 TO |
36 | /** |
37 | * create/update grant | |
38 | * | |
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. | |
42 | * | |
cf470720 TO |
43 | * @param array $params |
44 | * Associative array of property. | |
6a488035 TO |
45 | * name/value pairs to insert in new 'grant' |
46 | * | |
a6c01b45 | 47 | * @return array |
72b3a70c | 48 | * grant array |
28a04ea9 | 49 | * {@getfields grant_create} |
6a488035 TO |
50 | */ |
51 | function civicrm_api3_grant_create($params) { | |
9af2925b | 52 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant'); |
6a488035 | 53 | } |
11e09c59 TO |
54 | |
55 | /** | |
6a488035 TO |
56 | * Adjust Metadata for Create action |
57 | * | |
58 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
59 | * @param array $params |
60 | * Array or parameters determined by getfields. | |
6a488035 TO |
61 | */ |
62 | function _civicrm_api3_grant_create_spec(&$params) { | |
63 | $params['grant_type_id']['api.required'] = 1; | |
8ae90f85 | 64 | $params['status_id']['api.aliases'] = array('grant_status'); |
6a488035 TO |
65 | } |
66 | ||
67 | /** | |
68 | * Returns array of grants matching a set of one or more group properties | |
69 | * | |
cf470720 TO |
70 | * @param array $params |
71 | * Array of one or more valid. | |
6a488035 TO |
72 | * property_name=>value pairs. If $params is set |
73 | * as null, all grants will be returned | |
74 | * | |
a6c01b45 | 75 | * @return array |
72b3a70c | 76 | * Array of matching grants |
28a04ea9 | 77 | * {@getfields grant_get} |
6a488035 TO |
78 | */ |
79 | function civicrm_api3_grant_get($params) { | |
9af2925b | 80 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant'); |
6a488035 TO |
81 | } |
82 | ||
83 | /** | |
84 | * delete an existing grant | |
85 | * | |
86 | * This method is used to delete any existing grant. id of the group | |
87 | * to be deleted is required field in $params array | |
88 | * | |
cf470720 TO |
89 | * @param array $params |
90 | * Array containing id of the group. | |
6a488035 TO |
91 | * to be deleted |
92 | * | |
a6c01b45 | 93 | * @return array |
72b3a70c | 94 | * API Result Array |
28a04ea9 | 95 | * {@getfields grant_delete} |
6a488035 TO |
96 | */ |
97 | function civicrm_api3_grant_delete($params) { | |
98 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
99 | } |