CRM/Contribute/Form/Task/PDFLetter.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 /**
  35  * This class provides the functionality to create PDF letter for a group of contacts or a single contact.
  36  */
  37 class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task {
  38
  39   /**
  40    * All the existing templates in the system.
  41    *
  42    * @var array
  43    */
  44   public $_templates = NULL;
  45
  46   public $_single = NULL;
  47
  48   public $_cid = NULL;
  49
  50   /**
  51    * Build all the data structures needed to build the form.
  52    *
  53    * @return void
  54    */
  55   public function preProcess() {
  56     $this->skipOnHold = $this->skipDeceased = FALSE;
  57     CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this);
  58     // store case id if present
  59     $this->_caseId = CRM_Utils_Request::retrieve('caseid', 'Positive', $this, FALSE);
  60
  61     // retrieve contact ID if this is 'single' mode
  62     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE);
  63
  64     $this->_activityId = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
  65
  66     if ($cid) {
  67       CRM_Contact_Form_Task_PDFLetterCommon::preProcessSingle($this, $cid);
  68       $this->_single = TRUE;
  69       $this->_cid = $cid;
  70     }
  71     else {
  72       parent::preProcess();
  73     }
  74     $this->assign('single', $this->_single);
  75   }
  76
  77   /**
  78    * This virtual function is used to set the default values of
  79    * various form elements
  80    *
  81    * access        public
  82    *
  83    * @return array
  84    *   reference to the array of default values
  85    */
  86   /**
  87    * @return array
  88    */
  89   public function setDefaultValues() {
  90     $defaults = array();
  91     if (isset($this->_activityId)) {
  92       $params = array('id' => $this->_activityId);
  93       CRM_Activity_BAO_Activity::retrieve($params, $defaults);
  94       $defaults['html_message'] = CRM_Utils_Array::value('details', $defaults);
  95     }
  96     else {
  97       $defaults['thankyou_update'] = 1;
  98     }
  99     $defaults = $defaults + CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
 100     return $defaults;
 101   }
 102
 103   /**
 104    * Build the form object.
 105    *
 106    *
 107    * @return void
 108    */
 109   public function buildQuickForm() {
 110     //enable form element
 111     $this->assign('suppressForm', FALSE);
 112
 113     // use contact form as a base
 114     CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($this);
 115
 116     // specific need for contributions
 117     $this->add('static', 'more_options_header', NULL, ts('Thank-you Letter Options'));
 118     $this->add('checkbox', 'receipt_update', ts('Update receipt dates for these contributions'), FALSE);
 119     $this->add('checkbox', 'thankyou_update', ts('Update thank-you dates for these contributions'), FALSE);
 120
 121     // Group options for tokens are not yet implemented. dgg
 122     $options = array(
 123       '' => ts('- no grouping -'),
 124       'contact_id' => ts('Contact'),
 125       'contribution_recur_id' => ts('Contact and Recurring'),
 126       'financial_type_id' => ts('Contact and Financial Type'),
 127       'campaign_id' => ts('Contact and Campaign'),
 128       'payment_instrument_id' => 'Contact and Payment Instrument',
 129     );
 130     $this->addElement('select', 'group_by', ts('Group contributions by'), $options, array(), "<br/>", FALSE);
 131     // this was going to be free-text but I opted for radio options in case there was a script injection risk
 132     $separatorOptions = array('comma' => 'Comma', 'td' => 'Table Cell');
 133     $this->addElement('select', 'group_by_separator', ts('Separator (grouped contributions)'), $separatorOptions);
 134     $emailOptions = array(
 135       '' => ts('Generate PDFs for printing (only)'),
 136       'email' => ts('Send emails where possible. Generate printable PDFs for contacts who cannot receive email.'),
 137       'both' => ts('Send emails where possible. Generate printable PDFs for all contacts.'),
 138     );
 139     if (CRM_Core_Config::singleton()->doNotAttachPDFReceipt) {
 140       $emailOptions['pdfemail'] = ts('Send emails with an attached PDF where possible. Generate printable PDFs for contacts who cannot receive email.');
 141       $emailOptions['pdfemail_both'] = ts('Send emails with an attached PDF where possible. Generate printable PDFs for all contacts.');
 142     }
 143     $this->addElement('select', 'email_options', ts('Print and email options'), $emailOptions, array(), "<br/>", FALSE);
 144
 145     $this->addButtons(array(
 146         array(
 147           'type' => 'submit',
 148           'name' => ts('Make Thank-you Letters'),
 149           'isDefault' => TRUE,
 150         ),
 151         array(
 152           'type' => 'cancel',
 153           'name' => ts('Done'),
 154         ),
 155       )
 156     );
 157
 158   }
 159
 160   /**
 161    * Process the form after the input has been submitted and validated.
 162    *
 163    *
 164    * @return void
 165    */
 166   public function postProcess() {
 167     CRM_Contribute_Form_Task_PDFLetterCommon::postProcess($this);
 168   }
 169
 170 }