3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
33 class CRM_Report_Form_Pledge_Pbnp
extends CRM_Report_Form
{
34 protected $_charts = array(
36 'barChart' => 'Bar Chart',
37 'pieChart' => 'Pie Chart',
39 public $_drilldownReport = array('pledge/summary' => 'Link to Detail Report');
41 protected $_customGroupExtends = array(
48 public function __construct() {
50 // Check if CiviCampaign is a) enabled and b) has active campaigns
51 $config = CRM_Core_Config
::singleton();
52 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
53 if ($campaignEnabled) {
54 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
55 $this->activeCampaigns
= $getCampaigns['campaigns'];
56 asort($this->activeCampaigns
);
59 $this->_columns
= array(
60 'civicrm_contact' => array(
61 'dao' => 'CRM_Contact_DAO_Contact',
64 'title' => ts('Constituent Name'),
73 'grouping' => 'contact-fields',
75 'civicrm_pledge' => array(
76 'dao' => 'CRM_Pledge_DAO_Pledge',
78 'pledge_create_date' => array(
79 'title' => ts('Pledge Made'),
82 'financial_type_id' => array(
83 'title' => ts('Financial Type'),
86 'frequency_unit' => array(
87 'title' => ts('Frequency Unit'),
89 'installments' => array(
90 'title' => ts('Installments'),
93 'title' => ts('Amount'),
95 'type' => CRM_Utils_Type
::T_MONEY
,
101 'status_id' => array(
102 'title' => ts('Status'),
106 'pledge_create_date' => array(
107 'title' => ts('Pledge Made'),
108 'operatorType' => CRM_Report_Form
::OP_DATE
,
110 'pledge_amount' => array(
111 'title' => ts('Pledged Amount'),
112 'operatorType' => CRM_Report_Form
::OP_INT
,
115 'title' => ts('Currency'),
116 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
117 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
119 'type' => CRM_Utils_Type
::T_STRING
,
121 'financial_type_id' => array(
122 'title' => ts('Financial Type'),
123 'type' => CRM_Utils_Type
::T_INT
,
124 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
125 'options' => CRM_Contribute_PseudoConstant
::financialType(),
127 'pledge_status_id' => array(
128 'name' => 'status_id',
129 'title' => ts('Pledge Status'),
130 'type' => CRM_Utils_Type
::T_INT
,
131 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
132 'options' => CRM_Core_OptionGroup
::values('contribution_status'),
134 'installments' => array(
135 'title' => ts('Installments'),
136 'type' => CRM_Utils_Type
::T_INT
,
139 'grouping' => 'pledge-fields',
141 'civicrm_pledge_payment' => array(
142 'dao' => 'CRM_Pledge_DAO_PledgePayment',
144 'scheduled_date' => array(
145 'title' => ts('Next Payment Due'),
146 'type' => CRM_Utils_Type
::T_DATE
,
149 'scheduled_amount' => array(
150 'type' => CRM_Utils_Type
::T_MONEY
,
151 'title' => ts('Next Payment Amount'),
155 'scheduled_date' => array(
156 'title' => ts('Next Payment Due'),
157 'operatorType' => CRM_Report_Form
::OP_DATE
,
158 'type' => CRM_Utils_Type
::T_DATE
,
161 'grouping' => 'pledge-fields',
163 'civicrm_address' => array(
164 'dao' => 'CRM_Core_DAO_Address',
166 'street_address' => NULL,
168 'postal_code' => NULL,
169 'state_province_id' => array(
170 'title' => ts('State/Province'),
172 'country_id' => array(
173 'title' => ts('Country'),
177 'grouping' => 'contact-fields',
179 'civicrm_email' => array(
180 'dao' => 'CRM_Core_DAO_Email',
181 'fields' => array('email' => NULL),
182 'grouping' => 'contact-fields',
184 'civicrm_group' => array(
185 'dao' => 'CRM_Contact_DAO_Group',
189 'name' => 'group_id',
190 'title' => ts('Group'),
191 'type' => CRM_Utils_Type
::T_INT
,
193 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
194 'options' => CRM_Core_PseudoConstant
::staticGroup(),
200 // If we have a campaign, build out the relevant elements
201 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
202 $this->_columns
['civicrm_pledge']['fields']['campaign_id'] = array(
203 'title' => ts('Campaign'),
204 'default' => 'false',
206 $this->_columns
['civicrm_pledge']['filters']['campaign_id'] = array(
207 'title' => ts('Campaign'),
208 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
209 'options' => $this->activeCampaigns
,
210 'type' => CRM_Utils_Type
::T_INT
,
214 $this->_tagFilter
= TRUE;
215 $this->_currencyColumn
= 'civicrm_pledge_currency';
216 parent
::__construct();
219 public function preProcess() {
220 $this->assign('reportTitle', ts('Pledged but not Paid Report'));
221 parent
::preProcess();
224 public function select() {
226 $this->_columnHeaders
= array();
227 foreach ($this->_columns
as $tableName => $table) {
228 if (array_key_exists('fields', $table)) {
229 foreach ($table['fields'] as $fieldName => $field) {
230 if (!empty($field['required']) ||
231 !empty($this->_params
['fields'][$fieldName])
233 // to include optional columns address and email, only if checked
234 if ($tableName == 'civicrm_address') {
235 $this->_addressField
= TRUE;
236 $this->_emailField
= TRUE;
238 elseif ($tableName == 'civicrm_email') {
239 $this->_emailField
= TRUE;
241 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
242 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
243 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
248 $this->_selectClauses
= $select;
249 $this->_select
= "SELECT " . implode(', ', $select) . " ";
252 public function from() {
255 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
256 $pendingStatus = array_search('Pending', $allStatus);
262 if ($key = CRM_Utils_Array
::key($statusKey, $allStatus)) {
263 $unpaidStatus[] = $key;
267 $statusIds = implode(', ', $unpaidStatus);
270 FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom}
271 INNER JOIN civicrm_pledge {$this->_aliases['civicrm_pledge']}
272 ON ({$this->_aliases['civicrm_pledge']}.contact_id =
273 {$this->_aliases['civicrm_contact']}.id) AND
274 {$this->_aliases['civicrm_pledge']}.status_id IN ( {$statusIds} )\n";
276 // Note that the derived query protects us from providing inaccurate data in the edge case where pledge
277 // payments have been edited such that they are not in id order. This might be better as a temp table.
278 $this->_from
.= "LEFT JOIN (SELECT * FROM civicrm_pledge_payment ORDER BY scheduled_date) as {$this->_aliases['civicrm_pledge_payment']}
279 ON ({$this->_aliases['civicrm_pledge']}.id =
280 {$this->_aliases['civicrm_pledge_payment']}.pledge_id AND {$this->_aliases['civicrm_pledge_payment']}.status_id = {$pendingStatus} ) ";
282 // include address field if address column is to be included
283 if ($this->_addressField
) {
285 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
286 ON ({$this->_aliases['civicrm_contact']}.id =
287 {$this->_aliases['civicrm_address']}.contact_id) AND
288 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
291 // include email field if email column is to be included
292 if ($this->_emailField
) {
294 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
295 ON ({$this->_aliases['civicrm_contact']}.id =
296 {$this->_aliases['civicrm_email']}.contact_id) AND
297 {$this->_aliases['civicrm_email']}.is_primary = 1\n";
301 public function groupBy() {
303 "{$this->_aliases['civicrm_pledge']}.contact_id",
304 "{$this->_aliases['civicrm_pledge']}.id",
305 "{$this->_aliases['civicrm_pledge']}.currency",
307 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $groupBy);
310 public function orderBy() {
311 $this->_orderBy
= "ORDER BY {$this->_aliases['civicrm_contact']}.sort_name, {$this->_aliases['civicrm_pledge']}.contact_id, {$this->_aliases['civicrm_pledge']}.id";
314 public function postProcess() {
315 // get the acl clauses built before we assemble the query
316 $this->buildACLClause($this->_aliases
['civicrm_contact']);
317 parent
::PostProcess();
321 * Alter display of rows.
323 * Iterate through the rows retrieved via SQL and make changes for display purposes,
324 * such as rendering contacts as links.
328 public function alterDisplay(&$rows) {
330 $checkList = array();
331 $display_flag = $prev_cid = $cid = 0;
333 foreach ($rows as $rowNum => $row) {
334 if (!empty($this->_noRepeats
) && $this->_outputMode
!= 'csv') {
335 // don't repeat contact details if its same as the previous row
336 if (array_key_exists('civicrm_contact_id', $row)) {
337 if ($cid = $row['civicrm_contact_id']) {
342 if ($prev_cid == $cid) {
353 foreach ($row as $colName => $colVal) {
354 if (in_array($colName, $this->_noRepeats
)) {
355 unset($rows[$rowNum][$colName]);
364 //handle the Financial Type Ids
365 if (array_key_exists('civicrm_pledge_financial_type_id', $row)) {
366 if ($value = $row['civicrm_pledge_financial_type_id']) {
367 $rows[$rowNum]['civicrm_pledge_financial_type_id'] = CRM_Contribute_PseudoConstant
::financialType($value, FALSE);
372 //handle the Status Ids
373 if (array_key_exists('civicrm_pledge_status_id', $row)) {
374 if ($value = $row['civicrm_pledge_status_id']) {
375 $rows[$rowNum]['civicrm_pledge_status_id'] = CRM_Contribute_PseudoConstant
::contributionStatus($value);
380 // handle state province
381 if (array_key_exists('civicrm_address_state_province_id', $row)) {
382 if ($value = $row['civicrm_address_state_province_id']) {
383 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($value, FALSE);
389 if (array_key_exists('civicrm_address_country_id', $row)) {
390 if ($value = $row['civicrm_address_country_id']) {
391 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant
::country($value, FALSE);
396 // convert display name to links
397 if (array_key_exists('civicrm_contact_sort_name', $row) &&
398 array_key_exists('civicrm_contact_id', $row)
400 $url = CRM_Report_Utils_Report
::getNextUrl('pledge/summary',
401 'reset=1&force=1&id_op=eq&id_value=' .
402 $row['civicrm_contact_id'],
403 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
405 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
406 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Pledge Details for this contact");
410 // If using campaigns, convert campaign_id to campaign title
411 if (array_key_exists('civicrm_pledge_campaign_id', $row)) {
412 if ($value = $row['civicrm_pledge_campaign_id']) {
413 $rows[$rowNum]['civicrm_pledge_campaign_id'] = $this->activeCampaigns
[$value];
418 // skip looking further in rows, if first row itself doesn't
419 // have the column we need