CRM/Pledge/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  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.
  40  *
  41  */
  42 class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
  43
  44   /**
  45    * This defines two actions- View and Edit.
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * we use desc to remind us what that column is, name is used in the tpl
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_columnHeaders;
  59
  60   /**
  61    * Properties of contact we're interested in displaying
  62    * @var array
  63    * @static
  64    */
  65   static $_properties = array(
  66     'contact_id',
  67     'sort_name',
  68     'display_name',
  69     'pledge_id',
  70     'pledge_amount',
  71     'pledge_create_date',
  72     'pledge_total_paid',
  73     'pledge_next_pay_date',
  74     'pledge_next_pay_amount',
  75     'pledge_outstanding_amount',
  76     'pledge_status_id',
  77     'pledge_status',
  78     'pledge_is_test',
  79     'pledge_contribution_page_id',
  80     'pledge_contribution_type',
  81     'pledge_campaign_id',
  82     'pledge_currency',
  83   );
  84
  85   /**
  86    * are we restricting ourselves to a single contact
  87    *
  88    * @access protected
  89    * @var boolean
  90    */
  91   protected $_single = FALSE;
  92
  93   /**
  94    * are we restricting ourselves to a single contact
  95    *
  96    * @access protected
  97    * @var boolean
  98    */
  99   protected $_limit = NULL;
 100
 101   /**
 102    * what context are we being invoked from
 103    *
 104    * @access protected
 105    * @var string
 106    */
 107   protected $_context = NULL;
 108
 109   /**
 110    * queryParams is the array returned by exportValues called on
 111    * the HTML_QuickForm_Controller for that page.
 112    *
 113    * @var array
 114    * @access protected
 115    */
 116   public $_queryParams;
 117
 118   /**
 119    * represent the type of selector
 120    *
 121    * @var int
 122    * @access protected
 123    */
 124   protected $_action;
 125
 126   /**
 127    * The additional clause that we restrict the search with
 128    *
 129    * @var string
 130    */
 131   protected $_additionalClause = NULL;
 132
 133   /**
 134    * The query object
 135    *
 136    * @var string
 137    */
 138   protected $_query;
 139
 140   /**
 141    * Class constructor
 142    *
 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
 148    *
 149    * @return CRM_Contact_Selector
 150    * @access public
 151    */
 152   function __construct(&$queryParams,
 153     $action           = CRM_Core_Action::NONE,
 154     $additionalClause = NULL,
 155     $single           = FALSE,
 156     $limit            = NULL,
 157     $context          = 'search'
 158   ) {
 159     // submitted form values
 160     $this->_queryParams = &$queryParams;
 161
 162     $this->_single  = $single;
 163     $this->_limit   = $limit;
 164     $this->_context = $context;
 165
 166     $this->_additionalClause = $additionalClause;
 167
 168     // type of selector
 169     $this->_action = $action;
 170
 171     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams, NULL, NULL, FALSE, FALSE,
 172       CRM_Contact_BAO_Query::MODE_PLEDGE
 173     );
 174
 175     $this->_query->_distinctComponentClause = "civicrm_pledge.id";
 176     $this->_query->_groupByComponentClause = " GROUP BY civicrm_pledge.id ";
 177   }
 178   //end of constructor
 179
 180   /**
 181    * This method returns the links that are given for each search row.
 182    * currently the links added for each row are
 183    *
 184    * - View
 185    * - Edit
 186    *
 187    * @return array
 188    * @access public
 189    *
 190    */
 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);
 195
 196     $extraParams = ($key) ? "&key={$key}" : NULL;
 197
 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'),
 205       ),
 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'),
 211       ),
 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'),
 218       ),
 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'),
 224       ),
 225     );
 226
 227
 228     if (in_array('Cancel', $hideOption)) {
 229       unset(self::$_links[CRM_Core_Action::DETACH]);
 230     }
 231
 232     return self::$_links;
 233   }
 234   //end of function
 235
 236   /**
 237    * getter for array of the parameters required for creating pager.
 238    *
 239    * @param
 240    * @access public
 241    */
 242   function getPagerParams($action, &$params) {
 243     $params['status'] = ts('Pledge') . ' %%StatusMessage%%';
 244     $params['csvString'] = NULL;
 245     if ($this->_limit) {
 246       $params['rowCount'] = $this->_limit;
 247     }
 248     else {
 249       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 250     }
 251
 252     $params['buttonTop'] = 'PagerTopButton';
 253     $params['buttonBottom'] = 'PagerBottomButton';
 254   }
 255   //end of function
 256
 257   /**
 258    * Returns total number of rows for the query.
 259    *
 260    * @param
 261    *
 262    * @return int Total number of rows
 263    * @access public
 264    */
 265   function getTotalCount($action) {
 266     return $this->_query->searchQuery(0, 0, NULL,
 267       TRUE, FALSE,
 268       FALSE, FALSE,
 269       FALSE,
 270       $this->_additionalClause
 271     );
 272   }
 273
 274   /**
 275    * returns all the rows in the given offset and rowCount
 276    *
 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)
 282    *
 283    * @return int   the total number of rows for this action
 284    */
 285   function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 286     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 287       FALSE, FALSE,
 288       FALSE, FALSE,
 289       FALSE,
 290       $this->_additionalClause
 291     );
 292
 293     // process the result of the query
 294     $rows = array();
 295
 296     // get all pledge status
 297     $pledgeStatuses = CRM_Core_OptionGroup::values('contribution_status',
 298       FALSE, FALSE, FALSE, NULL, 'name', FALSE
 299     );
 300
 301     //get all campaigns.
 302     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 303
 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;
 308     }
 309     if (CRM_Core_Permission::check('delete in CiviPledge')) {
 310       $permissions[] = CRM_Core_Permission::DELETE;
 311     }
 312     $mask = CRM_Core_Action::mask($permissions);
 313
 314     while ($result->fetch()) {
 315       $row = array();
 316       // the columns we are interested in
 317       foreach (self::$_properties as $property) {
 318         if (isset($result->$property)) {
 319           $row[$property] = $result->$property;
 320         }
 321       }
 322
 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;
 326
 327       // add pledge status name
 328       $row['pledge_status_name'] = CRM_Utils_Array::value($row['pledge_status_id'],
 329         $pledgeStatuses
 330       );
 331       // append (test) to status label
 332       if (CRM_Utils_Array::value('pledge_is_test', $row)) {
 333         $row['pledge_status'] .= ' (test)';
 334       }
 335
 336       $hideOption = array();
 337       if (CRM_Utils_Array::key('Cancelled', $row) ||
 338         CRM_Utils_Array::key('Completed', $row)
 339       ) {
 340         $hideOption[] = 'Cancel';
 341       }
 342
 343       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->pledge_id;
 344
 345       $row['action'] = CRM_Core_Action::formLink(self::links($hideOption, $this->_key),
 346         $mask,
 347         array(
 348           'id' => $result->pledge_id,
 349           'cid' => $result->contact_id,
 350           'cxt' => $this->_context,
 351         )
 352       );
 353
 354
 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
 357       );
 358       $rows[] = $row;
 359     }
 360     return $rows;
 361   }
 362
 363   /**
 364    *
 365    * @return array  $qill    which contains an array of strings
 366    * @access public
 367    */
 368
 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();
 373   }
 374
 375   /**
 376    * returns the column headers as an array of tuples:
 377    * (name, sortName (key to the sort array))
 378    *
 379    * @param string $action the action being performed
 380    * @param enum   $output what should the result set include (web/email/csv)
 381    *
 382    * @return array the column headers that need to be displayed
 383    * @access public
 384    */
 385   public function &getColumnHeaders($action = NULL, $output = NULL) {
 386     if (!isset(self::$_columnHeaders)) {
 387       self::$_columnHeaders = array(
 388         array(
 389           'name' => ts('Pledged'),
 390           'sort' => 'pledge_amount',
 391           'direction' => CRM_Utils_Sort::DONTCARE,
 392         ),
 393         array(
 394           'name' => ts('Total Paid'),
 395           'sort' => 'pledge_total_paid',
 396           'direction' => CRM_Utils_Sort::DONTCARE,
 397         ),
 398         array(
 399           'name' => ts('Balance'),
 400         ),
 401         array(
 402           'name' => ts('Pledged For'),
 403           'sort' => 'pledge_contribution_type',
 404           'direction' => CRM_Utils_Sort::DONTCARE,
 405         ),
 406         array(
 407           'name' => ts('Pledge Made'),
 408           'sort' => 'pledge_create_date',
 409           'direction' => CRM_Utils_Sort::DESCENDING,
 410         ),
 411         array(
 412           'name' => ts('Next Pay Date'),
 413           'sort' => 'pledge_next_pay_date',
 414           'direction' => CRM_Utils_Sort::DONTCARE,
 415         ),
 416         array(
 417           'name' => ts('Next Amount'),
 418           'sort' => 'pledge_next_pay_amount',
 419           'direction' => CRM_Utils_Sort::DONTCARE,
 420         ),
 421         array(
 422           'name' => ts('Status'),
 423           'sort' => 'pledge_status',
 424           'direction' => CRM_Utils_Sort::DONTCARE,
 425         ),
 426         array('desc' => ts('Actions')),
 427       );
 428
 429       if (!$this->_single) {
 430         $pre = array(
 431           array('desc' => ts('Contact Id')),
 432           array(
 433             'name' => ts('Name'),
 434             'sort' => 'sort_name',
 435             'direction' => CRM_Utils_Sort::DONTCARE,
 436           ),
 437         );
 438
 439         self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 440       }
 441     }
 442     return self::$_columnHeaders;
 443   }
 444
 445   function &getQuery() {
 446     return $this->_query;
 447   }
 448
 449   /**
 450    * name of export file.
 451    *
 452    * @param string $output type of output
 453    *
 454    * @return string name of the file
 455    */
 456   function getExportFileName($output = 'csv') {
 457     return ts('Pledge Search');
 458   }
 459 }
 460 //end of class
 461