CRM/Case/Form/Task/PDF.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This class provides the functionality to create PDF letter for a group of contacts.
  36  */
  37 class CRM_Case_Form_Task_PDF extends CRM_Case_Form_Task {
  38   /**
  39    * All the existing templates in the system.
  40    *
  41    * @var array
  42    */
  43   public $_templates = NULL;
  44
  45   public $_single = NULL;
  46
  47   public $_cid = NULL;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    */
  52   public function preProcess() {
  53     CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this);
  54     $this->skipOnHold = $this->skipDeceased = FALSE;
  55     parent::preProcess();
  56     $this->setContactIDs();
  57   }
  58
  59   /**
  60    * Set defaults for the pdf.
  61    *
  62    * @return array
  63    */
  64   public function setDefaultValues() {
  65     return CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
  66   }
  67
  68   /**
  69    * Build the form object.
  70    */
  71   public function buildQuickForm() {
  72     CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($this);
  73   }
  74
  75   /**
  76    * Process the form after the input has been submitted and validated.
  77    */
  78   public function postProcess() {
  79     CRM_Contact_Form_Task_PDFLetterCommon::postProcess($this);
  80   }
  81
  82   /**
  83    * List available tokens for this form.
  84    *
  85    * @return array
  86    */
  87   public function listTokens() {
  88     $tokens = CRM_Core_SelectValues::contactTokens();
  89     foreach ($this->_entityIds as $key => $caseId) {
  90       $caseTypeId = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $caseId, 'case_type_id');
  91       $tokens += CRM_Core_SelectValues::caseTokens($caseTypeId);
  92     }
  93     return $tokens;
  94   }
  95
  96 }