4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 participant functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Participant
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
41 * Files required for this package
45 * Create an Event Participant
47 * This API is used for creating a participants in an event.
48 * Required parameters : event_id AND contact_id for new creation
49 * : participant as name/value with participantid for edit
51 * @param array $params
52 * An associative array of name/value property values of civicrm_participant.
54 * @return array apiresult
55 * {@getfields participant_create}
58 function civicrm_api3_participant_create($params) {
59 //check that event id is not an template - should be done @ BAO layer
60 if (!empty($params['event_id'])) {
61 $isTemplate = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
62 if (!empty($isTemplate)) {
63 return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
68 _civicrm_api3_custom_format_params($params, $values, 'Participant');
69 $params = array_merge($values, $params);
71 $participantBAO = CRM_Event_BAO_Participant
::create($params);
73 if(empty($params['price_set_id']) && empty($params['id']) && !empty($params['fee_level'])){
74 _civicrm_api3_participant_createlineitem($params, $participantBAO);
76 _civicrm_api3_object_to_array($participantBAO, $participant[$participantBAO->id
]);
78 return civicrm_api3_create_success($participant, $params, 'participant', 'create', $participantBAO);
82 * Create a default participant line item
84 function _civicrm_api3_participant_createlineitem(&$params, $participant){
85 // it is possible that a fee level contains information about multiple
86 // price field values.
88 $priceFieldValueDetails = CRM_Utils_Array
::explodePadded(
89 $params["fee_level"]);
91 foreach($priceFieldValueDetails as $detail) {
92 if (preg_match('/- ([0-9]+)$/', $detail, $matches)) {
93 // it is possible that a price field value is payd for multiple times.
94 // (FIXME: if the price field value ends in minus followed by whitespace
95 // and a number, things will go wrong.)
98 preg_match('/^(.*) - [0-9]+$/', $detail, $matches);
107 SELECT ps.id AS setID, pf.id AS priceFieldID, pfv.id AS priceFieldValueID, pfv.amount AS amount
108 FROM civicrm_price_set_entity cpse
109 LEFT JOIN civicrm_price_set ps ON cpse.price_set_id = ps.id AND cpse.entity_id = %1 AND cpse.entity_table = 'civicrm_event'
110 LEFT JOIN civicrm_price_field pf ON pf.`price_set_id` = ps.id
111 LEFT JOIN civicrm_price_field_value pfv ON pfv.price_field_id = pf.id
112 where ps.id is not null and pfv.label = %2
116 1 => array($params['event_id'], 'Integer'),
117 2 => array($label, 'String'),
120 $dao = CRM_Core_DAO
::executeQuery($sql, $qParams);
122 $lineItemparams = array(
123 'price_field_id' => $dao->priceFieldID
,
124 'price_field_value_id' => $dao->priceFieldValueID
,
125 'entity_table' => 'civicrm_participant',
126 'entity_id' => $participant->id
,
129 'participant_count' => 0,
130 'unit_price' => $dao->amount
,
131 'line_total' => $qty * $dao->amount
,
134 civicrm_api('line_item', 'create', $lineItemparams);
142 * Adjust Metadata for Create action
144 * The metadata is used for setting defaults, documentation & validation
145 * @param array $params
146 * Array or parameters determined by getfields.
148 function _civicrm_api3_participant_create_spec(&$params) {
149 $params['status_id']['api.default'] = "1";
150 $params['register_date']['api.default'] = "now";
151 $params['event_id']['api.required'] = 1;
152 $params['contact_id']['api.required'] = 1;
153 // These are for the sake of search builder options - can be removed if that is fixed
154 $params['role_id']['api.aliases'] = array('participant_role');
155 $params['status_id']['api.aliases'] = array('participant_status');
159 * Retrieve a specific participant, given a set of input params
160 * If more than one matching participant exists, return an error, unless
161 * the client has requested to return the first found contact
163 * @param array $params
164 * (reference ) input parameters.
166 * @return array (reference ) array of properties, if error an array with an error id and error message
167 * {@getfields participant_get}
170 function civicrm_api3_participant_get($params) {
171 $mode = CRM_Contact_BAO_Query
::MODE_EVENT
;
172 $entity = 'participant';
174 list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
176 $participant = array();
177 while ($dao->fetch()) {
178 $participant[$dao->participant_id
] = $query->store($dao);
179 //@todo - is this required - contribution & pledge use the same query but don't self-retrieve custom data
180 _civicrm_api3_custom_data_get($participant[$dao->participant_id
], 'Participant', $dao->participant_id
, NULL);
183 return civicrm_api3_create_success($participant, $params, 'participant', 'get', $dao);
187 * Adjust Metadata for Get action
189 * The metadata is used for setting defaults, documentation & validation
190 * @param array $params
191 * Array or parameters determined by getfields.
193 function _civicrm_api3_participant_get_spec(&$params) {
194 $params['participant_test']['api.default'] = 0;
195 $params['participant_test']['title'] = 'Get Test Participants';
199 * Deletes an existing contact participant
201 * This API is used for deleting a contact participant
203 * @param array $params
204 * Array containing Id of the contact participant to be deleted.
206 * {@getfields participant_delete}
211 function civicrm_api3_participant_delete($params) {
213 $result = CRM_Event_BAO_Participant
::deleteParticipant($params['id']);
216 return civicrm_api3_create_success();
219 throw new Exception('Error while deleting participant');