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
35 class CRM_Report_Form_Pledge_Pbnp
extends CRM_Report_Form
{
36 protected $_charts = array(
38 'barChart' => 'Bar Chart',
39 'pieChart' => 'Pie Chart',
41 public $_drilldownReport = array('pledge/summary' => 'Link to Detail Report');
43 protected $_customGroupExtends = array(
51 public function __construct() {
53 // Check if CiviCampaign is a) enabled and b) has active campaigns
54 $config = CRM_Core_Config
::singleton();
55 $campaignEnabled = in_array("CiviCampaign", $config->enableComponents
);
56 if ($campaignEnabled) {
57 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
58 $this->activeCampaigns
= $getCampaigns['campaigns'];
59 asort($this->activeCampaigns
);
62 $this->_columns
= array(
63 'civicrm_contact' => array(
64 'dao' => 'CRM_Contact_DAO_Contact',
67 'title' => ts('Constituent Name'),
76 'grouping' => 'contact-fields',
78 'civicrm_pledge' => array(
79 'dao' => 'CRM_Pledge_DAO_Pledge',
81 'pledge_create_date' => array(
82 'title' => ts('Pledge Made'),
85 'financial_type_id' => array(
86 'title' => ts('Financial Type'),
89 'frequency_unit' => array(
90 'title' => ts('Frequency Unit'),
92 'installments' => array(
93 'title' => ts('Installments'),
96 'title' => ts('Amount'),
98 'type' => CRM_Utils_Type
::T_MONEY
,
102 'no_display' => TRUE,
104 'status_id' => array(
105 'title' => ts('Status'),
109 'pledge_create_date' => array(
110 'title' => ts('Pledge Made'),
111 'operatorType' => CRM_Report_Form
::OP_DATE
,
113 'pledge_amount' => array(
114 'title' => ts('Pledged Amount'),
115 'operatorType' => CRM_Report_Form
::OP_INT
,
118 'title' => 'Currency',
119 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
120 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
122 'type' => CRM_Utils_Type
::T_STRING
,
124 'financial_type_id' => array(
125 'title' => ts('Financial Type'),
126 'type' => CRM_Utils_Type
::T_INT
,
127 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
128 'options' => CRM_Contribute_PseudoConstant
::financialType(),
130 'pledge_status_id' => array(
131 'name' => 'status_id',
132 'title' => ts('Pledge Status'),
133 'type' => CRM_Utils_Type
::T_INT
,
134 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
135 'options' => CRM_Core_OptionGroup
::values('contribution_status'),
137 'installments' => array(
138 'title' => ts('Installments'),
139 'type' => CRM_Utils_Type
::T_INT
,
142 'grouping' => 'pledge-fields',
144 'civicrm_pledge_payment' => array(
145 'dao' => 'CRM_Pledge_DAO_PledgePayment',
147 'scheduled_date' => array(
148 'title' => ts('Next Payment Due'),
149 'type' => CRM_Utils_Type
::T_DATE
,
152 'scheduled_amount' => array(
153 'type' => CRM_Utils_Type
::T_MONEY
,
154 'title' => 'Next Payment Amount',
158 'scheduled_date' => array(
159 'title' => ts('Next Payment Due'),
160 'operatorType' => CRM_Report_Form
::OP_DATE
,
161 'type' => CRM_Utils_Type
::T_DATE
,
164 'grouping' => 'pledge-fields',
166 'civicrm_address' => array(
167 'dao' => 'CRM_Core_DAO_Address',
169 'street_address' => NULL,
171 'postal_code' => NULL,
172 'state_province_id' => array(
173 'title' => ts('State/Province'),
175 'country_id' => array(
176 'title' => ts('Country'),
180 'grouping' => 'contact-fields',
182 'civicrm_email' => array(
183 'dao' => 'CRM_Core_DAO_Email',
184 'fields' => array('email' => NULL),
185 'grouping' => 'contact-fields',
187 'civicrm_group' => array(
188 'dao' => 'CRM_Contact_DAO_Group',
192 'name' => 'group_id',
193 'title' => ts('Group'),
194 'type' => CRM_Utils_Type
::T_INT
,
196 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
197 'options' => CRM_Core_PseudoConstant
::staticGroup(),
203 // If we have a campaign, build out the relevant elements
204 if ($campaignEnabled && !empty($this->activeCampaigns
)) {
205 $this->_columns
['civicrm_pledge']['fields']['campaign_id'] = array(
206 'title' => 'Campaign',
207 'default' => 'false',
209 $this->_columns
['civicrm_pledge']['filters']['campaign_id'] = array(
210 'title' => ts('Campaign'),
211 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
212 'options' => $this->activeCampaigns
,
213 'type' => CRM_Utils_Type
::T_INT
,
217 $this->_tagFilter
= TRUE;
218 $this->_currencyColumn
= 'civicrm_pledge_currency';
219 parent
::__construct();
222 public function preProcess() {
223 $this->assign('reportTitle', ts('Pledged but not Paid Report'));
224 parent
::preProcess();
227 public function select() {
229 $this->_columnHeaders
= array();
230 foreach ($this->_columns
as $tableName => $table) {
231 if (array_key_exists('fields', $table)) {
232 foreach ($table['fields'] as $fieldName => $field) {
233 if (!empty($field['required']) ||
234 !empty($this->_params
['fields'][$fieldName])
236 // to include optional columns address and email, only if checked
237 if ($tableName == 'civicrm_address') {
238 $this->_addressField
= TRUE;
239 $this->_emailField
= TRUE;
241 elseif ($tableName == 'civicrm_email') {
242 $this->_emailField
= TRUE;
244 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
245 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
246 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
251 $this->_selectClauses
= $select;
252 $this->_select
= "SELECT " . implode(', ', $select) . " ";
255 public function from() {
258 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
259 $pendingStatus = array_search('Pending', $allStatus);
265 if ($key = CRM_Utils_Array
::key($statusKey, $allStatus)) {
266 $unpaidStatus[] = $key;
270 $statusIds = implode(', ', $unpaidStatus);
273 FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom}
274 INNER JOIN civicrm_pledge {$this->_aliases['civicrm_pledge']}
275 ON ({$this->_aliases['civicrm_pledge']}.contact_id =
276 {$this->_aliases['civicrm_contact']}.id) AND
277 {$this->_aliases['civicrm_pledge']}.status_id IN ( {$statusIds} )\n";
279 // Note that the derived query protects us from providing inaccurate data in the edge case where pledge
280 // payments have been edited such that they are not in id order. This might be better as a temp table.
281 $this->_from
.= "LEFT JOIN (SELECT * FROM civicrm_pledge_payment ORDER BY scheduled_date) as {$this->_aliases['civicrm_pledge_payment']}
282 ON ({$this->_aliases['civicrm_pledge']}.id =
283 {$this->_aliases['civicrm_pledge_payment']}.pledge_id AND {$this->_aliases['civicrm_pledge_payment']}.status_id = {$pendingStatus} ) ";
285 // include address field if address column is to be included
286 if ($this->_addressField
) {
288 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
289 ON ({$this->_aliases['civicrm_contact']}.id =
290 {$this->_aliases['civicrm_address']}.contact_id) AND
291 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
294 // include email field if email column is to be included
295 if ($this->_emailField
) {
297 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
298 ON ({$this->_aliases['civicrm_contact']}.id =
299 {$this->_aliases['civicrm_email']}.contact_id) AND
300 {$this->_aliases['civicrm_email']}.is_primary = 1\n";
304 public function groupBy() {
306 "{$this->_aliases['civicrm_pledge']}.contact_id",
307 "{$this->_aliases['civicrm_pledge']}.id",
308 "{$this->_aliases['civicrm_pledge']}.currency",
310 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $groupBy);
313 public function orderBy() {
314 $this->_orderBy
= "ORDER BY {$this->_aliases['civicrm_contact']}.sort_name, {$this->_aliases['civicrm_pledge']}.contact_id, {$this->_aliases['civicrm_pledge']}.id";
317 public function postProcess() {
318 // get the acl clauses built before we assemble the query
319 $this->buildACLClause($this->_aliases
['civicrm_contact']);
320 parent
::PostProcess();
324 * Alter display of rows.
326 * Iterate through the rows retrieved via SQL and make changes for display purposes,
327 * such as rendering contacts as links.
331 public function alterDisplay(&$rows) {
333 $checkList = array();
334 $display_flag = $prev_cid = $cid = 0;
336 foreach ($rows as $rowNum => $row) {
337 if (!empty($this->_noRepeats
) && $this->_outputMode
!= 'csv') {
338 // don't repeat contact details if its same as the previous row
339 if (array_key_exists('civicrm_contact_id', $row)) {
340 if ($cid = $row['civicrm_contact_id']) {
345 if ($prev_cid == $cid) {
356 foreach ($row as $colName => $colVal) {
357 if (in_array($colName, $this->_noRepeats
)) {
358 unset($rows[$rowNum][$colName]);
367 //handle the Financial Type Ids
368 if (array_key_exists('civicrm_pledge_financial_type_id', $row)) {
369 if ($value = $row['civicrm_pledge_financial_type_id']) {
370 $rows[$rowNum]['civicrm_pledge_financial_type_id'] = CRM_Contribute_PseudoConstant
::financialType($value, FALSE);
375 //handle the Status Ids
376 if (array_key_exists('civicrm_pledge_status_id', $row)) {
377 if ($value = $row['civicrm_pledge_status_id']) {
378 $rows[$rowNum]['civicrm_pledge_status_id'] = CRM_Contribute_PseudoConstant
::contributionStatus($value);
383 // handle state province
384 if (array_key_exists('civicrm_address_state_province_id', $row)) {
385 if ($value = $row['civicrm_address_state_province_id']) {
386 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($value, FALSE);
392 if (array_key_exists('civicrm_address_country_id', $row)) {
393 if ($value = $row['civicrm_address_country_id']) {
394 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant
::country($value, FALSE);
399 // convert display name to links
400 if (array_key_exists('civicrm_contact_sort_name', $row) &&
401 array_key_exists('civicrm_contact_id', $row)
403 $url = CRM_Report_Utils_Report
::getNextUrl('pledge/summary',
404 'reset=1&force=1&id_op=eq&id_value=' .
405 $row['civicrm_contact_id'],
406 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
408 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
409 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Pledge Details for this contact");
413 // If using campaigns, convert campaign_id to campaign title
414 if (array_key_exists('civicrm_pledge_campaign_id', $row)) {
415 if ($value = $row['civicrm_pledge_campaign_id']) {
416 $rows[$rowNum]['civicrm_pledge_campaign_id'] = $this->activeCampaigns
[$value];
421 // skip looking further in rows, if first row itself doesn't
422 // have the column we need