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