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 * This class is used to retrieve and display a range of
36 * contacts that match the given criteria (specifically for
37 * results of advanced search options.
39 class CRM_Pledge_Selector_Search
extends CRM_Core_Selector_Base
{
42 * This defines two actions- View and Edit.
46 static $_links = NULL;
49 * We use desc to remind us what that column is, name is used in the tpl
53 static $_columnHeaders;
56 * Properties of contact we're interested in displaying
60 static $_properties = array(
68 'pledge_next_pay_date',
69 'pledge_next_pay_amount',
70 'pledge_outstanding_amount',
74 'pledge_contribution_page_id',
75 'pledge_financial_type',
81 * Are we restricting ourselves to a single contact
85 protected $_single = FALSE;
88 * Are we restricting ourselves to a single contact
92 protected $_limit = NULL;
95 * What context are we being invoked from
99 protected $_context = NULL;
102 * QueryParams is the array returned by exportValues called on
103 * the HTML_QuickForm_Controller for that page.
107 public $_queryParams;
110 * Represent the type of selector
117 * The additional clause that we restrict the search with
121 protected $_additionalClause = NULL;
133 * @param array $queryParams
134 * Array of parameters for query.
135 * @param \const|int $action - action of search basic or advanced.
136 * @param string $additionalClause
137 * If the caller wants to further restrict the search (used in participations).
138 * @param bool $single
139 * Are we dealing only with one contact?.
141 * How many signers do we want returned.
143 * @param string $context
145 * @return \CRM_Pledge_Selector_Search
147 public function __construct(
149 $action = CRM_Core_Action
::NONE
,
150 $additionalClause = NULL,
155 // submitted form values
156 $this->_queryParams
= &$queryParams;
158 $this->_single
= $single;
159 $this->_limit
= $limit;
160 $this->_context
= $context;
162 $this->_additionalClause
= $additionalClause;
165 $this->_action
= $action;
167 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
, NULL, NULL, FALSE, FALSE,
168 CRM_Contact_BAO_Query
::MODE_PLEDGE
171 $this->_query
->_distinctComponentClause
= "civicrm_pledge.id";
172 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_pledge.id ";
176 * This method returns the links that are given for each search row.
178 * Currently the links added for each row are:
184 public static function &links() {
185 $args = func_get_args();
186 $hideOption = CRM_Utils_Array
::value(0, $args);
187 $key = CRM_Utils_Array
::value(1, $args);
189 $extraParams = ($key) ?
"&key={$key}" : NULL;
191 $cancelExtra = ts('Cancelling this pledge will also cancel any scheduled (and not completed) pledge payments.') . ' ' . ts('This action cannot be undone.') . ' ' . ts('Do you want to continue?');
192 self
::$_links = array(
193 CRM_Core_Action
::VIEW
=> array(
194 'name' => ts('View'),
195 'url' => 'civicrm/contact/view/pledge',
196 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=pledge' . $extraParams,
197 'title' => ts('View Pledge'),
199 CRM_Core_Action
::UPDATE
=> array(
200 'name' => ts('Edit'),
201 'url' => 'civicrm/contact/view/pledge',
202 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
203 'title' => ts('Edit Pledge'),
205 CRM_Core_Action
::DETACH
=> array(
206 'name' => ts('Cancel'),
207 'url' => 'civicrm/contact/view/pledge',
208 'qs' => 'reset=1&action=detach&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
209 'extra' => 'onclick = "return confirm(\'' . $cancelExtra . '\');"',
210 'title' => ts('Cancel Pledge'),
212 CRM_Core_Action
::DELETE
=> array(
213 'name' => ts('Delete'),
214 'url' => 'civicrm/contact/view/pledge',
215 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
216 'title' => ts('Delete Pledge'),
220 if (in_array('Cancel', $hideOption)) {
221 unset(self
::$_links[CRM_Core_Action
::DETACH
]);
224 return self
::$_links;
228 * Getter for array of the parameters required for creating pager.
231 * @param array $params
233 public function getPagerParams($action, &$params) {
234 $params['status'] = ts('Pledge') . ' %%StatusMessage%%';
235 $params['csvString'] = NULL;
237 $params['rowCount'] = $this->_limit
;
240 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
243 $params['buttonTop'] = 'PagerTopButton';
244 $params['buttonBottom'] = 'PagerBottomButton';
248 * Returns total number of rows for the query.
253 * Total number of rows
255 public function getTotalCount($action) {
256 return $this->_query
->searchQuery(0, 0, NULL,
260 $this->_additionalClause
265 * Returns all the rows in the given offset and rowCount.
267 * @param string $action
268 * The action being performed.
270 * The row number to start from.
271 * @param int $rowCount
272 * The number of rows to return.
273 * @param string $sort
274 * The sql string that describes the sort order.
275 * @param string $output
276 * What should the result set include (web/email/csv).
279 * the total number of rows for this action
281 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
282 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
286 $this->_additionalClause
289 // process the result of the query
292 // get all pledge status
293 $pledgeStatuses = CRM_Core_OptionGroup
::values('contribution_status',
294 FALSE, FALSE, FALSE, NULL, 'name', FALSE
297 // get all campaigns.
298 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
300 // CRM-4418 check for view, edit and delete
301 $permissions = array(CRM_Core_Permission
::VIEW
);
302 if (CRM_Core_Permission
::check('edit pledges')) {
303 $permissions[] = CRM_Core_Permission
::EDIT
;
305 if (CRM_Core_Permission
::check('delete in CiviPledge')) {
306 $permissions[] = CRM_Core_Permission
::DELETE
;
308 $mask = CRM_Core_Action
::mask($permissions);
310 while ($result->fetch()) {
312 // the columns we are interested in
313 foreach (self
::$_properties as $property) {
314 if (isset($result->$property)) {
315 $row[$property] = $result->$property;
319 // carry campaign on selectors.
320 $row['campaign'] = CRM_Utils_Array
::value($result->pledge_campaign_id
, $allCampaigns);
321 $row['campaign_id'] = $result->pledge_campaign_id
;
323 // add pledge status name
324 $row['pledge_status_name'] = CRM_Utils_Array
::value($row['pledge_status_id'],
327 // append (test) to status label
328 if (!empty($row['pledge_is_test'])) {
329 $row['pledge_status'] .= ' (test)';
332 $hideOption = array();
333 if (CRM_Utils_Array
::key('Cancelled', $row) ||
334 CRM_Utils_Array
::key('Completed', $row)
336 $hideOption[] = 'Cancel';
339 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->pledge_id
;
341 $row['action'] = CRM_Core_Action
::formLink(self
::links($hideOption, $this->_key
),
344 'id' => $result->pledge_id
,
345 'cid' => $result->contact_id
,
346 'cxt' => $this->_context
,
350 'pledge.selector.row',
355 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
363 * Get qill (display what was searched on).
367 public function getQILL() {
368 return $this->_query
->qill();
372 * Returns the column headers as an array of tuples.
374 * Keys are name, sortName, key to the sort array
376 * @param string $action
377 * The action being performed.
378 * @param string $output
379 * What should the result set include (web/email/csv).
382 * the column headers that need to be displayed
384 public function &getColumnHeaders($action = NULL, $output = NULL) {
385 if (!isset(self
::$_columnHeaders)) {
386 self
::$_columnHeaders = array(
388 'name' => ts('Pledged'),
389 'sort' => 'pledge_amount',
390 'direction' => CRM_Utils_Sort
::DONTCARE
,
393 'name' => ts('Total Paid'),
394 'sort' => 'pledge_total_paid',
395 'direction' => CRM_Utils_Sort
::DONTCARE
,
398 'name' => ts('Balance'),
401 'name' => ts('Pledged For'),
402 'sort' => 'pledge_financial_type',
403 'direction' => CRM_Utils_Sort
::DONTCARE
,
406 'name' => ts('Pledge Made'),
407 'sort' => 'pledge_create_date',
408 'direction' => CRM_Utils_Sort
::DESCENDING
,
411 'name' => ts('Next Pay Date'),
412 'sort' => 'pledge_next_pay_date',
413 'direction' => CRM_Utils_Sort
::DONTCARE
,
416 'name' => ts('Next Amount'),
417 'sort' => 'pledge_next_pay_amount',
418 'direction' => CRM_Utils_Sort
::DONTCARE
,
421 'name' => ts('Status'),
422 'sort' => 'pledge_status',
423 'direction' => CRM_Utils_Sort
::DONTCARE
,
425 array('desc' => ts('Actions')),
428 if (!$this->_single
) {
430 array('desc' => ts('Contact ID')),
432 'name' => ts('Name'),
433 'sort' => 'sort_name',
434 'direction' => CRM_Utils_Sort
::DONTCARE
,
438 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
441 return self
::$_columnHeaders;
445 * Get sql query string.
449 public function &getQuery() {
450 return $this->_query
;
454 * Name of export file.
456 * @param string $output
462 public function getExportFileName($output = 'csv') {
463 return ts('Pledge Search');