CRM/Member/Form/Task/PDFLetter.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  * $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_Member_Form_Task_PDFLetter extends CRM_Member_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    */
  58   public function preProcess() {
  59     $this->skipOnHold = $this->skipDeceased = FALSE;
  60     parent::preProcess();
  61     $this->setContactIDs();
  62     CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this);
  63   }
  64
  65   /**
  66    * Set defaults.
  67    * (non-PHPdoc)
  68    * @see CRM_Core_Form::setDefaultValues()
  69    */
  70   public function setDefaultValues() {
  71     return CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
  72   }
  73
  74   /**
  75    * Build the form object.
  76    *
  77    *
  78    * @return void
  79    */
  80   public function buildQuickForm() {
  81     //enable form element
  82     $this->assign('suppressForm', FALSE);
  83     CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($this);
  84   }
  85
  86   /**
  87    * Process the form after the input has been submitted and validated.
  88    *
  89    *
  90    * @return void
  91    */
  92   public function postProcess() {
  93     // TODO: rewrite using contribution token and one letter by contribution
  94     $this->setContactIDs();
  95     $skipOnHold = isset($this->skipOnHold) ? $this->skipOnHold : FALSE;
  96     $skipDeceased = isset($this->skipDeceased) ? $this->skipDeceased : TRUE;
  97     CRM_Member_Form_Task_PDFLetterCommon::postProcessMembers(
  98       $this, $this->_memberIds, $skipOnHold, $skipDeceased, $this->_contactIds
  99     );
 100   }
 101
 102   /**
 103    * List available tokens for this form.
 104    *
 105    * @return array
 106    */
 107   public function listTokens() {
 108     $tokens = CRM_Core_SelectValues::contactTokens();
 109     $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens);
 110     return $tokens;
 111   }
 112
 113 }