FormField.php
3.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?php
/*
PHPRtfLite
Copyright 2010-2012 Steffen Zeidler <sigma_z@sigma-scripts.de>
This file is part of PHPRtfLite.
PHPRtfLite is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PHPRtfLite is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PHPRtfLite. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* abstract class for form fields in rtf documents.
* @version 1.2
* @author Steffen Zeidler <sigma_z@sigma-scripts.de>
* @copyright 2010-2012 Steffen Zeidler
* @package PHPRtfLite
* @subpackage PHPRtfLite_FormField
*/
abstract class PHPRtfLite_FormField
{
/**
* rtf instance
* @var PHPRtfLite
*/
protected $_rtf;
/**
* font instance
* @var PHPRtfLite_Font
*/
protected $_font;
/**
* par format instance
* @var PHPRtfLite_ParFormat
*/
protected $_parFormat;
/**
* default value
* @var string
*/
protected $_defaultValue;
/**
* abstract method to get the form field's specific rtf code
*
* @return string
*/
abstract protected function getRtfCode();
/**
* abstract method to get the form field's type
*
* @return string
*/
abstract protected function getType();
/**
* constructor
*
* @param PHPRtfLite $rtf
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
*/
public function __construct(PHPRtfLite $rtf, PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$this->_rtf = $rtf;
$this->_font = $font;
$this->_parFormat = $parFormat;
if ($font) {
$this->_rtf->registerFont($font);
}
}
/**
* sets default value
*
* @param string $value
*/
public function setDefaultValue($value)
{
$this->_defaultValue = $value;
}
/**
* gets font instance
*
* @return PHPRtfLite_Font
*/
public function getFont()
{
return $this->_font;
}
/**
* gets par format instance
*
* @return PHPRtfLite_ParFormat
*/
public function getParFormat()
{
return $this->_parFormat;
}
/**
* renders form field
*/
public function render()
{
$stream = $this->_rtf->getWriter();
$stream->write(' ');
if ($this->_font) {
$stream->write('{' . $this->_font->getContent());
}
$defaultValue = PHPRtfLite_Utf8::getUnicodeEntities($this->_defaultValue, $this->_rtf->getCharset());
$content = '{\field'
. '{\*\fldinst ' . $this->getType()
. ' {\*\formfield' . $this->getRtfCode() . '}'
. '}{\fldrslt ' . $defaultValue . '}}';
$stream->write($content);
if ($this->_font) {
$stream->write($this->_font->getClosingContent() . '}');
}
$stream->write(' ');
}
}