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 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM participant status options. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
d1b0d05e | 35 | * Create/update participant_status. |
6a488035 TO |
36 | * |
37 | * This API is used to create new participant_status or update any of the existing | |
38 | * In case of updating existing participant_status, id of that particular participant_status must | |
39 | * be in $params array. | |
40 | * | |
cf470720 | 41 | * @param array $params |
c28e1768 | 42 | * name/value pairs to insert in new 'participant_status' |
6a488035 | 43 | * |
a6c01b45 | 44 | * @return array |
72b3a70c | 45 | * participant_status array |
6a488035 TO |
46 | */ |
47 | function civicrm_api3_participant_status_type_create($params) { | |
48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
49 | } | |
50 | ||
51 | /** | |
d1b0d05e | 52 | * Returns array of participant_statuses matching a set of one or more group properties. |
6a488035 | 53 | * |
cf470720 | 54 | * @param array $params |
b081365f | 55 | * Array of properties. If empty, all records will be returned. |
6a488035 | 56 | * |
a6c01b45 | 57 | * @return array |
72b3a70c | 58 | * Array of matching participant_statuses |
6a488035 TO |
59 | */ |
60 | function civicrm_api3_participant_status_type_get($params) { | |
61 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
62 | } | |
63 | ||
64 | /** | |
d1b0d05e | 65 | * Delete an existing participant_status. |
6a488035 | 66 | * |
244bbdd8 | 67 | * This method is used to delete any existing participant_status given its id. |
6a488035 | 68 | * |
cf470720 | 69 | * @param array $params |
c28e1768 | 70 | * [id] |
8089541a | 71 | * @return array api result array |
8089541a | 72 | * @throws API_Exception |
6a488035 TO |
73 | */ |
74 | function civicrm_api3_participant_status_type_delete($params) { | |
75 | if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) { | |
76 | return civicrm_api3_create_success(TRUE); | |
77 | } | |
78 | ||
a60c0bc8 | 79 | throw new API_Exception('Could not delete participant status type id ' . $params['id']); |
6a488035 | 80 | } |