<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
*/
/**
- * File for the CiviCRM APIv3 participant functions
+ * This api exposes CiviCRM participant.
*
* @package CiviCRM_APIv3
- * @subpackage API_Participant
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
- *
- */
-
-/**
- * Files required for this package
*/
/**
- * Create an Event Participant
+ * Create an Event Participant.
*
- * This API is used for creating a participants in an event.
- * Required parameters : event_id AND contact_id for new creation
- * : participant as name/value with participantid for edit
+ * @param array $params
+ * An associative array of name/value property values of civicrm_participant.
*
- * @param array $params an associative array of name/value property values of civicrm_participant
- *
- * @return array apiresult
- * {@getfields participant_create}
- * @access public
+ * @return array
+ * API result array
*/
function civicrm_api3_participant_create($params) {
- //check that event id is not an template - should be done @ BAO layer
+ // Check that event id is not an template - should be done @ BAO layer.
if (!empty($params['event_id'])) {
$isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
if (!empty($isTemplate)) {
}
}
- $value = array();
+ $values = $participant = array();
_civicrm_api3_custom_format_params($params, $values, 'Participant');
$params = array_merge($values, $params);
$participantBAO = CRM_Event_BAO_Participant::create($params);
- if(empty($params['price_set_id']) && empty($params['id']) && !empty($params['fee_level'])){
+ if (empty($params['price_set_id']) && empty($params['id']) && !empty($params['fee_level'])) {
_civicrm_api3_participant_createlineitem($params, $participantBAO);
}
_civicrm_api3_object_to_array($participantBAO, $participant[$participantBAO->id]);
- return civicrm_api3_create_success($participant, $params, 'participant', 'create', $participantBAO);
+ return civicrm_api3_create_success($participant, $params, 'Participant', 'create', $participantBAO);
}
/**
- * Create a default participant line item
+ * Create a default participant line item.
+ *
+ * @todo this should be done in the BAO not the api
+ *
+ * @param array $params
+ * @param $participant
+ *
+ * @throws \CiviCRM_API3_Exception
*/
-function _civicrm_api3_participant_createlineitem(&$params, $participant){
+function _civicrm_api3_participant_createlineitem(&$params, $participant) {
// it is possible that a fee level contains information about multiple
// price field values.
$priceFieldValueDetails = CRM_Utils_Array::explodePadded(
$params["fee_level"]);
- foreach($priceFieldValueDetails as $detail) {
+ foreach ($priceFieldValueDetails as $detail) {
if (preg_match('/- ([0-9]+)$/', $detail, $matches)) {
// it is possible that a price field value is payd for multiple times.
// (FIXME: if the price field value ends in minus followed by whitespace
$dao = CRM_Core_DAO::executeQuery($sql, $qParams);
if ($dao->fetch()) {
- $lineItemparams = array(
+ $lineItemParams = array(
'price_field_id' => $dao->priceFieldID,
'price_field_value_id' => $dao->priceFieldValueID,
'entity_table' => 'civicrm_participant',
'qty' => $qty,
'participant_count' => 0,
'unit_price' => $dao->amount,
- 'line_total' => $qty*$dao->amount,
- 'version' => 3,
+ 'line_total' => $qty * $dao->amount,
);
- civicrm_api('line_item', 'create', $lineItemparams);
+ civicrm_api3('line_item', 'create', $lineItemParams);
}
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_participant_create_spec(&$params) {
$params['status_id']['api.default'] = "1";
}
/**
- * Retrieve a specific participant, given a set of input params
- * If more than one matching participant exists, return an error, unless
- * the client has requested to return the first found contact
+ * Retrieve a specific participant, given a set of input params.
*
- * @param array $params (reference ) input parameters
+ * @param array $params
+ * input parameters.
*
- * @return array (reference ) array of properties, if error an array with an error id and error message
- * {@getfields participant_get}
- * @access public
+ * @return array
+ * array of properties, if error an array with an error id and error message
*/
function civicrm_api3_participant_get($params) {
$mode = CRM_Contact_BAO_Query::MODE_EVENT;
- $entity = 'participant';
- list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
+ list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Participant');
$participant = array();
while ($dao->fetch()) {
_civicrm_api3_custom_data_get($participant[$dao->participant_id], 'Participant', $dao->participant_id, NULL);
}
- return civicrm_api3_create_success($participant, $params, 'participant', 'get', $dao);
+ return civicrm_api3_create_success($participant, $params, 'Participant', 'get', $dao);
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_participant_get_spec(&$params) {
$params['participant_test']['api.default'] = 0;
}
/**
- * Deletes an existing contact participant
+ * Deletes an existing contact participant.
*
* This API is used for deleting a contact participant
*
- * @param array $params Array containing Id of the contact participant to be deleted
+ * @param array $params
+ * Array containing Id of the contact participant to be deleted.
*
- * {@getfields participant_delete}
* @throws Exception
* @return array
- * @access public
*/
function civicrm_api3_participant_delete($params) {
throw new Exception('Error while deleting participant');
}
}
-
projects / civicrm-core.git / blobdiff