3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class is used to retrieve and display a range of
38 * contacts that match the given criteria (specifically for
39 * results of advanced search options.
42 class CRM_Pledge_Selector_Search
extends CRM_Core_Selector_Base
{
45 * This defines two actions- View and Edit.
50 static $_links = NULL;
53 * we use desc to remind us what that column is, name is used in the tpl
58 static $_columnHeaders;
61 * Properties of contact we're interested in displaying
65 static $_properties = array(
73 'pledge_next_pay_date',
74 'pledge_next_pay_amount',
75 'pledge_outstanding_amount',
79 'pledge_contribution_page_id',
80 'pledge_contribution_type',
86 * are we restricting ourselves to a single contact
91 protected $_single = FALSE;
94 * are we restricting ourselves to a single contact
99 protected $_limit = NULL;
102 * what context are we being invoked from
107 protected $_context = NULL;
110 * queryParams is the array returned by exportValues called on
111 * the HTML_QuickForm_Controller for that page.
116 public $_queryParams;
119 * represent the type of selector
127 * The additional clause that we restrict the search with
131 protected $_additionalClause = NULL;
143 * @param array $queryParams array of parameters for query
144 * @param int $action - action of search basic or advanced.
145 * @param string $additionalClause if the caller wants to further restrict the search (used in participations)
146 * @param boolean $single are we dealing only with one contact?
147 * @param int $limit how many signers do we want returned
149 * @return CRM_Contact_Selector
152 function __construct(&$queryParams,
153 $action = CRM_Core_Action
::NONE
,
154 $additionalClause = NULL,
159 // submitted form values
160 $this->_queryParams
= &$queryParams;
162 $this->_single
= $single;
163 $this->_limit
= $limit;
164 $this->_context
= $context;
166 $this->_additionalClause
= $additionalClause;
169 $this->_action
= $action;
171 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
, NULL, NULL, FALSE, FALSE,
172 CRM_Contact_BAO_Query
::MODE_PLEDGE
175 $this->_query
->_distinctComponentClause
= "civicrm_pledge.id";
176 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_pledge.id ";
181 * This method returns the links that are given for each search row.
182 * currently the links added for each row are
191 static function &links() {
192 $args = func_get_args();
193 $hideOption = CRM_Utils_Array
::value(0, $args);
194 $key = CRM_Utils_Array
::value(1, $args);
196 $extraParams = ($key) ?
"&key={$key}" : NULL;
198 $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?');
199 self
::$_links = array(
200 CRM_Core_Action
::VIEW
=> array(
201 'name' => ts('View'),
202 'url' => 'civicrm/contact/view/pledge',
203 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=pledge' . $extraParams,
204 'title' => ts('View Pledge'),
206 CRM_Core_Action
::UPDATE
=> array(
207 'name' => ts('Edit'),
208 'url' => 'civicrm/contact/view/pledge',
209 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
210 'title' => ts('Edit Pledge'),
212 CRM_Core_Action
::DETACH
=> array(
213 'name' => ts('Cancel'),
214 'url' => 'civicrm/contact/view/pledge',
215 'qs' => 'reset=1&action=detach&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
216 'extra' => 'onclick = "return confirm(\'' . $cancelExtra . '\');"',
217 'title' => ts('Cancel Pledge'),
219 CRM_Core_Action
::DELETE
=> array(
220 'name' => ts('Delete'),
221 'url' => 'civicrm/contact/view/pledge',
222 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
223 'title' => ts('Delete Pledge'),
228 if (in_array('Cancel', $hideOption)) {
229 unset(self
::$_links[CRM_Core_Action
::DETACH
]);
232 return self
::$_links;
237 * getter for array of the parameters required for creating pager.
242 function getPagerParams($action, &$params) {
243 $params['status'] = ts('Pledge') . ' %%StatusMessage%%';
244 $params['csvString'] = NULL;
246 $params['rowCount'] = $this->_limit
;
249 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
252 $params['buttonTop'] = 'PagerTopButton';
253 $params['buttonBottom'] = 'PagerBottomButton';
258 * Returns total number of rows for the query.
262 * @return int Total number of rows
265 function getTotalCount($action) {
266 return $this->_query
->searchQuery(0, 0, NULL,
270 $this->_additionalClause
275 * returns all the rows in the given offset and rowCount
277 * @param enum $action the action being performed
278 * @param int $offset the row number to start from
279 * @param int $rowCount the number of rows to return
280 * @param string $sort the sql string that describes the sort order
281 * @param enum $output what should the result set include (web/email/csv)
283 * @return int the total number of rows for this action
285 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
286 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
290 $this->_additionalClause
293 // process the result of the query
296 // get all pledge status
297 $pledgeStatuses = CRM_Core_OptionGroup
::values('contribution_status',
298 FALSE, FALSE, FALSE, NULL, 'name', FALSE
302 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
304 //4418 check for view, edit and delete
305 $permissions = array(CRM_Core_Permission
::VIEW
);
306 if (CRM_Core_Permission
::check('edit pledges')) {
307 $permissions[] = CRM_Core_Permission
::EDIT
;
309 if (CRM_Core_Permission
::check('delete in CiviPledge')) {
310 $permissions[] = CRM_Core_Permission
::DELETE
;
312 $mask = CRM_Core_Action
::mask($permissions);
314 while ($result->fetch()) {
316 // the columns we are interested in
317 foreach (self
::$_properties as $property) {
318 if (isset($result->$property)) {
319 $row[$property] = $result->$property;
323 //carry campaign on selectors.
324 $row['campaign'] = CRM_Utils_Array
::value($result->pledge_campaign_id
, $allCampaigns);
325 $row['campaign_id'] = $result->pledge_campaign_id
;
327 // add pledge status name
328 $row['pledge_status_name'] = CRM_Utils_Array
::value($row['pledge_status_id'],
331 // append (test) to status label
332 if (CRM_Utils_Array
::value('pledge_is_test', $row)) {
333 $row['pledge_status'] .= ' (test)';
336 $hideOption = array();
337 if (CRM_Utils_Array
::key('Cancelled', $row) ||
338 CRM_Utils_Array
::key('Completed', $row)
340 $hideOption[] = 'Cancel';
343 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->pledge_id
;
345 $row['action'] = CRM_Core_Action
::formLink(self
::links($hideOption, $this->_key
),
348 'id' => $result->pledge_id
,
349 'cid' => $result->contact_id
,
350 'cxt' => $this->_context
,
355 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
356 $result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
365 * @return array $qill which contains an array of strings
369 // the current internationalisation is bad, but should more or less work
370 // for most of "European" languages
371 public function getQILL() {
372 return $this->_query
->qill();
376 * returns the column headers as an array of tuples:
377 * (name, sortName (key to the sort array))
379 * @param string $action the action being performed
380 * @param enum $output what should the result set include (web/email/csv)
382 * @return array the column headers that need to be displayed
385 public function &getColumnHeaders($action = NULL, $output = NULL) {
386 if (!isset(self
::$_columnHeaders)) {
387 self
::$_columnHeaders = array(
389 'name' => ts('Pledged'),
390 'sort' => 'pledge_amount',
391 'direction' => CRM_Utils_Sort
::DONTCARE
,
394 'name' => ts('Total Paid'),
395 'sort' => 'pledge_total_paid',
396 'direction' => CRM_Utils_Sort
::DONTCARE
,
399 'name' => ts('Balance'),
402 'name' => ts('Pledged For'),
403 'sort' => 'pledge_contribution_type',
404 'direction' => CRM_Utils_Sort
::DONTCARE
,
407 'name' => ts('Pledge Made'),
408 'sort' => 'pledge_create_date',
409 'direction' => CRM_Utils_Sort
::DESCENDING
,
412 'name' => ts('Next Pay Date'),
413 'sort' => 'pledge_next_pay_date',
414 'direction' => CRM_Utils_Sort
::DONTCARE
,
417 'name' => ts('Next Amount'),
418 'sort' => 'pledge_next_pay_amount',
419 'direction' => CRM_Utils_Sort
::DONTCARE
,
422 'name' => ts('Status'),
423 'sort' => 'pledge_status',
424 'direction' => CRM_Utils_Sort
::DONTCARE
,
426 array('desc' => ts('Actions')),
429 if (!$this->_single
) {
431 array('desc' => ts('Contact Id')),
433 'name' => ts('Name'),
434 'sort' => 'sort_name',
435 'direction' => CRM_Utils_Sort
::DONTCARE
,
439 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
442 return self
::$_columnHeaders;
445 function &getQuery() {
446 return $this->_query
;
450 * name of export file.
452 * @param string $output type of output
454 * @return string name of the file
456 function getExportFileName($output = 'csv') {
457 return ts('Pledge Search');