blob: 5e0dfea5323a456fce429abc6c559c68ad4f75fc (
plain)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
Configuration
=============
How to use the Config object
----------------------------
To change the default parameters, you have to use the Config class.
Create a new instance and pass it to the Reader object like that:
```php
use PicoFeed\Reader\Reader;
use PicoFeed\Config\Config;
$config = new Config;
$config->setClientUserAgent('My custom RSS Reader')
->setProxyHostname('127.0.0.1')
->setProxyPort(8118);
$reader = new Reader($config);
...
```
HTTP Client parameters
----------------------
### Connection timeout
- Method name: `setClientTimeout()`
- Default value: 10 seconds
- Argument value: number of seconds (integer)
```php
$config->setClientTimeout(20); // 20 seconds
```
### User Agent
- Method name: `setClientUserAgent()`
- Default value: `PicoFeed (https://github.com/fguillot/picoFeed)`
- Argument value: string
```php
$config->setClientUserAgent('My RSS reader');
```
### Maximum HTTP redirections
- Method name: `setMaxRedirections()`
- Default value: 5
- Argument value: integer
```php
$config->setMaxRedirections(10);
```
### Maximum HTTP body response size
- Method name: `setMaxBodySize()`
- Default value: 2097152 (2MB)
- Argument value: value in bytes (integer)
```php
$config->setMaxBodySize(10485760); // 10MB
```
### Proxy hostname
- Method name: `setProxyHostname()`
- Default value: empty
- Argument value: string
```php
$config->setProxyHostname('proxy.example.org');
```
### Proxy port
- Method name: `setProxyPort()`
- Default value: 3128
- Argument value: port number (integer)
```php
$config->setProxyPort(8118);
```
### Proxy username
- Method name: `setProxyUsername()`
- Default value: empty
- Argument value: string
```php
$config->setProxyUsername('myuser');
```
### Proxy password
- Method name: `setProxyPassword()`
- Default value: empty
- Argument value: string
```php
$config->setProxyPassword('mysecret');
```
Content grabber
---------------
### Connection timeout
- Method name: `setGrabberTimeout()`
- Default value: 10 seconds
- Argument value: number of seconds (integer)
```php
$config->setGrabberTimeout(20); // 20 seconds
```
### User Agent
- Method name: `setGrabberUserAgent()`
- Default value: `PicoFeed (https://github.com/fguillot/picoFeed)`
- Argument value: string
```php
$config->setGrabberUserAgent('My content scraper');
```
Parser
------
### Hash algorithm used for item id generation
- Method name: `setParserHashAlgo()`
- Default value: `sha256`
- Argument value: any value returned by the function `hash_algos()` (string)
- See: http://php.net/hash_algos
```php
$config->setParserHashAlgo('sha1');
```
### Disable item content filtering
- Method name: `setContentFiltering()`
- Default value: true (filtering is enabled by default)
- Argument value: boolean
```php
$config->setContentFiltering(false);
```
### Timezone
- Method name: `setTimezone()`
- Default value: UTC
- Argument value: See https://php.net/manual/en/timezones.php (string)
- Note: define the timezone for items/feeds
```php
$config->setTimezone('Europe/Paris');
```
Logging
-------
### Timezone
- Method name: `setTimezone()`
- Default value: UTC
- Argument value: See https://php.net/manual/en/timezones.php (string)
- Note: define the timezone for the logging class
```php
$config->setTimezone('Europe/Paris');
```
Filter
------
### Set the iframe whitelist (allowed iframe sources)
- Method name: `setFilterIframeWhitelist()`
- Default value: See the Filter class source code
- Argument value: array
```php
$config->setFilterIframeWhitelist(['http://www.youtube.com', 'http://www.vimeo.com']);
```
### Define HTML integer attributes
- Method name: `setFilterIntegerAttributes()`
- Default value: See the Filter class source code
- Argument value: array
```php
$config->setFilterIntegerAttributes(['width', 'height']);
```
### Add HTML attributes automatically
- Method name: `setFilterAttributeOverrides()`
- Default value: See the Filter class source code
- Argument value: array
```php
$config->setFilterAttributeOverrides(['a' => ['target' => '_blank']);
```
### Set the list of required attributes for tags
- Method name: `setFilterRequiredAttributes()`
- Default value: See the Filter class source code
- Argument value: array
- Note: If the required attributes are not there, the tag is stripped
```php
$config->setFilterRequiredAttributes(['a' => 'href', 'img' => 'src']);
```
### Set the resource blacklist (Ads blocker)
- Method name: `setFilterMediaBlacklist()`
- Default value: See the Filter class source code
- Argument value: array
- Note: Tags are stripped if they have those URLs
```php
$config->setFilterMediaBlacklist(['feeds.feedburner.com', 'share.feedsportal.com']);
```
### Define which attributes are used for external resources
- Method name: `setFilterMediaAttributes()`
- Default value: See the Filter class source code
- Argument value: array
```php
$config->setFilterMediaAttributes(['src', 'href']);
```
### Define the scheme whitelist
- Method name: `setFilterSchemeWhitelist()`
- Default value: See the Filter class source code
- Argument value: array
- See: http://en.wikipedia.org/wiki/URI_scheme
```php
$config->setFilterSchemeWhitelist(['http://', 'ftp://']);
```
### Define the tags and attributes whitelist
- Method name: `setFilterWhitelistedTags()`
- Default value: See the Filter class source code
- Argument value: array
- Note: Only those tags are allowed everything else is stripped
```php
$config->setFilterWhitelistedTags(['a' => ['href'], 'img' => ['src', 'title']]);
```
|
