CRM/Contribute/Form/Task/Print.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to print contribution records
  38  */
  39 class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task {
  40
  41   /**
  42    * build all the data structures needed to build the form
  43    *
  44    * @return void
  45    * @access public
  46    */
  47   function preProcess() {
  48     parent::preprocess();
  49
  50     // set print view, so that print templates are called
  51     $this->controller->setPrint(1);
  52
  53     // get the formatted params
  54     $queryParams = $this->get('queryParams');
  55
  56     $sortID = NULL;
  57     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
  58       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
  59         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
  60       );
  61     }
  62
  63     $selector = new CRM_Contribute_Selector_Search($queryParams, $this->_action, $this->_componentClause);
  64     $controller = new CRM_Core_Selector_Controller($selector, NULL, $sortID, CRM_Core_Action::VIEW, $this, CRM_Core_Selector_Controller::SCREEN);
  65     $controller->setEmbedded(TRUE);
  66     $controller->run();
  67   }
  68
  69   /**
  70    * Build the form object - it consists of
  71    *    - displaying the QILL (query in local language)
  72    *    - displaying elements for saving the search
  73    *
  74    * @access public
  75    *
  76    * @return void
  77    */
  78   function buildQuickForm() {
  79     //
  80     // just need to add a javacript to popup the window for printing
  81     //
  82     $this->addButtons(array(
  83         array(
  84           'type' => 'next',
  85           'name' => ts('Print Contributions'),
  86           'js' => array('onclick' => 'window.print()'),
  87           'isDefault' => TRUE,
  88         ),
  89         array(
  90           'type' => 'back',
  91           'name' => ts('Done'),
  92         ),
  93       )
  94     );
  95   }
  96
  97   /**
  98    * process the form after the input has been submitted and validated
  99    *
 100    * @access public
 101    *
 102    * @return void
 103    */
 104   public function postProcess() {
 105     // redirect to the main search page after printing is over
 106   }
 107 }
 108