api/v3/Event.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  *
  30  * This api exposes CiviCRM event.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Create a Event.
  37  *
  38  * @param array $params
  39  *   Input parameters.
  40  *
  41  * @return array
  42  *   API result Array.
  43  */
  44 function civicrm_api3_event_create($params) {
  45   civicrm_api3_verify_one_mandatory($params, NULL, array('event_type_id', 'template_id'));
  46
  47   // Clone event from template
  48   if (!empty($params['template_id']) && empty($params['id'])) {
  49     $copy = CRM_Event_BAO_Event::copy($params['template_id']);
  50     $params['id'] = $copy->id;
  51     unset($params['template_id']);
  52   }
  53
  54   _civicrm_api3_event_create_legacy_support_42($params);
  55   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Event');
  56 }
  57
  58 /**
  59  * Adjust Metadata for Create action.
  60  *
  61  * The metadata is used for setting defaults, documentation & validation.
  62  *
  63  * @param array $params
  64  *   Array of parameters determined by getfields.
  65  */
  66 function _civicrm_api3_event_create_spec(&$params) {
  67   $params['start_date']['api.required'] = 1;
  68   $params['title']['api.required'] = 1;
  69   $params['is_active']['api.default'] = 1;
  70   $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
  71   $params['is_template']['api.default'] = 0;
  72 }
  73
  74 /**
  75  * Support for schema changes made in 4.2.
  76  *
  77  * The main purpose of the API is to provide integrators a level of stability not provided by
  78  * the core code or schema - this means we have to provide support for api calls (where possible)
  79  * across schema changes.
  80  *
  81  * @param array $params
  82  */
  83 function _civicrm_api3_event_create_legacy_support_42(&$params) {
  84   if (!empty($params['payment_processor_id'])) {
  85     $params['payment_processor'] = CRM_Core_DAO::VALUE_SEPARATOR . $params['payment_processor_id'] . CRM_Core_DAO::VALUE_SEPARATOR;
  86   }
  87 }
  88
  89 /**
  90  * Get Event record.
  91  *
  92  * @param array $params
  93  *
  94  * @return array
  95  *   Array of all found event property values.
  96  */
  97 function civicrm_api3_event_get($params) {
  98
  99   //legacy support for $params['return.sort']
 100   if (!empty($params['return.sort'])) {
 101     $params['options']['sort'] = $params['return.sort'];
 102     unset($params['return.sort']);
 103   }
 104
 105   //legacy support for $params['return.offset']
 106   if (!empty($params['return.offset'])) {
 107     $params['options']['offset'] = $params['return.offset'];
 108     unset($params['return.offset']);
 109   }
 110
 111   //legacy support for $params['return.max_results']
 112   if (!empty($params['return.max_results'])) {
 113     $params['options']['limit'] = $params['return.max_results'];
 114     unset($params['return.max_results']);
 115   }
 116
 117   $eventDAO = new CRM_Event_BAO_Event();
 118   _civicrm_api3_dao_set_filter($eventDAO, $params, TRUE, 'Event');
 119
 120   if (!empty($params['isCurrent'])) {
 121     $eventDAO->whereAdd('(start_date >= CURDATE() || end_date >= CURDATE())');
 122   }
 123
 124   // @todo should replace all this with _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity) - but we still have
 125   // the return.is_full to deal with.
 126   // NB the std dao_to_array function should only return custom if required.
 127   $event = array();
 128   $options = _civicrm_api3_get_options_from_params($params);
 129
 130   $eventDAO->find();
 131   while ($eventDAO->fetch()) {
 132     $event[$eventDAO->id] = array();
 133     CRM_Core_DAO::storeValues($eventDAO, $event[$eventDAO->id]);
 134     if (!empty($params['return.is_full'])) {
 135       _civicrm_api3_event_getisfull($event, $eventDAO->id);
 136     }
 137     _civicrm_api3_event_get_legacy_support_42($event, $eventDAO->id);
 138     _civicrm_api3_custom_data_get($event[$eventDAO->id], 'Event', $eventDAO->id, NULL, $eventDAO->event_type_id);
 139     if (!empty($options['return'])) {
 140       $event[$eventDAO->id]['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $eventDAO->id);
 141     }
 142   }
 143
 144   return civicrm_api3_create_success($event, $params, 'event', 'get', $eventDAO);
 145 }
 146
 147 /**
 148  * Adjust Metadata for Get action.
 149  *
 150  * The metadata is used for setting defaults, documentation & validation.
 151  *
 152  * @param array $params
 153  *   Array of parameters determined by getfields.
 154  */
 155 function _civicrm_api3_event_get_spec(&$params) {
 156   $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
 157 }
 158
 159 /**
 160  * Support for schema changes made in 4.2.
 161  *
 162  * The main purpose of the API is to provide integrators a level of stability not provided by
 163  * the core code or schema - this means we have to provide support for api calls (where possible)
 164  * across schema changes.
 165  *
 166  * @param array $event
 167  * @param int $event_id
 168  */
 169 function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
 170   if (!empty($event[$event_id]['payment_processor'])) {
 171     $processors = explode(CRM_Core_DAO::VALUE_SEPARATOR, $event[$event_id]['payment_processor']);
 172     if (count($processors) == 3) {
 173       $event[$event_id]['payment_processor_id'] = $processors[1];
 174     }
 175   }
 176 }
 177
 178 /**
 179  * Delete an existing event.
 180  *
 181  * This API is used for deleting a event.
 182  *
 183  * @param array $params
 184  *
 185  * @return array
 186  */
 187 function civicrm_api3_event_delete($params) {
 188   return CRM_Event_BAO_Event::del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event'));
 189 }
 190
 191 /**
 192  * Add 'is_full' & 'available_seats' to the return array.
 193  *
 194  * (this might be better in the BAO)
 195  * Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form
 196  *
 197  * @param array $event
 198  *   Return array of the event.
 199  * @param int $event_id
 200  *   Id of the event to be updated.
 201  */
 202 function _civicrm_api3_event_getisfull(&$event, $event_id) {
 203   $eventFullResult = CRM_Event_BAO_Participant::eventFull($event_id, 1);
 204   if (!empty($eventFullResult) && is_int($eventFullResult)) {
 205     $event[$event_id]['available_places'] = $eventFullResult;
 206   }
 207   else {
 208     $event[$event_id]['available_places'] = 0;
 209   }
 210   $event[$event_id]['is_full'] = $event[$event_id]['available_places'] == 0 ? 1 : 0;
 211 }
 212
 213
 214 /**
 215  * Get event list parameters.
 216  *
 217  * @see _civicrm_api3_generic_getlist_params
 218  *
 219  * @param array $request
 220  */
 221 function _civicrm_api3_event_getlist_params(&$request) {
 222   $fieldsToReturn = array('start_date', 'event_type_id', 'title', 'summary');
 223   $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
 224   $request['params']['options']['sort'] = 'start_date DESC';
 225   $request['params'] += array(
 226     'is_template' => 0,
 227     'is_active' => 1,
 228   );
 229 }
 230
 231 /**
 232  * Get event list output.
 233  *
 234  * @see _civicrm_api3_generic_getlist_output
 235  *
 236  * @param array $result
 237  * @param array $request
 238  *
 239  * @return array
 240  */
 241 function _civicrm_api3_event_getlist_output($result, $request) {
 242   $output = array();
 243   if (!empty($result['values'])) {
 244     foreach ($result['values'] as $row) {
 245       $data = array(
 246         'id' => $row[$request['id_field']],
 247         'label' => $row[$request['label_field']],
 248         'description' => array(
 249           CRM_Core_Pseudoconstant::getLabel(
 250             'CRM_Event_BAO_Event',
 251             'event_type_id',
 252             $row['event_type_id']
 253           ),
 254         ),
 255       );
 256       if (!empty($row['start_date'])) {
 257         $data['description'][0] .= ': ' . CRM_Utils_Date::customFormat($row['start_date']);
 258       }
 259       if (!empty($row['summary'])) {
 260         $data['description'][] = $row['summary'];
 261       }
 262       foreach ($request['extra'] as $field) {
 263         $data['extra'][$field] = isset($row[$field]) ? $row[$field] : NULL;
 264       }
 265       $output[] = $data;
 266     }
 267   }
 268   return $output;
 269 }