| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | class CRM_Report_Form_Extended extends CRM_Report_Form { |
| 36 | protected $_addressField = FALSE; |
| 37 | |
| 38 | protected $_emailField = FALSE; |
| 39 | |
| 40 | protected $_summary = NULL; |
| 41 | |
| 42 | protected $_customGroupExtends = array(); |
| 43 | protected $_baseTable = 'civicrm_contact'; |
| 44 | |
| 45 | /** |
| 46 | * |
| 47 | */ |
| 48 | public function __construct() { |
| 49 | parent::__construct(); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * |
| 54 | */ |
| 55 | public function preProcess() { |
| 56 | parent::preProcess(); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * |
| 61 | */ |
| 62 | public function select() { |
| 63 | parent::select(); |
| 64 | } |
| 65 | |
| 66 | |
| 67 | /** |
| 68 | * From clause build where baseTable & fromClauses are defined |
| 69 | */ |
| 70 | public function from() { |
| 71 | if (!empty($this->_baseTable)) { |
| 72 | $this->buildACLClause($this->_aliases['civicrm_contact']); |
| 73 | $this->_from = "FROM {$this->_baseTable} {$this->_aliases[$this->_baseTable]}"; |
| 74 | $availableClauses = $this->getAvailableJoins(); |
| 75 | foreach ($this->fromClauses() as $fromClause) { |
| 76 | $fn = $availableClauses[$fromClause]['callback']; |
| 77 | $this->$fn(); |
| 78 | } |
| 79 | if (strstr($this->_from, 'civicrm_contact')) { |
| 80 | $this->_from .= $this->_aclFrom; |
| 81 | } |
| 82 | } |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Define any from clauses in use (child classes to override) |
| 87 | * |
| 88 | * @return array |
| 89 | */ |
| 90 | public function fromClauses() { |
| 91 | return array(); |
| 92 | } |
| 93 | |
| 94 | public function groupBy() { |
| 95 | parent::groupBy(); |
| 96 | //@todo - need to re-visit this - bad behaviour from pa |
| 97 | if ($this->_groupBy == 'GROUP BY') { |
| 98 | $this->_groupBY = NULL; |
| 99 | } |
| 100 | // if a stat field has been selected the do a group by |
| 101 | if (!empty($this->_statFields) && empty($this->_groupBy)) { |
| 102 | $this->_groupBy[] = $this->_aliases[$this->_baseTable] . ".id"; |
| 103 | } |
| 104 | //@todo - this should be in the parent function or at parent level - perhaps build query should do this? |
| 105 | if (!empty($this->_groupBy) && is_array($this->_groupBy)) { |
| 106 | $this->_groupBy = 'GROUP BY ' . implode(',', $this->_groupBy); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | public function orderBy() { |
| 111 | parent::orderBy(); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @param array $rows |
| 116 | * |
| 117 | * @return array |
| 118 | */ |
| 119 | public function statistics(&$rows) { |
| 120 | return parent::statistics($rows); |
| 121 | } |
| 122 | |
| 123 | public function postProcess() { |
| 124 | if (!empty($this->_aclTable) && !empty($this->_aliases[$this->_aclTable])) { |
| 125 | $this->buildACLClause($this->_aliases[$this->_aclTable]); |
| 126 | } |
| 127 | parent::postProcess(); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Alter display of rows. |
| 132 | * |
| 133 | * Iterate through the rows retrieved via SQL and make changes for display purposes, |
| 134 | * such as rendering contacts as links. |
| 135 | * |
| 136 | * @param array $rows |
| 137 | * Rows generated by SQL, with an array for each row. |
| 138 | */ |
| 139 | public function alterDisplay(&$rows) { |
| 140 | parent::alterDisplay($rows); |
| 141 | |
| 142 | //THis is all generic functionality which can hopefully go into the parent class |
| 143 | // it introduces the option of defining an alter display function as part of the column definition |
| 144 | // @tod tidy up the iteration so it happens in this function |
| 145 | list($firstRow) = $rows; |
| 146 | // no result to alter |
| 147 | if (empty($firstRow)) { |
| 148 | return; |
| 149 | } |
| 150 | $selectedFields = array_keys($firstRow); |
| 151 | |
| 152 | $alterfunctions = $altermap = array(); |
| 153 | foreach ($this->_columns as $tablename => $table) { |
| 154 | if (array_key_exists('fields', $table)) { |
| 155 | foreach ($table['fields'] as $field => $specs) { |
| 156 | if (in_array($tablename . '_' . $field, $selectedFields) && |
| 157 | array_key_exists('alter_display', $specs) |
| 158 | ) { |
| 159 | $alterfunctions[$tablename . '_' . |
| 160 | $field] = $specs['alter_display']; |
| 161 | $altermap[$tablename . '_' . $field] = $field; |
| 162 | } |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | if (empty($alterfunctions)) { |
| 167 | // - no manipulation to be done |
| 168 | return; |
| 169 | } |
| 170 | |
| 171 | foreach ($rows as $index => & $row) { |
| 172 | foreach ($row as $selectedfield => $value) { |
| 173 | if (array_key_exists($selectedfield, $alterfunctions)) { |
| 174 | $rows[$index][$selectedfield] = $this->$alterfunctions[$selectedfield]($value, $row, $selectedfield, $altermap[$selectedfield]); |
| 175 | } |
| 176 | } |
| 177 | } |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * @return array |
| 182 | */ |
| 183 | public function getLineItemColumns() { |
| 184 | return array( |
| 185 | 'civicrm_line_item' => array( |
| 186 | 'dao' => 'CRM_Price_BAO_LineItem', |
| 187 | 'fields' => array( |
| 188 | 'qty' => array( |
| 189 | 'title' => ts('Quantity'), |
| 190 | 'type' => CRM_Utils_Type::T_INT, |
| 191 | 'statistics' => array('sum' => ts('Total Quantity Selected')), |
| 192 | ), |
| 193 | 'unit_price' => array( |
| 194 | 'title' => ts('Unit Price'), |
| 195 | ), |
| 196 | 'line_total' => array( |
| 197 | 'title' => ts('Line Total'), |
| 198 | 'type' => CRM_Utils_Type::T_MONEY, |
| 199 | 'statistics' => array('sum' => ts('Total of Line Items')), |
| 200 | ), |
| 201 | ), |
| 202 | 'participant_count' => array( |
| 203 | 'title' => ts('Participant Count'), |
| 204 | 'statistics' => array('sum' => ts('Total Participants')), |
| 205 | ), |
| 206 | 'filters' => array( |
| 207 | 'qty' => array( |
| 208 | 'title' => ts('Quantity'), |
| 209 | 'type' => CRM_Utils_Type::T_INT, |
| 210 | 'operator' => CRM_Report_Form::OP_INT, |
| 211 | ), |
| 212 | ), |
| 213 | 'group_bys' => array( |
| 214 | 'price_field_id' => array( |
| 215 | 'title' => ts('Price Field'), |
| 216 | ), |
| 217 | 'price_field_value_id' => array( |
| 218 | 'title' => ts('Price Field Option'), |
| 219 | ), |
| 220 | 'line_item_id' => array( |
| 221 | 'title' => ts('Individual Line Item'), |
| 222 | 'name' => 'id', |
| 223 | ), |
| 224 | ), |
| 225 | ), |
| 226 | ); |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * @return array |
| 231 | */ |
| 232 | public function getPriceFieldValueColumns() { |
| 233 | return array( |
| 234 | 'civicrm_price_field_value' => array( |
| 235 | 'dao' => 'CRM_Price_BAO_PriceFieldValue', |
| 236 | 'fields' => array( |
| 237 | 'price_field_value_label' => array( |
| 238 | 'title' => ts('Price Field Value Label'), |
| 239 | 'name' => 'label', |
| 240 | ), |
| 241 | ), |
| 242 | 'filters' => array( |
| 243 | 'price_field_value_label' => array( |
| 244 | 'title' => ts('Price Fields Value Label'), |
| 245 | 'type' => CRM_Utils_Type::T_STRING, |
| 246 | 'operator' => 'like', |
| 247 | 'name' => 'label', |
| 248 | ), |
| 249 | ), |
| 250 | 'order_bys' => array( |
| 251 | 'label' => array( |
| 252 | 'title' => ts('Price Field Value Label'), |
| 253 | ), |
| 254 | ), |
| 255 | 'group_bys' => //note that we have a requirement to group by label such that all 'Promo book' lines |
| 256 | // are grouped together across price sets but there may be a separate need to group |
| 257 | // by id so that entries in one price set are distinct from others. Not quite sure what |
| 258 | // to call the distinction for end users benefit |
| 259 | array( |
| 260 | 'price_field_value_label' => array( |
| 261 | 'title' => ts('Price Field Value Label'), |
| 262 | 'name' => 'label', |
| 263 | ), |
| 264 | ), |
| 265 | ), |
| 266 | ); |
| 267 | } |
| 268 | |
| 269 | /** |
| 270 | * @return array |
| 271 | */ |
| 272 | public function getPriceFieldColumns() { |
| 273 | return array( |
| 274 | 'civicrm_price_field' => array( |
| 275 | 'dao' => 'CRM_Price_BAO_PriceField', |
| 276 | 'fields' => array( |
| 277 | 'price_field_label' => array( |
| 278 | 'title' => ts('Price Field Label'), |
| 279 | 'name' => 'label', |
| 280 | ), |
| 281 | ), |
| 282 | 'filters' => array( |
| 283 | 'price_field_label' => array( |
| 284 | 'title' => ts('Price Field Label'), |
| 285 | 'type' => CRM_Utils_Type::T_STRING, |
| 286 | 'operator' => 'like', |
| 287 | 'name' => 'label', |
| 288 | ), |
| 289 | ), |
| 290 | 'order_bys' => array( |
| 291 | 'price_field_label' => array( |
| 292 | 'title' => ts('Price Field Label'), |
| 293 | 'name' => 'label', |
| 294 | ), |
| 295 | ), |
| 296 | 'group_bys' => array( |
| 297 | 'price_field_label' => array( |
| 298 | 'title' => ts('Price Field Label'), |
| 299 | 'name' => 'label', |
| 300 | ), |
| 301 | ), |
| 302 | ), |
| 303 | ); |
| 304 | } |
| 305 | |
| 306 | /** |
| 307 | * @return array |
| 308 | */ |
| 309 | public function getParticipantColumns() { |
| 310 | static $_events = array(); |
| 311 | if (!isset($_events['all'])) { |
| 312 | CRM_Core_PseudoConstant::populate($_events['all'], 'CRM_Event_DAO_Event', FALSE, 'title', 'is_active', "is_template IS NULL OR is_template = 0", 'end_date DESC'); |
| 313 | } |
| 314 | return array( |
| 315 | 'civicrm_participant' => array( |
| 316 | 'dao' => 'CRM_Event_DAO_Participant', |
| 317 | 'fields' => array( |
| 318 | 'participant_id' => array('title' => 'Participant ID'), |
| 319 | 'participant_record' => array( |
| 320 | 'name' => 'id', |
| 321 | 'title' => ts('Participant ID'), |
| 322 | ), |
| 323 | 'event_id' => array( |
| 324 | 'title' => ts('Event ID'), |
| 325 | 'type' => CRM_Utils_Type::T_STRING, |
| 326 | 'alter_display' => 'alterEventID', |
| 327 | ), |
| 328 | 'status_id' => array( |
| 329 | 'title' => ts('Status'), |
| 330 | 'alter_display' => 'alterParticipantStatus', |
| 331 | ), |
| 332 | 'role_id' => array( |
| 333 | 'title' => ts('Role'), |
| 334 | 'alter_display' => 'alterParticipantRole', |
| 335 | ), |
| 336 | 'participant_fee_level' => NULL, |
| 337 | 'participant_fee_amount' => NULL, |
| 338 | 'participant_register_date' => array('title' => ts('Registration Date')), |
| 339 | ), |
| 340 | 'grouping' => 'event-fields', |
| 341 | 'filters' => array( |
| 342 | 'event_id' => array( |
| 343 | 'name' => 'event_id', |
| 344 | 'title' => ts('Event'), |
| 345 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 346 | 'options' => $_events['all'], |
| 347 | ), |
| 348 | 'sid' => array( |
| 349 | 'name' => 'status_id', |
| 350 | 'title' => ts('Participant Status'), |
| 351 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 352 | 'options' => CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label'), |
| 353 | ), |
| 354 | 'rid' => array( |
| 355 | 'name' => 'role_id', |
| 356 | 'title' => ts('Participant Role'), |
| 357 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 358 | 'options' => CRM_Event_PseudoConstant::participantRole(), |
| 359 | ), |
| 360 | 'participant_register_date' => array( |
| 361 | 'title' => ' Registration Date', |
| 362 | 'operatorType' => CRM_Report_Form::OP_DATE, |
| 363 | ), |
| 364 | ), |
| 365 | 'order_bys' => array( |
| 366 | 'event_id' => array( |
| 367 | 'title' => ts('Event'), |
| 368 | 'default_weight' => '1', |
| 369 | 'default_order' => 'ASC', |
| 370 | ), |
| 371 | ), |
| 372 | 'group_bys' => array( |
| 373 | 'event_id' => array('title' => ts('Event')), |
| 374 | ), |
| 375 | ), |
| 376 | ); |
| 377 | } |
| 378 | |
| 379 | /** |
| 380 | * @return array |
| 381 | */ |
| 382 | public function getMembershipColumns() { |
| 383 | return array( |
| 384 | 'civicrm_membership' => array( |
| 385 | 'dao' => 'CRM_Member_DAO_Membership', |
| 386 | 'grouping' => 'member-fields', |
| 387 | 'fields' => array( |
| 388 | 'membership_type_id' => array( |
| 389 | 'title' => 'Membership Type', |
| 390 | 'required' => TRUE, |
| 391 | 'alter_display' => 'alterMembershipTypeID', |
| 392 | ), |
| 393 | 'status_id' => array( |
| 394 | 'title' => 'Membership Status', |
| 395 | 'required' => TRUE, |
| 396 | 'alter_display' => 'alterMembershipStatusID', |
| 397 | ), |
| 398 | 'join_date' => NULL, |
| 399 | 'start_date' => array( |
| 400 | 'title' => ts('Current Cycle Start Date'), |
| 401 | ), |
| 402 | 'end_date' => array( |
| 403 | 'title' => ts('Current Membership Cycle End Date'), |
| 404 | ), |
| 405 | ), |
| 406 | 'group_bys' => array( |
| 407 | 'membership_type_id' => array( |
| 408 | 'title' => ts('Membership Type'), |
| 409 | ), |
| 410 | ), |
| 411 | 'filters' => array( |
| 412 | 'join_date' => array( |
| 413 | 'type' => CRM_Utils_Type::T_DATE, |
| 414 | 'operatorType' => CRM_Report_Form::OP_DATE, |
| 415 | ), |
| 416 | ), |
| 417 | ), |
| 418 | ); |
| 419 | } |
| 420 | |
| 421 | /** |
| 422 | * @return array |
| 423 | */ |
| 424 | public function getMembershipTypeColumns() { |
| 425 | return array( |
| 426 | 'civicrm_membership_type' => array( |
| 427 | 'dao' => 'CRM_Member_DAO_MembershipType', |
| 428 | 'grouping' => 'member-fields', |
| 429 | 'filters' => array( |
| 430 | 'gid' => array( |
| 431 | 'name' => 'id', |
| 432 | 'title' => ts('Membership Types'), |
| 433 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 434 | 'type' => CRM_Utils_Type::T_INT + CRM_Utils_Type::T_ENUM, |
| 435 | 'options' => CRM_Member_PseudoConstant::membershipType(), |
| 436 | ), |
| 437 | ), |
| 438 | ), |
| 439 | ); |
| 440 | } |
| 441 | |
| 442 | /** |
| 443 | * @return array |
| 444 | */ |
| 445 | public function getEventColumns() { |
| 446 | return array( |
| 447 | 'civicrm_event' => array( |
| 448 | 'dao' => 'CRM_Event_DAO_Event', |
| 449 | 'fields' => array( |
| 450 | 'id' => array( |
| 451 | 'no_display' => TRUE, |
| 452 | 'required' => TRUE, |
| 453 | ), |
| 454 | 'title' => array( |
| 455 | 'title' => ts('Event Title'), |
| 456 | 'required' => TRUE, |
| 457 | ), |
| 458 | 'event_type_id' => array( |
| 459 | 'title' => ts('Event Type'), |
| 460 | 'required' => TRUE, |
| 461 | 'alter_display' => 'alterEventType', |
| 462 | ), |
| 463 | 'fee_label' => array('title' => ts('Fee Label')), |
| 464 | 'event_start_date' => array( |
| 465 | 'title' => ts('Event Start Date'), |
| 466 | ), |
| 467 | 'event_end_date' => array('title' => ts('Event End Date')), |
| 468 | 'max_participants' => array( |
| 469 | 'title' => ts('Capacity'), |
| 470 | 'type' => CRM_Utils_Type::T_INT, |
| 471 | ), |
| 472 | ), |
| 473 | 'grouping' => 'event-fields', |
| 474 | 'filters' => array( |
| 475 | 'event_type_id' => array( |
| 476 | 'name' => 'event_type_id', |
| 477 | 'title' => ts('Event Type'), |
| 478 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 479 | 'options' => CRM_Core_OptionGroup::values('event_type'), |
| 480 | ), |
| 481 | 'event_title' => array( |
| 482 | 'name' => 'title', |
| 483 | 'title' => ts('Event Title'), |
| 484 | 'operatorType' => CRM_Report_Form::OP_STRING, |
| 485 | ), |
| 486 | ), |
| 487 | 'order_bys' => array( |
| 488 | 'event_type_id' => array( |
| 489 | 'title' => ts('Event Type'), |
| 490 | 'default_weight' => '2', |
| 491 | 'default_order' => 'ASC', |
| 492 | ), |
| 493 | ), |
| 494 | 'group_bys' => array( |
| 495 | 'event_type_id' => array( |
| 496 | 'title' => ts('Event Type'), |
| 497 | ), |
| 498 | ), |
| 499 | ), |
| 500 | ); |
| 501 | } |
| 502 | |
| 503 | /** |
| 504 | * @return array |
| 505 | */ |
| 506 | public function getContributionColumns() { |
| 507 | return array( |
| 508 | 'civicrm_contribution' => array( |
| 509 | 'dao' => 'CRM_Contribute_DAO_Contribution', |
| 510 | 'fields' => array( |
| 511 | 'contribution_id' => array( |
| 512 | 'name' => 'id', |
| 513 | ), |
| 514 | 'financial_type_id' => array( |
| 515 | 'title' => ts('Financial Type'), |
| 516 | 'default' => TRUE, |
| 517 | 'alter_display' => 'alterContributionType', |
| 518 | ), |
| 519 | 'payment_instrument_id' => array( |
| 520 | 'title' => ts('Payment Method'), |
| 521 | 'alter_display' => 'alterPaymentType', |
| 522 | ), |
| 523 | 'source' => array('title' => 'Contribution Source'), |
| 524 | 'trxn_id' => NULL, |
| 525 | 'receive_date' => array('default' => TRUE), |
| 526 | 'receipt_date' => NULL, |
| 527 | 'fee_amount' => NULL, |
| 528 | 'net_amount' => NULL, |
| 529 | 'total_amount' => array( |
| 530 | 'title' => ts('Amount'), |
| 531 | 'statistics' => array('sum' => ts('Total Amount')), |
| 532 | 'type' => CRM_Utils_Type::T_MONEY, |
| 533 | ), |
| 534 | ), |
| 535 | 'filters' => array( |
| 536 | 'receive_date' => array('operatorType' => CRM_Report_Form::OP_DATE), |
| 537 | 'financial_type_id' => array( |
| 538 | 'title' => ts('Financial Type'), |
| 539 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 540 | 'options' => CRM_Contribute_PseudoConstant::financialType(), |
| 541 | ), |
| 542 | 'payment_instrument_id' => array( |
| 543 | 'title' => ts('Payment Type'), |
| 544 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 545 | 'options' => CRM_Contribute_PseudoConstant::paymentInstrument(), |
| 546 | ), |
| 547 | 'contribution_status_id' => array( |
| 548 | 'title' => ts('Contribution Status'), |
| 549 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 550 | 'options' => CRM_Contribute_PseudoConstant::contributionStatus(), |
| 551 | ), |
| 552 | 'total_amount' => array('title' => ts('Contribution Amount')), |
| 553 | ), |
| 554 | 'order_bys' => array( |
| 555 | 'payment_instrument_id' => array( |
| 556 | 'title' => ts('Payment Method'), |
| 557 | ), |
| 558 | 'financial_type_id' => array( |
| 559 | 'title' => ts('Financial Type'), |
| 560 | ), |
| 561 | ), |
| 562 | 'group_bys' => array( |
| 563 | 'financial_type_id' => array('title' => ts('Financial Type')), |
| 564 | 'payment_instrument_id' => array('title' => ts('Payment Method')), |
| 565 | 'contribution_id' => array( |
| 566 | 'title' => ts('Individual Contribution'), |
| 567 | 'name' => 'id', |
| 568 | ), |
| 569 | 'source' => array('title' => 'Contribution Source'), |
| 570 | ), |
| 571 | 'grouping' => 'contribution-fields', |
| 572 | ), |
| 573 | ); |
| 574 | } |
| 575 | |
| 576 | /** |
| 577 | * @return array |
| 578 | */ |
| 579 | public function getContactColumns() { |
| 580 | return array( |
| 581 | 'civicrm_contact' => array( |
| 582 | 'dao' => 'CRM_Contact_DAO_Contact', |
| 583 | 'fields' => array( |
| 584 | 'display_name' => array( |
| 585 | 'title' => ts('Contact Name'), |
| 586 | ), |
| 587 | 'id' => array( |
| 588 | 'title' => ts('Contact ID'), |
| 589 | 'alter_display' => 'alterContactID', |
| 590 | ), |
| 591 | 'first_name' => array( |
| 592 | 'title' => ts('First Name'), |
| 593 | ), |
| 594 | 'last_name' => array( |
| 595 | 'title' => ts('Last Name'), |
| 596 | ), |
| 597 | 'nick_name' => array( |
| 598 | 'title' => ts('Nickname'), |
| 599 | 'alter_display' => 'alterNickname', |
| 600 | ), |
| 601 | ), |
| 602 | 'filters' => array( |
| 603 | 'id' => array( |
| 604 | 'title' => ts('Contact ID'), |
| 605 | ), |
| 606 | 'sort_name' => array( |
| 607 | 'title' => ts('Contact Name'), |
| 608 | ), |
| 609 | ), |
| 610 | 'grouping' => 'contact-fields', |
| 611 | 'order_bys' => array( |
| 612 | 'sort_name' => array( |
| 613 | 'title' => ts('Last Name, First Name'), |
| 614 | 'default' => '1', |
| 615 | 'default_weight' => '0', |
| 616 | 'default_order' => 'ASC', |
| 617 | ), |
| 618 | ), |
| 619 | ), |
| 620 | ); |
| 621 | } |
| 622 | |
| 623 | /** |
| 624 | * @return array |
| 625 | */ |
| 626 | public function getCaseColumns() { |
| 627 | return array( |
| 628 | 'civicrm_case' => array( |
| 629 | 'dao' => 'CRM_Case_DAO_Case', |
| 630 | 'fields' => array( |
| 631 | 'id' => array( |
| 632 | 'title' => ts('Case ID'), |
| 633 | 'required' => FALSE, |
| 634 | ), |
| 635 | 'subject' => array( |
| 636 | 'title' => ts('Case Subject'), |
| 637 | 'default' => TRUE, |
| 638 | ), |
| 639 | 'status_id' => array( |
| 640 | 'title' => ts('Status'), |
| 641 | 'default' => TRUE, |
| 642 | ), |
| 643 | 'case_type_id' => array( |
| 644 | 'title' => ts('Case Type'), |
| 645 | 'default' => TRUE, |
| 646 | ), |
| 647 | 'case_start_date' => array( |
| 648 | 'title' => ts('Case Start Date'), |
| 649 | 'name' => 'start_date', |
| 650 | 'default' => TRUE, |
| 651 | ), |
| 652 | 'case_end_date' => array( |
| 653 | 'title' => ts('Case End Date'), |
| 654 | 'name' => 'end_date', |
| 655 | 'default' => TRUE, |
| 656 | ), |
| 657 | 'case_duration' => array( |
| 658 | 'name' => 'duration', |
| 659 | 'title' => ts('Duration (Days)'), |
| 660 | 'default' => FALSE, |
| 661 | ), |
| 662 | 'case_is_deleted' => array( |
| 663 | 'name' => 'is_deleted', |
| 664 | 'title' => ts('Case Deleted?'), |
| 665 | 'default' => FALSE, |
| 666 | 'type' => CRM_Utils_Type::T_INT, |
| 667 | ), |
| 668 | ), |
| 669 | 'filters' => array( |
| 670 | 'case_start_date' => array( |
| 671 | 'title' => ts('Case Start Date'), |
| 672 | 'operatorType' => CRM_Report_Form::OP_DATE, |
| 673 | 'type' => CRM_Utils_Type::T_DATE, |
| 674 | 'name' => 'start_date', |
| 675 | ), |
| 676 | 'case_end_date' => array( |
| 677 | 'title' => ts('Case End Date'), |
| 678 | 'operatorType' => CRM_Report_Form::OP_DATE, |
| 679 | 'type' => CRM_Utils_Type::T_DATE, |
| 680 | 'name' => 'end_date', |
| 681 | ), |
| 682 | 'case_type_id' => array( |
| 683 | 'title' => ts('Case Type'), |
| 684 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 685 | 'options' => $this->case_types, |
| 686 | ), |
| 687 | 'case_status_id' => array( |
| 688 | 'title' => ts('Case Status'), |
| 689 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 690 | 'options' => $this->case_statuses, |
| 691 | 'name' => 'status_id', |
| 692 | ), |
| 693 | 'case_is_deleted' => array( |
| 694 | 'title' => ts('Case Deleted?'), |
| 695 | 'type' => CRM_Report_Form::OP_INT, |
| 696 | 'operatorType' => CRM_Report_Form::OP_SELECT, |
| 697 | 'options' => $this->deleted_labels, |
| 698 | 'default' => 0, |
| 699 | 'name' => 'is_deleted', |
| 700 | ), |
| 701 | ), |
| 702 | ), |
| 703 | ); |
| 704 | } |
| 705 | |
| 706 | /** |
| 707 | * Get address columns to add to array. |
| 708 | * |
| 709 | * @param array $options |
| 710 | * Options for the report. |
| 711 | * - prefix prefix to add (e.g. 'honor' when getting address details for honor contact |
| 712 | * - prefix_label optional prefix lable eg. "Honoree " for front end |
| 713 | * - group_by enable these fields for group by - default false |
| 714 | * - order_by enable these fields for order by |
| 715 | * - filters enable these fields for filtering |
| 716 | * - defaults - (is this working?) values to pre-populate |
| 717 | * |
| 718 | * @return array |
| 719 | * address columns definition |
| 720 | */ |
| 721 | public function getAddressColumns($options = array()) { |
| 722 | $defaultOptions = array( |
| 723 | 'prefix' => '', |
| 724 | 'prefix_label' => '', |
| 725 | 'group_by' => FALSE, |
| 726 | 'order_by' => TRUE, |
| 727 | 'filters' => TRUE, |
| 728 | 'defaults' => array( |
| 729 | 'country_id' => TRUE, |
| 730 | ), |
| 731 | ); |
| 732 | |
| 733 | $options = array_merge($defaultOptions, $options); |
| 734 | |
| 735 | $addressFields = array( |
| 736 | $options['prefix'] . 'civicrm_address' => array( |
| 737 | 'dao' => 'CRM_Core_DAO_Address', |
| 738 | 'name' => 'civicrm_address', |
| 739 | 'alias' => $options['prefix'] . 'civicrm_address', |
| 740 | 'fields' => array( |
| 741 | $options['prefix'] . 'name' => array( |
| 742 | 'title' => ts($options['prefix_label'] . 'Address Name'), |
| 743 | 'default' => CRM_Utils_Array::value('name', $options['defaults'], FALSE), |
| 744 | 'name' => 'name', |
| 745 | ), |
| 746 | $options['prefix'] . 'street_address' => array( |
| 747 | 'title' => ts($options['prefix_label'] . 'Street Address'), |
| 748 | 'default' => CRM_Utils_Array::value('street_address', $options['defaults'], FALSE), |
| 749 | 'name' => 'street_address', |
| 750 | ), |
| 751 | $options['prefix'] . 'supplemental_address_1' => array( |
| 752 | 'title' => ts($options['prefix_label'] . |
| 753 | 'Supplementary Address Field 1'), |
| 754 | 'default' => CRM_Utils_Array::value('supplemental_address_1', $options['defaults'], FALSE), |
| 755 | 'name' => 'supplemental_address_1', |
| 756 | ), |
| 757 | $options['prefix'] . 'supplemental_address_2' => array( |
| 758 | 'title' => ts($options['prefix_label'] . |
| 759 | 'Supplementary Address Field 2'), |
| 760 | 'default' => CRM_Utils_Array::value('supplemental_address_2', $options['defaults'], FALSE), |
| 761 | 'name' => 'supplemental_address_2', |
| 762 | ), |
| 763 | $options['prefix'] . 'street_number' => array( |
| 764 | 'name' => 'street_number', |
| 765 | 'title' => ts($options['prefix_label'] . 'Street Number'), |
| 766 | 'type' => 1, |
| 767 | 'default' => CRM_Utils_Array::value('street_number', $options['defaults'], FALSE), |
| 768 | ), |
| 769 | $options['prefix'] . 'street_name' => array( |
| 770 | 'name' => 'street_name', |
| 771 | 'title' => ts($options['prefix_label'] . 'Street Name'), |
| 772 | 'type' => 1, |
| 773 | 'default' => CRM_Utils_Array::value('street_name', $options['defaults'], FALSE), |
| 774 | ), |
| 775 | $options['prefix'] . 'street_unit' => array( |
| 776 | 'name' => 'street_unit', |
| 777 | 'title' => ts($options['prefix_label'] . 'Street Unit'), |
| 778 | 'type' => 1, |
| 779 | 'default' => CRM_Utils_Array::value('street_unit', $options['defaults'], FALSE), |
| 780 | ), |
| 781 | $options['prefix'] . 'city' => array( |
| 782 | 'title' => ts($options['prefix_label'] . 'City'), |
| 783 | 'default' => CRM_Utils_Array::value('city', $options['defaults'], FALSE), |
| 784 | 'name' => 'city', |
| 785 | ), |
| 786 | $options['prefix'] . 'postal_code' => array( |
| 787 | 'title' => ts($options['prefix_label'] . 'Postal Code'), |
| 788 | 'default' => CRM_Utils_Array::value('postal_code', $options['defaults'], FALSE), |
| 789 | 'name' => 'postal_code', |
| 790 | ), |
| 791 | $options['prefix'] . 'county_id' => array( |
| 792 | 'title' => ts($options['prefix_label'] . 'County'), |
| 793 | 'default' => CRM_Utils_Array::value('county_id', $options['defaults'], FALSE), |
| 794 | 'alter_display' => 'alterCountyID', |
| 795 | 'name' => 'county_id', |
| 796 | ), |
| 797 | $options['prefix'] . 'state_province_id' => array( |
| 798 | 'title' => ts($options['prefix_label'] . 'State/Province'), |
| 799 | 'default' => CRM_Utils_Array::value('state_province_id', $options['defaults'], FALSE), |
| 800 | 'alter_display' => 'alterStateProvinceID', |
| 801 | 'name' => 'state_province_id', |
| 802 | ), |
| 803 | $options['prefix'] . 'country_id' => array( |
| 804 | 'title' => ts($options['prefix_label'] . 'Country'), |
| 805 | 'default' => CRM_Utils_Array::value('country_id', $options['defaults'], FALSE), |
| 806 | 'alter_display' => 'alterCountryID', |
| 807 | 'name' => 'country_id', |
| 808 | ), |
| 809 | ), |
| 810 | 'grouping' => 'location-fields', |
| 811 | ), |
| 812 | ); |
| 813 | |
| 814 | if ($options['filters']) { |
| 815 | $addressFields[$options['prefix'] . 'civicrm_address']['filters'] = array( |
| 816 | $options['prefix'] . 'street_number' => array( |
| 817 | 'title' => ts($options['prefix_label'] . 'Street Number'), |
| 818 | 'type' => 1, |
| 819 | 'name' => 'street_number', |
| 820 | ), |
| 821 | $options['prefix'] . 'street_name' => array( |
| 822 | 'title' => ts($options['prefix_label'] . 'Street Name'), |
| 823 | 'name' => $options['prefix'] . 'street_name', |
| 824 | 'operator' => 'like', |
| 825 | ), |
| 826 | $options['prefix'] . 'postal_code' => array( |
| 827 | 'title' => ts($options['prefix_label'] . 'Postal Code'), |
| 828 | 'type' => 1, |
| 829 | 'name' => 'postal_code', |
| 830 | ), |
| 831 | $options['prefix'] . 'city' => array( |
| 832 | 'title' => ts($options['prefix_label'] . 'City'), |
| 833 | 'operator' => 'like', |
| 834 | 'name' => 'city', |
| 835 | ), |
| 836 | $options['prefix'] . 'county_id' => array( |
| 837 | 'name' => 'county_id', |
| 838 | 'title' => ts($options['prefix_label'] . 'County'), |
| 839 | 'type' => CRM_Utils_Type::T_INT, |
| 840 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 841 | 'options' => CRM_Core_PseudoConstant::county(), |
| 842 | ), |
| 843 | $options['prefix'] . 'state_province_id' => array( |
| 844 | 'name' => 'state_province_id', |
| 845 | 'title' => ts($options['prefix_label'] . 'State/Province'), |
| 846 | 'type' => CRM_Utils_Type::T_INT, |
| 847 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 848 | 'options' => CRM_Core_PseudoConstant::stateProvince(), |
| 849 | ), |
| 850 | $options['prefix'] . 'country_id' => array( |
| 851 | 'name' => 'country_id', |
| 852 | 'title' => ts($options['prefix_label'] . 'Country'), |
| 853 | 'type' => CRM_Utils_Type::T_INT, |
| 854 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
| 855 | 'options' => CRM_Core_PseudoConstant::country(), |
| 856 | ), |
| 857 | ); |
| 858 | } |
| 859 | |
| 860 | if ($options['order_by']) { |
| 861 | $addressFields[$options['prefix'] . |
| 862 | 'civicrm_address']['order_bys'] = array( |
| 863 | $options['prefix'] . 'street_name' => array( |
| 864 | 'title' => ts($options['prefix_label'] . 'Street Name'), |
| 865 | 'name' => 'street_name', |
| 866 | ), |
| 867 | $options['prefix'] . 'street_number' => array( |
| 868 | 'title' => ts($options['prefix_label'] . 'Odd / Even Street Number'), |
| 869 | 'name' => 'street_number', |
| 870 | ), |
| 871 | $options['prefix'] . 'street_address' => array( |
| 872 | 'title' => ts($options['prefix_label'] . 'Street Address'), |
| 873 | 'name' => 'street_address', |
| 874 | ), |
| 875 | $options['prefix'] . 'city' => array( |
| 876 | 'title' => ts($options['prefix_label'] . 'City'), |
| 877 | 'name' => 'city', |
| 878 | ), |
| 879 | $options['prefix'] . 'postal_code' => array( |
| 880 | 'title' => ts($options['prefix_label'] . 'Post Code'), |
| 881 | 'name' => 'postal_code', |
| 882 | ), |
| 883 | ); |
| 884 | } |
| 885 | |
| 886 | if ($options['group_by']) { |
| 887 | $addressFields['civicrm_address']['group_bys'] = array( |
| 888 | $options['prefix'] . 'street_address' => array( |
| 889 | 'title' => ts($options['prefix_label'] . 'Street Address'), |
| 890 | 'name' => 'street_address', |
| 891 | ), |
| 892 | $options['prefix'] . 'city' => array( |
| 893 | 'title' => ts($options['prefix_label'] . 'City'), |
| 894 | 'name' => 'city', |
| 895 | ), |
| 896 | $options['prefix'] . 'postal_code' => array( |
| 897 | 'title' => ts($options['prefix_label'] . 'Post Code'), |
| 898 | 'name' => 'postal_code', |
| 899 | ), |
| 900 | $options['prefix'] . 'state_province_id' => array( |
| 901 | 'title' => ts($options['prefix_label'] . 'State/Province'), |
| 902 | 'name' => 'state_province_id', |
| 903 | ), |
| 904 | $options['prefix'] . 'country_id' => array( |
| 905 | 'title' => ts($options['prefix_label'] . 'Country'), |
| 906 | 'name' => 'country_id', |
| 907 | ), |
| 908 | $options['prefix'] . 'county_id' => array( |
| 909 | 'title' => ts($options['prefix_label'] . 'County'), |
| 910 | 'name' => 'county_id', |
| 911 | ), |
| 912 | ); |
| 913 | } |
| 914 | return $addressFields; |
| 915 | } |
| 916 | |
| 917 | /** |
| 918 | * Get Information about advertised Joins. |
| 919 | * |
| 920 | * @return array |
| 921 | */ |
| 922 | public function getAvailableJoins() { |
| 923 | return array( |
| 924 | 'priceFieldValue_from_lineItem' => array( |
| 925 | 'leftTable' => 'civicrm_line_item', |
| 926 | 'rightTable' => 'civicrm_price_field_value', |
| 927 | 'callback' => 'joinPriceFieldValueFromLineItem', |
| 928 | ), |
| 929 | 'priceField_from_lineItem' => array( |
| 930 | 'leftTable' => 'civicrm_line_item', |
| 931 | 'rightTable' => 'civicrm_price_field', |
| 932 | 'callback' => 'joinPriceFieldFromLineItem', |
| 933 | ), |
| 934 | 'participant_from_lineItem' => array( |
| 935 | 'leftTable' => 'civicrm_line_item', |
| 936 | 'rightTable' => 'civicrm_participant', |
| 937 | 'callback' => 'joinParticipantFromLineItem', |
| 938 | ), |
| 939 | 'contribution_from_lineItem' => array( |
| 940 | 'leftTable' => 'civicrm_line_item', |
| 941 | 'rightTable' => 'civicrm_contribution', |
| 942 | 'callback' => 'joinContributionFromLineItem', |
| 943 | ), |
| 944 | 'membership_from_lineItem' => array( |
| 945 | 'leftTable' => 'civicrm_line_item', |
| 946 | 'rightTable' => 'civicrm_membership', |
| 947 | 'callback' => 'joinMembershipFromLineItem', |
| 948 | ), |
| 949 | 'contribution_from_participant' => array( |
| 950 | 'leftTable' => 'civicrm_participant', |
| 951 | 'rightTable' => 'civicrm_contribution', |
| 952 | 'callback' => 'joinContributionFromParticipant', |
| 953 | ), |
| 954 | 'contribution_from_membership' => array( |
| 955 | 'leftTable' => 'civicrm_membership', |
| 956 | 'rightTable' => 'civicrm_contribution', |
| 957 | 'callback' => 'joinContributionFromMembership', |
| 958 | ), |
| 959 | 'membership_from_contribution' => array( |
| 960 | 'leftTable' => 'civicrm_contribution', |
| 961 | 'rightTable' => 'civicrm_membership', |
| 962 | 'callback' => 'joinMembershipFromContribution', |
| 963 | ), |
| 964 | 'membershipType_from_membership' => array( |
| 965 | 'leftTable' => 'civicrm_membership', |
| 966 | 'rightTable' => 'civicrm_membership_type', |
| 967 | 'callback' => 'joinMembershipTypeFromMembership', |
| 968 | ), |
| 969 | 'lineItem_from_contribution' => array( |
| 970 | 'leftTable' => 'civicrm_contribution', |
| 971 | 'rightTable' => 'civicrm_line_item', |
| 972 | 'callback' => 'joinLineItemFromContribution', |
| 973 | ), |
| 974 | 'lineItem_from_membership' => array( |
| 975 | 'leftTable' => 'civicrm_membership', |
| 976 | 'rightTable' => 'civicrm_line_item', |
| 977 | 'callback' => 'joinLineItemFromMembership', |
| 978 | ), |
| 979 | 'contact_from_participant' => array( |
| 980 | 'leftTable' => 'civicrm_participant', |
| 981 | 'rightTable' => 'civicrm_contact', |
| 982 | 'callback' => 'joinContactFromParticipant', |
| 983 | ), |
| 984 | 'contact_from_membership' => array( |
| 985 | 'leftTable' => 'civicrm_membership', |
| 986 | 'rightTable' => 'civicrm_contact', |
| 987 | 'callback' => 'joinContactFromMembership', |
| 988 | ), |
| 989 | 'contact_from_contribution' => array( |
| 990 | 'leftTable' => 'civicrm_contribution', |
| 991 | 'rightTable' => 'civicrm_contact', |
| 992 | 'callback' => 'joinContactFromContribution', |
| 993 | ), |
| 994 | 'event_from_participant' => array( |
| 995 | 'leftTable' => 'civicrm_participant', |
| 996 | 'rightTable' => 'civicrm_event', |
| 997 | 'callback' => 'joinEventFromParticipant', |
| 998 | ), |
| 999 | 'address_from_contact' => array( |
| 1000 | 'leftTable' => 'civicrm_contact', |
| 1001 | 'rightTable' => 'civicrm_address', |
| 1002 | 'callback' => 'joinAddressFromContact', |
| 1003 | ), |
| 1004 | ); |
| 1005 | } |
| 1006 | |
| 1007 | /** |
| 1008 | * Add join from contact table to address. Prefix will be added to both tables |
| 1009 | * as it's assumed you are using it to get address of a secondary contact |
| 1010 | * |
| 1011 | * @param string $prefix |
| 1012 | */ |
| 1013 | public function joinAddressFromContact($prefix = '') { |
| 1014 | $this->_from .= " LEFT JOIN civicrm_address {$this->_aliases[$prefix . |
| 1015 | 'civicrm_address']} |
| 1016 | ON {$this->_aliases[$prefix . |
| 1017 | 'civicrm_address']}.contact_id = {$this->_aliases[$prefix . |
| 1018 | 'civicrm_contact']}.id"; |
| 1019 | } |
| 1020 | |
| 1021 | public function joinPriceFieldValueFromLineItem() { |
| 1022 | $this->_from .= " LEFT JOIN civicrm_price_field_value {$this->_aliases['civicrm_price_field_value']} |
| 1023 | ON {$this->_aliases['civicrm_line_item']}.price_field_value_id = {$this->_aliases['civicrm_price_field_value']}.id"; |
| 1024 | } |
| 1025 | |
| 1026 | public function joinPriceFieldFromLineItem() { |
| 1027 | $this->_from .= " |
| 1028 | LEFT JOIN civicrm_price_field {$this->_aliases['civicrm_price_field']} |
| 1029 | ON {$this->_aliases['civicrm_line_item']}.price_field_id = {$this->_aliases['civicrm_price_field']}.id |
| 1030 | "; |
| 1031 | } |
| 1032 | |
| 1033 | /** |
| 1034 | * Define join from line item table to participant table. |
| 1035 | */ |
| 1036 | public function joinParticipantFromLineItem() { |
| 1037 | $this->_from .= " LEFT JOIN civicrm_participant {$this->_aliases['civicrm_participant']} |
| 1038 | ON ( {$this->_aliases['civicrm_line_item']}.entity_id = {$this->_aliases['civicrm_participant']}.id |
| 1039 | AND {$this->_aliases['civicrm_line_item']}.entity_table = 'civicrm_participant') |
| 1040 | "; |
| 1041 | } |
| 1042 | |
| 1043 | /** |
| 1044 | * Define join from line item table to Membership table. Seems to be still via contribution |
| 1045 | * as the entity. Have made 'inner' to restrict does that make sense? |
| 1046 | */ |
| 1047 | public function joinMembershipFromLineItem() { |
| 1048 | $this->_from .= " INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
| 1049 | ON ( {$this->_aliases['civicrm_line_item']}.entity_id = {$this->_aliases['civicrm_contribution']}.id |
| 1050 | AND {$this->_aliases['civicrm_line_item']}.entity_table = 'civicrm_contribution') |
| 1051 | LEFT JOIN civicrm_membership_payment pp |
| 1052 | ON {$this->_aliases['civicrm_contribution']}.id = pp.contribution_id |
| 1053 | LEFT JOIN civicrm_membership {$this->_aliases['civicrm_membership']} |
| 1054 | ON pp.membership_id = {$this->_aliases['civicrm_membership']}.id |
| 1055 | "; |
| 1056 | } |
| 1057 | |
| 1058 | /** |
| 1059 | * Define join from Participant to Contribution table. |
| 1060 | */ |
| 1061 | public function joinContributionFromParticipant() { |
| 1062 | $this->_from .= " LEFT JOIN civicrm_participant_payment pp |
| 1063 | ON {$this->_aliases['civicrm_participant']}.id = pp.participant_id |
| 1064 | LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
| 1065 | ON pp.contribution_id = {$this->_aliases['civicrm_contribution']}.id |
| 1066 | "; |
| 1067 | } |
| 1068 | |
| 1069 | /** |
| 1070 | * Define join from Membership to Contribution table. |
| 1071 | */ |
| 1072 | public function joinContributionFromMembership() { |
| 1073 | $this->_from .= " LEFT JOIN civicrm_membership_payment pp |
| 1074 | ON {$this->_aliases['civicrm_membership']}.id = pp.membership_id |
| 1075 | LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
| 1076 | ON pp.contribution_id = {$this->_aliases['civicrm_contribution']}.id |
| 1077 | "; |
| 1078 | } |
| 1079 | |
| 1080 | public function joinParticipantFromContribution() { |
| 1081 | $this->_from .= " LEFT JOIN civicrm_participant_payment pp |
| 1082 | ON {$this->_aliases['civicrm_contribution']}.id = pp.contribution_id |
| 1083 | LEFT JOIN civicrm_participant {$this->_aliases['civicrm_participant']} |
| 1084 | ON pp.participant_id = {$this->_aliases['civicrm_participant']}.id"; |
| 1085 | } |
| 1086 | |
| 1087 | public function joinMembershipFromContribution() { |
| 1088 | $this->_from .= " |
| 1089 | LEFT JOIN civicrm_membership_payment pp |
| 1090 | ON {$this->_aliases['civicrm_contribution']}.id = pp.contribution_id |
| 1091 | LEFT JOIN civicrm_membership {$this->_aliases['civicrm_membership']} |
| 1092 | ON pp.membership_id = {$this->_aliases['civicrm_membership']}.id"; |
| 1093 | } |
| 1094 | |
| 1095 | public function joinMembershipTypeFromMembership() { |
| 1096 | $this->_from .= " |
| 1097 | LEFT JOIN civicrm_membership_type {$this->_aliases['civicrm_membership_type']} |
| 1098 | ON {$this->_aliases['civicrm_membership']}.membership_type_id = {$this->_aliases['civicrm_membership_type']}.id |
| 1099 | "; |
| 1100 | } |
| 1101 | |
| 1102 | public function joinContributionFromLineItem() { |
| 1103 | |
| 1104 | // this can be stored as a temp table & indexed for more speed. Not done at this state. |
| 1105 | // another option is to cache it but I haven't tried to put that code in yet (have used it before for one hour caching |
| 1106 | $this->_from .= " LEFT JOIN (SELECT line_item_civireport.id as lid, contribution_civireport_direct.* |
| 1107 | FROM civicrm_line_item line_item_civireport |
| 1108 | LEFT JOIN civicrm_contribution contribution_civireport_direct |
| 1109 | ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = contribution_civireport_direct.id AND line_item_civireport.entity_table = 'civicrm_contribution') |
| 1110 | |
| 1111 | |
| 1112 | WHERE contribution_civireport_direct.id IS NOT NULL |
| 1113 | |
| 1114 | UNION SELECT line_item_civireport.id as lid, contribution_civireport.* |
| 1115 | FROM civicrm_line_item line_item_civireport |
| 1116 | LEFT JOIN civicrm_participant participant_civireport |
| 1117 | ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = participant_civireport.id AND line_item_civireport.entity_table = 'civicrm_participant') |
| 1118 | |
| 1119 | LEFT JOIN civicrm_participant_payment pp |
| 1120 | ON participant_civireport.id = pp.participant_id |
| 1121 | LEFT JOIN civicrm_contribution contribution_civireport |
| 1122 | ON pp.contribution_id = contribution_civireport.id |
| 1123 | |
| 1124 | UNION SELECT line_item_civireport.id as lid,contribution_civireport.* |
| 1125 | FROM civicrm_line_item line_item_civireport |
| 1126 | LEFT JOIN civicrm_membership membership_civireport |
| 1127 | ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id =membership_civireport.id AND line_item_civireport.entity_table = 'civicrm_membership') |
| 1128 | |
| 1129 | LEFT JOIN civicrm_membership_payment pp |
| 1130 | ON membership_civireport.id = pp.membership_id |
| 1131 | LEFT JOIN civicrm_contribution contribution_civireport |
| 1132 | ON pp.contribution_id = contribution_civireport.id |
| 1133 | ) as {$this->_aliases['civicrm_contribution']} |
| 1134 | ON {$this->_aliases['civicrm_contribution']}.lid = {$this->_aliases['civicrm_line_item']}.id |
| 1135 | "; |
| 1136 | } |
| 1137 | |
| 1138 | public function joinLineItemFromContribution() { |
| 1139 | |
| 1140 | // this can be stored as a temp table & indexed for more speed. Not done at this stage. |
| 1141 | // another option is to cache it but I haven't tried to put that code in yet (have used it before for one hour caching |
| 1142 | $this->_from .= " |
| 1143 | LEFT JOIN ( |
| 1144 | SELECT contribution_civireport_direct.id AS contid, line_item_civireport.* |
| 1145 | FROM civicrm_contribution contribution_civireport_direct |
| 1146 | LEFT JOIN civicrm_line_item line_item_civireport ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = contribution_civireport_direct.id AND line_item_civireport.entity_table = 'civicrm_contribution') |
| 1147 | WHERE line_item_civireport.id IS NOT NULL |
| 1148 | |
| 1149 | UNION |
| 1150 | SELECT contribution_civireport_direct.id AS contid, line_item_civireport.* |
| 1151 | FROM civicrm_contribution contribution_civireport_direct |
| 1152 | LEFT JOIN civicrm_participant_payment pp ON contribution_civireport_direct.id = pp.contribution_id |
| 1153 | LEFT JOIN civicrm_participant p ON pp.participant_id = p.id |
| 1154 | LEFT JOIN civicrm_line_item line_item_civireport ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = p.id AND line_item_civireport.entity_table = 'civicrm_participant') |
| 1155 | WHERE line_item_civireport.id IS NOT NULL |
| 1156 | |
| 1157 | UNION |
| 1158 | |
| 1159 | SELECT contribution_civireport_direct.id AS contid, line_item_civireport.* |
| 1160 | FROM civicrm_contribution contribution_civireport_direct |
| 1161 | LEFT JOIN civicrm_membership_payment pp ON contribution_civireport_direct.id = pp.contribution_id |
| 1162 | LEFT JOIN civicrm_membership p ON pp.membership_id = p.id |
| 1163 | LEFT JOIN civicrm_line_item line_item_civireport ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = p.id AND line_item_civireport.entity_table = 'civicrm_membership') |
| 1164 | WHERE line_item_civireport.id IS NOT NULL |
| 1165 | ) as {$this->_aliases['civicrm_line_item']} |
| 1166 | ON {$this->_aliases['civicrm_line_item']}.contid = {$this->_aliases['civicrm_contribution']}.id |
| 1167 | |
| 1168 | |
| 1169 | "; |
| 1170 | } |
| 1171 | |
| 1172 | public function joinLineItemFromMembership() { |
| 1173 | |
| 1174 | // this can be stored as a temp table & indexed for more speed. Not done at this stage. |
| 1175 | // another option is to cache it but I haven't tried to put that code in yet (have used it before for one hour caching |
| 1176 | $this->_from .= " |
| 1177 | LEFT JOIN ( |
| 1178 | SELECT contribution_civireport_direct.id AS contid, line_item_civireport.* |
| 1179 | FROM civicrm_contribution contribution_civireport_direct |
| 1180 | LEFT JOIN civicrm_line_item line_item_civireport |
| 1181 | ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = contribution_civireport_direct.id AND line_item_civireport.entity_table = 'civicrm_contribution') |
| 1182 | |
| 1183 | WHERE line_item_civireport.id IS NOT NULL |
| 1184 | |
| 1185 | UNION |
| 1186 | |
| 1187 | SELECT contribution_civireport_direct.id AS contid, line_item_civireport.* |
| 1188 | FROM civicrm_contribution contribution_civireport_direct |
| 1189 | LEFT JOIN civicrm_membership_payment pp ON contribution_civireport_direct.id = pp.contribution_id |
| 1190 | LEFT JOIN civicrm_membership p ON pp.membership_id = p.id |
| 1191 | LEFT JOIN civicrm_line_item line_item_civireport ON (line_item_civireport.line_total > 0 AND line_item_civireport.entity_id = p.id AND line_item_civireport.entity_table = 'civicrm_membership') |
| 1192 | WHERE line_item_civireport.id IS NOT NULL |
| 1193 | ) as {$this->_aliases['civicrm_line_item']} |
| 1194 | ON {$this->_aliases['civicrm_line_item']}.contid = {$this->_aliases['civicrm_contribution']}.id |
| 1195 | "; |
| 1196 | } |
| 1197 | |
| 1198 | public function joinContactFromParticipant() { |
| 1199 | $this->_from .= " LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} |
| 1200 | ON {$this->_aliases['civicrm_participant']}.contact_id = {$this->_aliases['civicrm_contact']}.id"; |
| 1201 | } |
| 1202 | |
| 1203 | public function joinContactFromMembership() { |
| 1204 | $this->_from .= " LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} |
| 1205 | ON {$this->_aliases['civicrm_membership']}.contact_id = {$this->_aliases['civicrm_contact']}.id"; |
| 1206 | } |
| 1207 | |
| 1208 | public function joinContactFromContribution() { |
| 1209 | $this->_from .= " LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} |
| 1210 | ON {$this->_aliases['civicrm_contribution']}.contact_id = {$this->_aliases['civicrm_contact']}.id"; |
| 1211 | } |
| 1212 | |
| 1213 | public function joinEventFromParticipant() { |
| 1214 | $this->_from .= " LEFT JOIN civicrm_event {$this->_aliases['civicrm_event']} |
| 1215 | ON ({$this->_aliases['civicrm_event']}.id = {$this->_aliases['civicrm_participant']}.event_id ) AND |
| 1216 | ({$this->_aliases['civicrm_event']}.is_template IS NULL OR |
| 1217 | {$this->_aliases['civicrm_event']}.is_template = 0)"; |
| 1218 | } |
| 1219 | |
| 1220 | /** |
| 1221 | * Retrieve text for financial type from pseudoconstant. |
| 1222 | * |
| 1223 | * @param $value |
| 1224 | * @param array $row |
| 1225 | * |
| 1226 | * @return string |
| 1227 | */ |
| 1228 | public function alterNickName($value, &$row) { |
| 1229 | if (empty($row['civicrm_contact_id'])) { |
| 1230 | return NULL; |
| 1231 | } |
| 1232 | $contactID = $row['civicrm_contact_id']; |
| 1233 | return "<div id=contact-{$contactID} class='crm-entity'> |
| 1234 | <span class='crm-editable crmf-nick_name crm-editable-enabled'> |
| 1235 | " . $value . "</span></div>"; |
| 1236 | } |
| 1237 | |
| 1238 | /** |
| 1239 | * Retrieve text for contribution type from pseudoconstant. |
| 1240 | * |
| 1241 | * @param $value |
| 1242 | * @param array $row |
| 1243 | * |
| 1244 | * @return array|string |
| 1245 | */ |
| 1246 | public function alterContributionType($value, &$row) { |
| 1247 | return is_string(CRM_Contribute_PseudoConstant::financialType($value, FALSE)) ? CRM_Contribute_PseudoConstant::financialType($value, FALSE) : ''; |
| 1248 | } |
| 1249 | |
| 1250 | /** |
| 1251 | * Retrieve text for contribution status from pseudoconstant. |
| 1252 | * |
| 1253 | * @param $value |
| 1254 | * @param array $row |
| 1255 | * |
| 1256 | * @return array |
| 1257 | */ |
| 1258 | public function alterContributionStatus($value, &$row) { |
| 1259 | return CRM_Contribute_PseudoConstant::contributionStatus($value); |
| 1260 | } |
| 1261 | |
| 1262 | /** |
| 1263 | * Retrieve text for payment instrument from pseudoconstant. |
| 1264 | * |
| 1265 | * @param $value |
| 1266 | * @param array $row |
| 1267 | * |
| 1268 | * @return array |
| 1269 | */ |
| 1270 | public function alterEventType($value, &$row) { |
| 1271 | return CRM_Event_PseudoConstant::eventType($value); |
| 1272 | } |
| 1273 | |
| 1274 | /** |
| 1275 | * @param $value |
| 1276 | * @param array $row |
| 1277 | * |
| 1278 | * @return array|string |
| 1279 | */ |
| 1280 | public function alterEventID($value, &$row) { |
| 1281 | return is_string(CRM_Event_PseudoConstant::event($value, FALSE)) ? CRM_Event_PseudoConstant::event($value, FALSE) : ''; |
| 1282 | } |
| 1283 | |
| 1284 | /** |
| 1285 | * @param $value |
| 1286 | * @param array $row |
| 1287 | * |
| 1288 | * @return array|string |
| 1289 | */ |
| 1290 | public function alterMembershipTypeID($value, &$row) { |
| 1291 | return is_string(CRM_Member_PseudoConstant::membershipType($value, FALSE)) ? CRM_Member_PseudoConstant::membershipType($value, FALSE) : ''; |
| 1292 | } |
| 1293 | |
| 1294 | /** |
| 1295 | * @param $value |
| 1296 | * @param array $row |
| 1297 | * |
| 1298 | * @return array|string |
| 1299 | */ |
| 1300 | public function alterMembershipStatusID($value, &$row) { |
| 1301 | return is_string(CRM_Member_PseudoConstant::membershipStatus($value, FALSE)) ? CRM_Member_PseudoConstant::membershipStatus($value, FALSE) : ''; |
| 1302 | } |
| 1303 | |
| 1304 | /** |
| 1305 | * @param $value |
| 1306 | * @param array $row |
| 1307 | * @param $selectedfield |
| 1308 | * @param string $criteriaFieldName |
| 1309 | * |
| 1310 | * @return array |
| 1311 | */ |
| 1312 | public function alterCountryID($value, &$row, $selectedfield, $criteriaFieldName) { |
| 1313 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); |
| 1314 | $row[$selectedfield . '_link'] = $url; |
| 1315 | $row[$selectedfield . |
| 1316 | '_hover'] = ts("%1 for this country.", array(1 => $value)); |
| 1317 | $countries = CRM_Core_PseudoConstant::country($value, FALSE); |
| 1318 | if (!is_array($countries)) { |
| 1319 | return $countries; |
| 1320 | } |
| 1321 | } |
| 1322 | |
| 1323 | /** |
| 1324 | * @param $value |
| 1325 | * @param array $row |
| 1326 | * @param $selectedfield |
| 1327 | * @param string $criteriaFieldName |
| 1328 | * |
| 1329 | * @return array |
| 1330 | */ |
| 1331 | public function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) { |
| 1332 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); |
| 1333 | $row[$selectedfield . '_link'] = $url; |
| 1334 | $row[$selectedfield . |
| 1335 | '_hover'] = ts("%1 for this county.", array(1 => $value)); |
| 1336 | $counties = CRM_Core_PseudoConstant::county($value, FALSE); |
| 1337 | if (!is_array($counties)) { |
| 1338 | return $counties; |
| 1339 | } |
| 1340 | } |
| 1341 | |
| 1342 | /** |
| 1343 | * @param $value |
| 1344 | * @param array $row |
| 1345 | * @param $selectedfield |
| 1346 | * @param string $criteriaFieldName |
| 1347 | * |
| 1348 | * @return array |
| 1349 | */ |
| 1350 | public function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) { |
| 1351 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); |
| 1352 | $row[$selectedfield . '_link'] = $url; |
| 1353 | $row[$selectedfield . |
| 1354 | '_hover'] = ts("%1 for this state.", array(1 => $value)); |
| 1355 | |
| 1356 | $states = CRM_Core_PseudoConstant::stateProvince($value, FALSE); |
| 1357 | if (!is_array($states)) { |
| 1358 | return $states; |
| 1359 | } |
| 1360 | } |
| 1361 | |
| 1362 | /** |
| 1363 | * @param $value |
| 1364 | * @param array $row |
| 1365 | * @param string $fieldname |
| 1366 | * |
| 1367 | * @return mixed |
| 1368 | */ |
| 1369 | public function alterContactID($value, &$row, $fieldname) { |
| 1370 | $row[$fieldname . '_link'] = CRM_Utils_System::url("civicrm/contact/view", |
| 1371 | 'reset=1&cid=' . $value, $this->_absoluteUrl); |
| 1372 | return $value; |
| 1373 | } |
| 1374 | |
| 1375 | /** |
| 1376 | * @param $value |
| 1377 | * |
| 1378 | * @return array |
| 1379 | */ |
| 1380 | public function alterParticipantStatus($value) { |
| 1381 | if (empty($value)) { |
| 1382 | return NULL; |
| 1383 | } |
| 1384 | return CRM_Event_PseudoConstant::participantStatus($value, FALSE, 'label'); |
| 1385 | } |
| 1386 | |
| 1387 | /** |
| 1388 | * @param $value |
| 1389 | * |
| 1390 | * @return string|void |
| 1391 | */ |
| 1392 | public function alterParticipantRole($value) { |
| 1393 | if (empty($value)) { |
| 1394 | return NULL; |
| 1395 | } |
| 1396 | $roles = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); |
| 1397 | $value = array(); |
| 1398 | foreach ($roles as $role) { |
| 1399 | $value[$role] = CRM_Event_PseudoConstant::participantRole($role, FALSE); |
| 1400 | } |
| 1401 | return implode(', ', $value); |
| 1402 | } |
| 1403 | |
| 1404 | /** |
| 1405 | * @param $value |
| 1406 | * |
| 1407 | * @return mixed |
| 1408 | */ |
| 1409 | public function alterPaymentType($value) { |
| 1410 | $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument(); |
| 1411 | return $paymentInstruments[$value]; |
| 1412 | } |
| 1413 | |
| 1414 | } |