CRM/Contact/Form/Task/Print.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 provides the functionality to save a search
  38  * Saved Searches are used for saving frequently used queries
  39  */
  40 class CRM_Contact_Form_Task_Print extends CRM_Contact_Form_Task {
  41
  42   /**
  43    * build all the data structures needed to build the form
  44    *
  45    * @return void
  46    * @access public
  47    */
  48   function preProcess() {
  49     parent::preprocess();
  50
  51     // set print view, so that print templates are called
  52     $this->controller->setPrint(1);
  53     $this->assign('id', $this->get('id'));
  54     $this->assign('pageTitle', ts('CiviCRM Contact Listing'));
  55
  56     $params = $this->get('queryParams');
  57     if (!empty($this->_contactIds)) {
  58       //using _contactIds field for creating params for query so that multiple selections on multiple pages
  59       //can be printed.
  60     foreach ($this->_contactIds as $contactId) {
  61         $params[] = array(
  62           CRM_Core_Form::CB_PREFIX . $contactId,
  63           '=',
  64           1, 0, 0);
  65     }
  66     }
  67
  68     // create the selector, controller and run - store results in session
  69     $fv = $this->get('formValues');
  70     $returnProperties = $this->get('returnProperties');
  71
  72     $sortID = NULL;
  73     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
  74       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
  75         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
  76       );
  77     }
  78
  79     $includeContactIds = FALSE;
  80     if ($fv['radio_ts'] == 'ts_sel') {
  81       $includeContactIds = TRUE;
  82     }
  83
  84     $selectorName = $this->controller->selectorName();
  85     require_once (str_replace('_', DIRECTORY_SEPARATOR, $selectorName) . '.php');
  86
  87     $returnP = isset($returnPropeties) ? $returnPropeties : "";
  88     $customSearchClass = $this->get('customSearchClass');
  89     $selector   = new $selectorName( $customSearchClass,
  90                  $fv,
  91                  $params,
  92                  $returnP,
  93                  $this->_action,
  94                  $includeContactIds
  95       );
  96     $controller = new CRM_Core_Selector_Controller($selector,
  97       NULL,
  98       $sortID,
  99       CRM_Core_Action::VIEW,
 100       $this,
 101       CRM_Core_Selector_Controller::SCREEN
 102     );
 103     $controller->setEmbedded(TRUE);
 104     $controller->run();
 105   }
 106
 107   /**
 108    * Build the form - it consists of
 109    *    - displaying the QILL (query in local language)
 110    *    - displaying elements for saving the search
 111    *
 112    * @access public
 113    *
 114    * @return void
 115    */
 116   function buildQuickForm() {
 117     //
 118     // just need to add a javacript to popup the window for printing
 119     //
 120     $this->addButtons(array(
 121         array(
 122           'type' => 'next',
 123           'name' => ts('Print Contact List'),
 124           'js' => array('onclick' => 'window.print()'),
 125           'isDefault' => TRUE,
 126         ),
 127         array(
 128           'type' => 'back',
 129           'name' => ts('Done'),
 130         ),
 131       )
 132     );
 133   }
 134
 135   /**
 136    * process the form after the input has been submitted and validated
 137    *
 138    * @access public
 139    *
 140    * @return void
 141    */
 142   public function postProcess() {
 143     // redirect to the main search page after printing is over
 144   }
 145 }
 146