2d3e3c7b |
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_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 | * @access public |
58 | */ |
59 | function preProcess() { |
60 | $this->skipOnHold = $this->skipDeceased = FALSE; |
61 | parent::preProcess(); |
62 | $this->setContactIDs(); |
63 | CRM_Contact_Form_Task_PDFLetterCommon::preProcess($this); |
64 | } |
65 | |
66 | /** |
67 | * Set defaults |
68 | * (non-PHPdoc) |
69 | * @see CRM_Core_Form::setDefaultValues() |
70 | */ |
71 | function setDefaultValues() { |
72 | return CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues(); |
73 | } |
74 | |
75 | /** |
76 | * Build the form |
77 | * |
78 | * @access public |
79 | * |
80 | * @return void |
81 | */ |
82 | public function buildQuickForm() { |
83 | //enable form element |
84 | $this->assign('suppressForm', FALSE); |
2d3e3c7b |
85 | CRM_Contact_Form_Task_PDFLetterCommon::buildQuickForm($this); |
2d3e3c7b |
86 | } |
87 | |
88 | /** |
89 | * process the form after the input has been submitted and validated |
90 | * |
91 | * @access public |
92 | * |
93 | * @return None |
94 | */ |
95 | public function postProcess() { |
96 | // TODO: rewrite using contribution token and one letter by contribution |
97 | $this->setContactIDs(); |
98 | $skipOnHold = isset($this->skipOnHold) ? $this->skipOnHold : FALSE; |
99 | $skipDeceased = isset($this->skipDeceased) ? $this->skipDeceased : TRUE; |
100 | CRM_Member_Form_Task_PDFLetterCommon::postProcess($this, $this->_memberIds, $skipOnHold, $skipDeceased, $this->_contactIds); |
101 | } |
102 | |
103 | /** |
104 | * list available tokens, at time of writing these were |
105 | * {membership.id} => Membership ID |
106 | * {membership.status} => Membership Status |
107 | * {membership.type} => Membership Type |
108 | * {membership.start_date} => Membership Start Date |
109 | * {membership.join_date} => Membership Join Date |
110 | * {membership.end_date} => Membership End Date |
111 | * {membership.fee} => Membership Fee |
112 | * @return Ambigous <NULL, multitype:string Ambigous <string, string> > |
113 | */ |
114 | public function listTokens() { |
115 | return CRM_Core_SelectValues::membershipTokens(); |
116 | } |
117 | } |
118 | |