api/v3/Participant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 participant functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Participant
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Create an Event Participant
  41  *
  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
  45  *
  46  * @param array $params
  47  *   An associative array of name/value property values of civicrm_participant.
  48  *
  49  * @return array
  50  *   apiresult
  51  * {@getfields participant_create}
  52  * @access public
  53  */
  54 function civicrm_api3_participant_create($params) {
  55   //check that event id is not an template - should be done @ BAO layer
  56   if (!empty($params['event_id'])) {
  57     $isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
  58     if (!empty($isTemplate)) {
  59       return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
  60     }
  61   }
  62
  63   $values = $participant = array();
  64   _civicrm_api3_custom_format_params($params, $values, 'Participant');
  65   $params = array_merge($values, $params);
  66
  67   $participantBAO = CRM_Event_BAO_Participant::create($params);
  68
  69   if (empty($params['price_set_id']) && empty($params['id']) && !empty($params['fee_level'])) {
  70     _civicrm_api3_participant_createlineitem($params, $participantBAO);
  71   }
  72   _civicrm_api3_object_to_array($participantBAO, $participant[$participantBAO->id]);
  73
  74   return civicrm_api3_create_success($participant, $params, 'participant', 'create', $participantBAO);
  75 }
  76
  77 /**
  78  * @todo this should be done in the BAO not the api
  79  * Create a default participant line item
  80  * @param array $params
  81  * @param $participant
  82  * @throws \CiviCRM_API3_Exception
  83  */
  84 function _civicrm_api3_participant_createlineitem(&$params, $participant) {
  85   // it is possible that a fee level contains information about multiple
  86   // price field values.
  87
  88   $priceFieldValueDetails = CRM_Utils_Array::explodePadded(
  89     $params["fee_level"]);
  90
  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.)
  96
  97       $qty = $matches[1];
  98       preg_match('/^(.*) - [0-9]+$/', $detail, $matches);
  99       $label = $matches[1];
 100     }
 101     else {
 102       $label = $detail;
 103       $qty = 1;
 104     }
 105
 106     $sql = "
 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
 113     ";
 114
 115     $qParams = array(
 116       1 => array($params['event_id'], 'Integer'),
 117       2 => array($label, 'String'),
 118     );
 119
 120     $dao = CRM_Core_DAO::executeQuery($sql, $qParams);
 121     if ($dao->fetch()) {
 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,
 127         'label' => $label,
 128         'qty' => $qty,
 129         'participant_count' => 0,
 130         'unit_price' => $dao->amount,
 131         'line_total' => $qty * $dao->amount,
 132       );
 133       civicrm_api3('line_item', 'create', $lineItemParams);
 134     }
 135
 136   }
 137 }
 138
 139
 140 /**
 141  * Adjust Metadata for Create action
 142  *
 143  * The metadata is used for setting defaults, documentation & validation
 144  * @param array $params
 145  *   Array or parameters determined by getfields.
 146  */
 147 function _civicrm_api3_participant_create_spec(&$params) {
 148   $params['status_id']['api.default'] = "1";
 149   $params['register_date']['api.default'] = "now";
 150   $params['event_id']['api.required'] = 1;
 151   $params['contact_id']['api.required'] = 1;
 152   // These are for the sake of search builder options - can be removed if that is fixed
 153   $params['role_id']['api.aliases'] = array('participant_role');
 154   $params['status_id']['api.aliases'] = array('participant_status');
 155 }
 156
 157 /**
 158  * Retrieve a specific participant, given a set of input params
 159  * If more than one matching participant exists, return an error, unless
 160  * the client has requested to return the first found contact
 161  *
 162  * @param array $params
 163  *   (reference ) input parameters.
 164  *
 165  * @return array
 166  *   (reference )        array of properties, if error an array with an error id and error message
 167  * {@getfields participant_get}
 168  * @access public
 169  */
 170 function civicrm_api3_participant_get($params) {
 171   $mode = CRM_Contact_BAO_Query::MODE_EVENT;
 172   $entity = 'participant';
 173
 174   list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
 175
 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);
 181   }
 182
 183   return civicrm_api3_create_success($participant, $params, 'participant', 'get', $dao);
 184 }
 185
 186 /**
 187  * Adjust Metadata for Get action
 188  *
 189  * The metadata is used for setting defaults, documentation & validation
 190  * @param array $params
 191  *   Array or parameters determined by getfields.
 192  */
 193 function _civicrm_api3_participant_get_spec(&$params) {
 194   $params['participant_test']['api.default'] = 0;
 195   $params['participant_test']['title'] = 'Get Test Participants';
 196 }
 197
 198 /**
 199  * Deletes an existing contact participant
 200  *
 201  * This API is used for deleting a contact participant
 202  *
 203  * @param array $params
 204  *   Array containing Id of the contact participant to be deleted.
 205  *
 206  * {@getfields participant_delete}
 207  * @throws Exception
 208  * @return array
 209  * @access public
 210  */
 211 function civicrm_api3_participant_delete($params) {
 212
 213   $result = CRM_Event_BAO_Participant::deleteParticipant($params['id']);
 214
 215   if ($result) {
 216     return civicrm_api3_create_success();
 217   }
 218   else {
 219     throw new Exception('Error while deleting participant');
 220   }
 221 }