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 participant functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Participant
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
40 * Create an Event Participant
42 * This API is used for creating a participants in an event.
43 * Required parameters : event_id AND contact_id for new creation
44 * : participant as name/value with participantid for edit
46 * @param array $params
47 * An associative array of name/value property values of civicrm_participant.
51 * {@getfields participant_create}
53 function civicrm_api3_participant_create($params) {
54 //check that event id is not an template - should be done @ BAO layer
55 if (!empty($params['event_id'])) {
56 $isTemplate = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
57 if (!empty($isTemplate)) {
58 return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
62 $values = $participant = array();
63 _civicrm_api3_custom_format_params($params, $values, 'Participant');
64 $params = array_merge($values, $params);
66 $participantBAO = CRM_Event_BAO_Participant
::create($params);
68 if (empty($params['price_set_id']) && empty($params['id']) && !empty($params['fee_level'])) {
69 _civicrm_api3_participant_createlineitem($params, $participantBAO);
71 _civicrm_api3_object_to_array($participantBAO, $participant[$participantBAO->id
]);
73 return civicrm_api3_create_success($participant, $params, 'participant', 'create', $participantBAO);
77 * @todo this should be done in the BAO not the api
78 * Create a default participant line item
79 * @param array $params
81 * @throws \CiviCRM_API3_Exception
83 function _civicrm_api3_participant_createlineitem(&$params, $participant) {
84 // it is possible that a fee level contains information about multiple
85 // price field values.
87 $priceFieldValueDetails = CRM_Utils_Array
::explodePadded(
88 $params["fee_level"]);
90 foreach ($priceFieldValueDetails as $detail) {
91 if (preg_match('/- ([0-9]+)$/', $detail, $matches)) {
92 // it is possible that a price field value is payd for multiple times.
93 // (FIXME: if the price field value ends in minus followed by whitespace
94 // and a number, things will go wrong.)
97 preg_match('/^(.*) - [0-9]+$/', $detail, $matches);
106 SELECT ps.id AS setID, pf.id AS priceFieldID, pfv.id AS priceFieldValueID, pfv.amount AS amount
107 FROM civicrm_price_set_entity cpse
108 LEFT JOIN civicrm_price_set ps ON cpse.price_set_id = ps.id AND cpse.entity_id = %1 AND cpse.entity_table = 'civicrm_event'
109 LEFT JOIN civicrm_price_field pf ON pf.`price_set_id` = ps.id
110 LEFT JOIN civicrm_price_field_value pfv ON pfv.price_field_id = pf.id
111 where ps.id is not null and pfv.label = %2
115 1 => array($params['event_id'], 'Integer'),
116 2 => array($label, 'String'),
119 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
121 $lineItemParams = array(
122 'price_field_id' => $dao->priceFieldID
,
123 'price_field_value_id' => $dao->priceFieldValueID
,
124 'entity_table' => 'civicrm_participant',
125 'entity_id' => $participant->id
,
128 'participant_count' => 0,
129 'unit_price' => $dao->amount
,
130 'line_total' => $qty * $dao->amount
,
132 civicrm_api3('line_item', 'create', $lineItemParams);
140 * Adjust Metadata for Create action
142 * The metadata is used for setting defaults, documentation & validation
143 * @param array $params
144 * Array or parameters determined by getfields.
146 function _civicrm_api3_participant_create_spec(&$params) {
147 $params['status_id']['api.default'] = "1";
148 $params['register_date']['api.default'] = "now";
149 $params['event_id']['api.required'] = 1;
150 $params['contact_id']['api.required'] = 1;
151 // These are for the sake of search builder options - can be removed if that is fixed
152 $params['role_id']['api.aliases'] = array('participant_role');
153 $params['status_id']['api.aliases'] = array('participant_status');
157 * Retrieve a specific participant, given a set of input params
158 * If more than one matching participant exists, return an error, unless
159 * the client has requested to return the first found contact
161 * @param array $params
162 * (reference ) input parameters.
165 * (reference ) array of properties, if error an array with an error id and error message
166 * {@getfields participant_get}
168 function civicrm_api3_participant_get($params) {
169 $mode = CRM_Contact_BAO_Query
::MODE_EVENT
;
170 $entity = 'participant';
172 list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
174 $participant = array();
175 while ($dao->fetch()) {
176 $participant[$dao->participant_id
] = $query->store($dao);
177 //@todo - is this required - contribution & pledge use the same query but don't self-retrieve custom data
178 _civicrm_api3_custom_data_get($participant[$dao->participant_id
], 'Participant', $dao->participant_id
, NULL);
181 return civicrm_api3_create_success($participant, $params, 'participant', 'get', $dao);
185 * Adjust Metadata for Get action
187 * The metadata is used for setting defaults, documentation & validation
188 * @param array $params
189 * Array or parameters determined by getfields.
191 function _civicrm_api3_participant_get_spec(&$params) {
192 $params['participant_test']['api.default'] = 0;
193 $params['participant_test']['title'] = 'Get Test Participants';
197 * Deletes an existing contact participant
199 * This API is used for deleting a contact participant
201 * @param array $params
202 * Array containing Id of the contact participant to be deleted.
204 * {@getfields participant_delete}
208 function civicrm_api3_participant_delete($params) {
210 $result = CRM_Event_BAO_Participant
::deleteParticipant($params['id']);
213 return civicrm_api3_create_success();
216 throw new Exception('Error while deleting participant');