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
152
153
154
155
156
157
158
159
160
161
162
|
<?php
/*
* $Id: TidyFilter.php,v 1.2 2005/12/08 19:15:20 hlellelid Exp $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
include_once 'phing/filters/BaseParamFilterReader.php';
include_once 'phing/filters/ChainableReader.php';
/**
* This filter uses the bundled-with-PHP Tidy extension to filter input.
*
* <p>
* Example:<br/>
* <pre>
* <tidyfilter encoding="utf8">
* <config name="indent" value="true"/>
* <config name="output-xhtml" value="true"/>
* </tidyfilter>
* </pre>
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.2 $ $Date: 2005/12/08 19:15:20 $
* @package phing.filters
*/
class TidyFilter extends BaseParamFilterReader implements ChainableReader {
/** @var string Encoding of resulting document. */
private $encoding = 'utf8';
/** @var array Parameter[] */
private $configParameters = array();
/**
* Set the encoding for resulting (X)HTML document.
* @param string $v
*/
public function setEncoding($v) {
$this->encoding = $v;
}
/**
* Sets the config params.
* @param array Parameter[]
* @see chain()
*/
public function setConfigParameters($params)
{
$this->configParameters = $params;
}
/**
* Adds a <config> element (which is a Parameter).
* @return Parameter
*/
public function createConfig() {
$num = array_push($this->configParameters, new Parameter());
return $this->configParameters[$num-1];
}
/**
* Converts the Parameter objects being used to store configuration into a simle assoc array.
* @return array
*/
private function getDistilledConfig() {
$config = array();
foreach($this->configParameters as $p) {
$config[$p->getName()] = $p->getValue();
}
return $config;
}
/**
* Reads input and returns Tidy-filtered output.
*
* @return the resulting stream, or -1 if the end of the resulting stream has been reached
*
* @throws IOException if the underlying stream throws an IOException
* during reading
*/
function read($len = null) {
if (!class_exists('Tidy')) {
throw new BuildException("You must enable the 'tidy' extension in your PHP configuration in order to use the Tidy filter.");
}
if ( !$this->getInitialized() ) {
$this->_initialize();
$this->setInitialized(true);
}
$buffer = $this->in->read($len);
if($buffer === -1) {
return -1;
}
$config = $this->getDistilledConfig();
$tidy = new Tidy();
$tidy->parseString($buffer, $config, $this->encoding);
$tidy->cleanRepair();
return tidy_get_output($tidy);
}
/**
* Creates a new TidyFilter using the passed in Reader for instantiation.
*
* @param reader A Reader object providing the underlying stream.
* Must not be <code>null</code>.
*
* @return a new filter based on this configuration, but filtering
* the specified reader
*/
public function chain(Reader $reader) {
$newFilter = new TidyFilter($reader);
$newFilter->setConfigParameters($this->configParameters);
$newFilter->setEncoding($this->encoding);
$newFilter->setProject($this->getProject());
return $newFilter;
}
/**
* Initializes any parameters (e.g. config options).
* This method is only called when this filter is used through a <filterreader> tag in build file.
*/
private function _initialize() {
$params = $this->getParameters();
if ($params) {
foreach($params as $param) {
if ($param->getType() == "config") {
$this->configParameters[] = $param;
} else {
if ($param->getName() == "encoding") {
$this->setEncoding($param->getValue());
}
}
}
}
}
}
|
