api/v3/Event.php

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