CRM/Contact/Form/Task/Print.php

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