crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Contribute/Form/Task/PDFLatex.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   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 create PDF letter for a group of
  38  * contacts or a single contact.
  39  */
  40 class CRM_Contribute_Form_Task_PDFLatex extends CRM_Contribute_Form_Task {
  41
  42   /**
  43    * all the existing templates in the system
  44    *
  45    * @var array
  46    */
  47   public $_templates = NULL;
  48
  49   public $_single = NULL;
  50
  51   public $_cid = NULL;
  52
  53   /**
  54    * build all the data structures needed to build the form
  55    *
  56    * @return void
  57    * @access public
  58    */
  59   function preProcess() {
  60     $this->skipOnHold = $this->skipDeceased = FALSE;
  61     CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this);
  62
  63     // store case id if present
  64     $this->_caseId = CRM_Utils_Request::retrieve('caseid', 'Positive', $this, FALSE);
  65
  66     // retrieve contact ID if this is 'single' mode
  67     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE);
  68
  69     $this->_activityId = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
  70
  71     if ($cid) {
  72       CRM_Contact_Form_Task_PDFLetterCommon::preProcessSingle($this, $cid);
  73       $this->_single = TRUE;
  74       $this->_cid = $cid;
  75     }
  76     else {
  77       parent::preProcess();
  78     }
  79     $this->assign('single', $this->_single);
  80   }
  81
  82   function setDefaultValues() {
  83     $defaults = array();
  84     if (isset($this->_activityId)) {
  85       $params = array('id' => $this->_activityId);
  86       CRM_Activity_BAO_Activity::retrieve($params, $defaults);
  87       $defaults['html_message'] = $defaults['details'];
  88     }
  89     $defaults = $defaults + CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
  90     return $defaults;
  91   }
  92
  93   /**
  94    * Build the form
  95    *
  96    * @access public
  97    *
  98    * @return void
  99    */
 100   public function buildQuickForm() {
 101     //enable form element
 102     $this->assign('suppressForm', FALSE);
 103
 104     // use contact form as a base
 105     CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($this);
 106
 107     // specific need for contributions
 108     $this->add('static', 'more_options_header', NULL, ts('Record Update Options'));
 109     $this->add('checkbox', 'receipt_update', ts('Update receipt dates for these contributions'), FALSE);
 110     $this->add('checkbox', 'thankyou_update', ts('Update thank-you dates for these contributions'), FALSE);
 111
 112     // Group options for tokens are not yet implemented. dgg
 113     $options = array(ts('Contact'), ts('Recurring'));
 114     $this->addRadio('is_group_by', ts('Grouping contributions in one letter based on'), $options, array(), "<br/>", FALSE);
 115
 116     $this->addButtons(array(
 117         array(
 118           'type' => 'submit',
 119           'name' => ts('Make Thank-you Letters'),
 120           'isDefault' => TRUE,
 121         ),
 122         array(
 123           'type' => 'cancel',
 124           'name' => ts('Done'),
 125         ),
 126       )
 127     );
 128
 129   }
 130
 131   /**
 132    * process the form after the input has been submitted and validated
 133    *
 134    * @access public
 135    *
 136    * @return None
 137    */
 138   public function postProcess() {
 139     // TODO: rewrite using contribution token and one letter by contribution
 140     $this->setContactIDs();
 141
 142                 CRM_Contribute_Form_Task_PDFLatexCommon::postProcess($this);
 143   }
 144
 145
 146 }
 147