3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Report_Form_Contribute_Lybunt
extends CRM_Report_Form
{
38 protected $_charts = array(
40 'barChart' => 'Bar Chart',
41 'pieChart' => 'Pie Chart',
44 public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report');
46 protected $lifeTime_from = NULL;
47 protected $lifeTime_where = NULL;
55 function __construct() {
58 $date = CRM_Core_SelectValues
::date('custom', NULL, $yearsInPast, $yearsInFuture);
59 $count = $date['maxYear'];
60 while ($date['minYear'] <= $count) {
61 $optionYear[$date['minYear']] = $date['minYear'];
65 // Check if CiviCampaign is a) enabled and b) has active campaigns
66 $config = CRM_Core_Config
::singleton();
67 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
68 if ($campaignEnabled) {
69 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
70 $this->activeCampaigns
= $getCampaigns['campaigns'];
71 asort($this->activeCampaigns
);
74 $this->_columns
= array(
77 'dao' => 'CRM_Contact_DAO_Contact',
78 'grouping' => 'contact-field',
82 array('title' => ts('Donor Name'),
86 'first_name' => array(
87 'title' => ts('First Name'),
90 'title' => ts('Last Name'),
94 'title' => ts('Contact Type'),
98 'title' => ts('Contact SubType'),
104 array('title' => ts('Donor Name'),
105 'operator' => 'like',
111 'dao' => 'CRM_Core_DAO_Email',
112 'grouping' => 'contact-field',
116 array('title' => ts('Email'),
123 'dao' => 'CRM_Core_DAO_Phone',
124 'grouping' => 'contact-field',
128 array('title' => ts('Phone'),
134 +
$this->addAddressFields()
136 'civicrm_contribution' =>
138 'dao' => 'CRM_Contribute_DAO_Contribution',
142 array('title' => ts('contactId'),
143 'no_display' => TRUE,
148 array('title' => ts('Total Amount'),
149 'no_display' => TRUE,
154 array('title' => ts('Year'),
155 'no_display' => TRUE,
164 'name' => 'receive_date',
165 'title' => ts('This Year'),
166 'operatorType' => CRM_Report_Form
::OP_SELECT
,
167 'options' => $optionYear,
168 'default' => date('Y'),
170 'financial_type_id' => array(
171 'title' => ts('Financial Type'),
172 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
173 'options' => CRM_Contribute_PseudoConstant
::financialType(),
175 'contribution_status_id' =>
176 array('title' => ts('Contribution Status'),
177 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
178 'options' => CRM_Contribute_PseudoConstant
::contributionStatus(),
179 'default' => array('1'),
185 'dao' => 'CRM_Contact_DAO_GroupContact',
191 'name' => 'group_id',
192 'title' => ts('Group'),
193 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
195 'options' => CRM_Core_PseudoConstant
::group(),
201 // If we have a campaign, build out the relevant elements
202 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
203 $this->_columns
['civicrm_contribution']['fields']['campaign_id'] = array(
204 'title' => ts('Campaign'),
205 'default' => 'false',
207 $this->_columns
['civicrm_contribution']['filters']['campaign_id'] = array('title' => ts('Campaign'),
208 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
209 'options' => $this->activeCampaigns
,
213 $this->_tagFilter
= TRUE;
214 parent
::__construct();
217 function preProcess() {
218 parent
::preProcess();
223 $this->_columnHeaders
= $select = array();
224 $current_year = $this->_params
['yid_value'];
225 $previous_year = $current_year - 1;
228 foreach ($this->_columns
as $tableName => $table) {
230 if (array_key_exists('fields', $table)) {
231 foreach ($table['fields'] as $fieldName => $field) {
233 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
234 if ($fieldName == 'total_amount') {
235 $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}";
237 $this->_columnHeaders
["{$previous_year}"]['type'] = $field['type'];
238 $this->_columnHeaders
["{$previous_year}"]['title'] = $previous_year;
240 $this->_columnHeaders
["civicrm_life_time_total"]['type'] = $field['type'];
241 $this->_columnHeaders
["civicrm_life_time_total"]['title'] = 'LifeTime';;
243 elseif ($fieldName == 'receive_date') {
244 $select[] = self
::fiscalYearOffset($field['dbAlias']) . " as {$tableName}_{$fieldName} ";
247 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName} ";
248 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
249 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
252 if (!empty($field['no_display'])) {
253 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['no_display'] = TRUE;
260 $this->_select
= "SELECT " . implode(', ', $select) . " ";
266 FROM civicrm_contribution {$this->_aliases['civicrm_contribution']}
267 INNER JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
268 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id
271 if ($this->isTableSelected('civicrm_email')) {
273 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
274 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
275 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
277 if ($this->isTableSelected('civicrm_phone')) {
279 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
280 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
281 {$this->_aliases['civicrm_phone']}.is_primary = 1";
283 $this->addAddressFromClause();
287 $this->_statusClause
= "";
288 $clauses = array($this->_aliases
['civicrm_contribution'] . '.is_test = 0');
289 $current_year = $this->_params
['yid_value'];
290 $previous_year = $current_year - 1;
292 foreach ($this->_columns
as $tableName => $table) {
293 if (array_key_exists('filters', $table)) {
294 foreach ($table['filters'] as $fieldName => $field) {
296 if ($fieldName == 'yid') {
297 $clause = "contribution_civireport.contact_id NOT IN
298 (SELECT distinct contri.contact_id FROM civicrm_contribution contri
299 WHERE contri.is_test = 0 AND " . self
::fiscalYearOffset('contri.receive_date') . " = $current_year) AND contribution_civireport.contact_id IN (SELECT distinct contri.contact_id FROM civicrm_contribution contri
300 WHERE " . self
::fiscalYearOffset('contri.receive_date') . " = $previous_year AND contri.is_test = 0)";
302 elseif (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
303 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
304 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
305 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
307 if ($relative ||
$from ||
$to) {
308 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
312 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
314 $clause = $this->whereClause($field,
316 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
317 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
318 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
320 if (($fieldName == 'contribution_status_id' ||
$fieldName == 'financial_type_id') && !empty($clause)) {
321 $this->_statusClause
.= " AND " . $clause;
326 if (!empty($clause)) {
327 $clauses[] = $clause;
333 $this->_where
= 'WHERE ' . implode(' AND ', $clauses);
335 if ($this->_aclWhere
) {
336 $this->_where
.= " AND {$this->_aclWhere} ";
341 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_contribution']}.contact_id, " . self
::fiscalYearOffset($this->_aliases
['civicrm_contribution'] . '.receive_date') . " WITH ROLLUP";
342 $this->assign('chartSupported', TRUE);
350 function statistics(&$rows) {
351 $statistics = parent
::statistics($rows);
355 SUM({$this->_aliases['civicrm_contribution']}.total_amount ) as amount ";
357 $sql = "{$select} {$this->_from} {$this->_where}";
358 $dao = CRM_Core_DAO
::executeQuery($sql);
360 $statistics['counts']['amount'] = array(
361 'value' => $dao->amount
,
362 'title' => 'Total LifeTime',
363 'type' => CRM_Utils_Type
::T_MONEY
,
371 function postProcess() {
373 // get ready with post process params
374 $this->beginPostProcess();
376 // get the acl clauses built before we assemble the query
377 $this->buildACLClause($this->_aliases
['civicrm_contact']);
383 $rows = $contactIds = array();
384 if (empty($this->_params
['charts'])) {
386 $getContacts = "SELECT SQL_CALC_FOUND_ROWS {$this->_aliases['civicrm_contact']}.id as cid {$this->_from} {$this->_where} GROUP BY {$this->_aliases['civicrm_contact']}.id {$this->_limit}";
388 $dao = CRM_Core_DAO
::executeQuery($getContacts);
390 while ($dao->fetch()) {
391 $contactIds[] = $dao->cid
;
397 if (!empty($contactIds) ||
!empty($this->_params
['charts'])) {
398 if (!empty($this->_params
['charts'])) {
399 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy}";
402 $sql = "{$this->_select} {$this->_from} WHERE {$this->_aliases['civicrm_contact']}.id IN (" . implode(',', $contactIds) . ") AND {$this->_aliases['civicrm_contribution']}.is_test = 0 {$this->_statusClause} {$this->_groupBy} ";
405 $dao = CRM_Core_DAO
::executeQuery($sql);
406 $current_year = $this->_params
['yid_value'];
407 $previous_year = $current_year - 1;
409 while ($dao->fetch()) {
411 if (!$dao->civicrm_contribution_contact_id
) {
416 foreach ($this->_columnHeaders
as $key => $value) {
417 if (property_exists($dao, $key)) {
418 $rows[$dao->civicrm_contribution_contact_id
][$key] = $dao->$key;
422 if ($dao->civicrm_contribution_receive_date
) {
423 if ($dao->civicrm_contribution_receive_date
== $previous_year) {
424 $rows[$dao->civicrm_contribution_contact_id
][$dao->civicrm_contribution_receive_date
] = $dao->civicrm_contribution_total_amount
;
428 $rows[$dao->civicrm_contribution_contact_id
]['civicrm_life_time_total'] = $dao->civicrm_contribution_total_amount
;
434 $this->formatDisplay($rows, FALSE);
436 // assign variables to templates
437 $this->doTemplateAssignment($rows);
439 // do print / pdf / instance stuff if needed
440 $this->endPostProcess($rows);
446 function buildChart(&$rows) {
448 $graphRows = array();
452 $current_year = $this->_params
['yid_value'];
453 $previous_year = $current_year - 1;
454 $interval[$previous_year] = $previous_year;
455 $interval['life_time'] = 'Life Time';
457 foreach ($rows as $key => $row) {
458 $display['life_time'] = CRM_Utils_Array
::value('life_time', $display) +
$row['civicrm_life_time_total'];
459 $display[$previous_year] = CRM_Utils_Array
::value($previous_year, $display) +
$row[$previous_year];
462 $config = CRM_Core_Config
::Singleton();
463 $graphRows['value'] = $display;
464 $chartInfo = array('legend' => ts('Lybunt Report'),
465 'xname' => ts('Year'),
466 'yname' => ts('Amount (%1)', array(1 => $config->defaultCurrency
)),
468 if ($this->_params
['charts']) {
470 CRM_Utils_OpenFlashChart
::reportChart($graphRows, $this->_params
['charts'], $interval, $chartInfo);
471 $this->assign('chartType', $this->_params
['charts']);
478 function alterDisplay(&$rows) {
479 // custom code to alter rows
482 foreach ($rows as $rowNum => $row) {
483 //Convert Display name into link
484 if (array_key_exists('civicrm_contact_sort_name', $row) &&
485 array_key_exists('civicrm_contribution_contact_id', $row)
487 $url = CRM_Report_Utils_Report
::getNextUrl('contribute/detail',
488 'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contribution_contact_id'],
489 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
491 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
492 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contribution Details for this Contact.");
496 // convert campaign_id to campaign title
497 if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
498 if ($value = $row['civicrm_contribution_campaign_id']) {
499 $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns
[$value];
504 $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s)') ?
TRUE : $entryFound;
506 // skip looking further in rows, if first row itself doesn't
507 // have the column we need
514 // Override "This Year" $op options
516 * @param string $type
517 * @param null $fieldName
521 function getOperationPair($type = "string", $fieldName = NULL) {
522 if ($fieldName == 'yid') {
523 return array('calendar' => ts('Is Calendar Year'), 'fiscal' => ts('Fiscal Year Starting'));
525 return parent
::getOperationPair($type, $fieldName);