3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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_Sybunt
extends CRM_Report_Form
{
37 protected $_charts = array(
39 'barChart' => 'Bar Chart',
40 'pieChart' => 'Pie Chart',
42 public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report');
47 function __construct() {
50 $date = CRM_Core_SelectValues
::date('custom', NULL, $yearsInPast, $yearsInFuture);
51 $count = $date['maxYear'];
52 while ($date['minYear'] <= $count) {
53 $optionYear[$date['minYear']] = $date['minYear'];
57 // Check if CiviCampaign is a) enabled and b) has active campaigns
58 $config = CRM_Core_Config
::singleton();
59 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
60 if ($campaignEnabled) {
61 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
62 $this->activeCampaigns
= $getCampaigns['campaigns'];
63 asort($this->activeCampaigns
);
66 $this->_columns
= array(
67 'civicrm_contact' => array(
68 'dao' => 'CRM_Contact_DAO_Contact',
69 'grouping' => 'contact-field',
72 'title' => ts('Donor Name'),
75 'first_name' => array(
76 'title' => ts('First Name'),
79 'title' => ts('Last Name'),
81 'contact_type' => array(
82 'title' => ts('Contact Type'),
84 'contact_sub_type' => array(
85 'title' => ts('Contact Subtype'),
90 'title' => ts('Donor Name'),
95 'civicrm_email' => array(
96 'dao' => 'CRM_Core_DAO_Email',
97 'grouping' => 'contact-field',
100 'title' => ts('Email'),
105 'civicrm_phone' => array(
106 'dao' => 'CRM_Core_DAO_Phone',
107 'grouping' => 'contact-field',
110 'title' => ts('Phone'),
116 +
$this->addAddressFields()
118 'civicrm_contribution' => array(
119 'dao' => 'CRM_Contribute_DAO_Contribution',
121 'contact_id' => array(
122 'title' => ts('contactId'),
123 'no_display' => TRUE,
127 'total_amount' => array(
128 'title' => ts('Total Amount'),
129 'no_display' => TRUE,
133 'receive_date' => array(
134 'title' => ts('Year'),
135 'no_display' => TRUE,
142 'name' => 'receive_date',
143 'title' => ts('This Year'),
144 'operatorType' => CRM_Report_Form
::OP_SELECT
,
145 'options' => $optionYear,
146 'default' => date('Y'),
148 'financial_type_id' => array(
149 'title' => ts('Financial Type'),
150 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
151 'options' => CRM_Contribute_PseudoConstant
::financialType(),
153 'contribution_status_id' => array(
154 'title' => ts('Contribution Status'),
155 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
156 'options' => CRM_Contribute_PseudoConstant
::contributionStatus(),
157 'default' => array('1'),
163 // If we have a campaign, build out the relevant elements
164 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
165 $this->_columns
['civicrm_contribution']['fields']['campaign_id'] = array(
166 'title' => ts('Campaign'),
167 'default' => 'false',
169 $this->_columns
['civicrm_contribution']['filters']['campaign_id'] = array(
170 'title' => ts('Campaign'),
171 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
172 'options' => $this->activeCampaigns
,
176 $this->_groupFilter
= TRUE;
177 $this->_tagFilter
= TRUE;
178 parent
::__construct();
181 function preProcess() {
182 parent
::preProcess();
187 $this->_columnHeaders
= array();
188 $current_year = $this->_params
['yid_value'];
189 $previous_year = $current_year - 1;
190 $previous_pyear = $current_year - 2;
191 $previous_ppyear = $current_year - 3;
192 $upTo_year = $current_year - 4;
194 foreach ($this->_columns
as $tableName => $table) {
195 if (array_key_exists('fields', $table)) {
196 foreach ($table['fields'] as $fieldName => $field) {
198 if (!empty($field['required']) ||
199 !empty($this->_params
['fields'][$fieldName])
201 if ($fieldName == 'total_amount') {
202 $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}";
204 $this->_columnHeaders
["civicrm_upto_{$upTo_year}"]['type'] = $field['type'];
205 $this->_columnHeaders
["civicrm_upto_{$upTo_year}"]['title'] = "Up To $upTo_year";
207 $this->_columnHeaders
["{$previous_ppyear}"]['type'] = $field['type'];
208 $this->_columnHeaders
["{$previous_ppyear}"]['title'] = $previous_ppyear;
210 $this->_columnHeaders
["{$previous_pyear}"]['type'] = $field['type'];
211 $this->_columnHeaders
["{$previous_pyear}"]['title'] = $previous_pyear;
213 $this->_columnHeaders
["{$previous_year}"]['type'] = $field['type'];
214 $this->_columnHeaders
["{$previous_year}"]['title'] = $previous_year;
216 $this->_columnHeaders
["civicrm_life_time_total"]['type'] = $field['type'];
217 $this->_columnHeaders
["civicrm_life_time_total"]['title'] = 'LifeTime';;
219 elseif ($fieldName == 'receive_date') {
220 $select[] = self
::fiscalYearOffset($field['dbAlias']) .
221 " as {$tableName}_{$fieldName}";
224 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
225 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
226 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
228 if (!empty($field['no_display'])) {
229 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['no_display'] = TRUE;
236 $this->_select
= "SELECT " . implode(', ', $select) . " ";
242 FROM civicrm_contribution {$this->_aliases['civicrm_contribution']}
243 INNER JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
244 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id
247 if ($this->isTableSelected('civicrm_email')) {
249 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
250 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
251 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
253 if ($this->isTableSelected('civicrm_phone')) {
255 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
256 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
257 {$this->_aliases['civicrm_phone']}.is_primary = 1";
259 $this->addAddressFromClause();
263 $this->_statusClause
= "";
264 $clauses = array($this->_aliases
['civicrm_contribution'] . '.is_test = 0');
265 foreach ($this->_columns
as $tableName => $table) {
266 if (array_key_exists('filters', $table)) {
267 foreach ($table['filters'] as $fieldName => $field) {
269 if ($fieldName == 'yid') {
270 $clause = "contribution_civireport.contact_id NOT IN
271 (SELECT distinct cont.id FROM civicrm_contact cont, civicrm_contribution contri
272 WHERE cont.id = contri.contact_id AND " .
273 self
::fiscalYearOffset('contri.receive_date') .
274 " = {$this->_params['yid_value']} AND contri.is_test = 0 )";
276 elseif (CRM_Utils_Array
::value('type', $field) &
277 CRM_Utils_Type
::T_DATE
279 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
280 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
281 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
283 if ($relative ||
$from ||
$to) {
284 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
288 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
290 $clause = $this->whereClause($field,
292 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
293 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
294 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
296 if (($fieldName == 'contribution_status_id' ||
297 $fieldName == 'financial_type_id') && !empty($clause)
299 $this->_statusClause
.= " AND " . $clause;
304 if (!empty($clause)) {
305 $clauses[] = $clause;
311 $this->_where
= "WHERE " . implode(' AND ', $clauses);
313 if ($this->_aclWhere
) {
314 $this->_where
.= " AND {$this->_aclWhere} ";
319 $this->assign('chartSupported', TRUE);
321 "Group BY {$this->_aliases['civicrm_contribution']}.contact_id, " .
322 self
::fiscalYearOffset($this->_aliases
['civicrm_contribution'] .
323 '.receive_date') . " WITH ROLLUP ";
331 function statistics(&$rows) {
332 $statistics = parent
::statistics($rows);
337 SUM({$this->_aliases['civicrm_contribution']}.total_amount ) as amount ";
339 $sql = "{$select} {$this->_from} {$this->_where}";
340 $dao = CRM_Core_DAO
::executeQuery($sql);
342 $statistics['counts']['amount'] = array(
343 'value' => $dao->amount
,
344 'title' => 'Total LifeTime',
345 'type' => CRM_Utils_Type
::T_MONEY
,
352 function postProcess() {
353 // get ready with post process params
354 $this->beginPostProcess();
356 $this->buildACLClause($this->_aliases
['civicrm_contact']);
362 $rows = $contactIds = array();
363 if (empty($this->_params
['charts'])) {
365 $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}";
367 $dao = CRM_Core_DAO
::executeQuery($getContacts);
369 while ($dao->fetch()) {
370 $contactIds[] = $dao->cid
;
376 if (!empty($contactIds) ||
!empty($this->_params
['charts'])) {
377 if (!empty($this->_params
['charts'])) {
378 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy}";
382 "{$this->_select} {$this->_from} WHERE {$this->_aliases['civicrm_contact']}.id IN (" .
383 implode(',', $contactIds) .
384 ") AND {$this->_aliases['civicrm_contribution']}.is_test = 0 {$this->_statusClause} {$this->_groupBy} ";
387 $current_year = $this->_params
['yid_value'];
388 $previous_year = $current_year - 1;
389 $previous_pyear = $current_year - 2;
390 $previous_ppyear = $current_year - 3;
391 $upTo_year = $current_year - 4;
393 $rows = $row = array();
394 $dao = CRM_Core_DAO
::executeQuery($sql);
395 $contributionSum = 0;
397 while ($dao->fetch()) {
398 if (!$dao->civicrm_contribution_contact_id
) {
402 foreach ($this->_columnHeaders
as $key => $value) {
403 if (property_exists($dao, $key)) {
404 $rows[$dao->civicrm_contribution_contact_id
][$key] = $dao->$key;
407 if ($dao->civicrm_contribution_receive_date
) {
408 if ($dao->civicrm_contribution_receive_date
> $upTo_year) {
409 $contributionSum +
= $dao->civicrm_contribution_total_amount
;
410 $rows[$dao->civicrm_contribution_contact_id
][$dao->civicrm_contribution_receive_date
] = $dao->civicrm_contribution_total_amount
;
414 $rows[$dao->civicrm_contribution_contact_id
]['civicrm_life_time_total'] = $dao->civicrm_contribution_total_amount
;
415 if (($dao->civicrm_contribution_total_amount
- $contributionSum) > 0
417 $rows[$dao->civicrm_contribution_contact_id
]["civicrm_upto_{$upTo_year}"] =
418 $dao->civicrm_contribution_total_amount
- $contributionSum;
420 $contributionSum = 0;
425 // format result set.
426 $this->formatDisplay($rows, FALSE);
428 // assign variables to templates
429 $this->doTemplateAssignment($rows);
431 // do print / pdf / instance stuff if needed
432 $this->endPostProcess($rows);
438 function buildChart(&$rows) {
439 $graphRows = array();
441 $current_year = $this->_params
['yid_value'];
442 $previous_year = $current_year - 1;
443 $previous_two_year = $current_year - 2;
444 $previous_three_year = $current_year - 3;
445 $upto = $current_year - 4;
447 $interval[$previous_year] = $previous_year;
448 $interval[$previous_two_year] = $previous_two_year;
449 $interval[$previous_three_year] = $previous_three_year;
450 $interval["upto_{$upto}"] = "Up To {$upto}";
452 foreach ($rows as $key => $row) {
453 $display["upto_{$upto}"] =
454 CRM_Utils_Array
::value("upto_{$upto}", $display) +
455 CRM_Utils_Array
::value("civicrm_upto_{$upto}", $row);
456 $display[$previous_year] =
457 CRM_Utils_Array
::value($previous_year, $display) +
458 CRM_Utils_Array
::value($previous_year, $row);
459 $display[$previous_two_year] =
460 CRM_Utils_Array
::value($previous_two_year, $display) +
461 CRM_Utils_Array
::value($previous_two_year, $row);
462 $display[$previous_three_year] =
463 CRM_Utils_Array
::value($previous_three_year, $display) +
464 CRM_Utils_Array
::value($previous_three_year, $row);
467 $graphRows['value'] = $display;
468 $config = CRM_Core_Config
::Singleton();
470 'legend' => 'Sybunt Report',
472 'yname' => "Amount ({$config->defaultCurrency})",
474 if ($this->_params
['charts']) {
476 CRM_Utils_OpenFlashChart
::reportChart($graphRows, $this->_params
['charts'], $interval, $chartInfo);
477 $this->assign('chartType', $this->_params
['charts']);
484 function alterDisplay(&$rows) {
485 // custom code to alter rows
488 foreach ($rows as $rowNum => $row) {
489 //Convert Display name into link
490 if (array_key_exists('civicrm_contact_sort_name', $row) &&
491 array_key_exists('civicrm_contribution_contact_id', $row)
493 $url = CRM_Report_Utils_Report
::getNextUrl('contribute/detail',
494 'reset=1&force=1&id_op=eq&id_value=' .
495 $row['civicrm_contribution_contact_id'],
496 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
498 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
499 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contribution Details for this Contact.");
503 // convert campaign_id to campaign title
504 if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
505 if ($value = $row['civicrm_contribution_campaign_id']) {
506 $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns
[$value];
511 $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s)') ?
TRUE : $entryFound;
513 // skip looking further in rows, if first row itself doesn't
514 // have the column we need
521 // Override "This Year" $op options
523 * @param string $type
524 * @param null $fieldName
528 function getOperationPair($type = "string", $fieldName = NULL) {
529 if ($fieldName == 'yid') {
531 'calendar' => ts('Is Calendar Year'),
532 'fiscal' => ts('Fiscal Year Starting')
535 return parent
::getOperationPair($type, $fieldName);