~budgester/irm/trunk

« back to all changes in this revision

Viewing changes to docs/code/Information Resource Manager/FeedItem.html

  • Committer: Martin N Stevens
  • Date: 2008-06-23 21:48:10 UTC
  • Revision ID: budgester@budgester.com-20080623214810-bs1zs1fqo05ycn2i
Generated documentation not required in revision control system

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
 
  <html xmlns="http://www.w3.org/1999/xhtml">
4
 
                <head>
5
 
                        <!-- template designed by Marco Von Ballmoos -->
6
 
                        <title>Docs For Class FeedItem</title>
7
 
                        <link rel="stylesheet" href="../media/stylesheet.css" />
8
 
                        <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9
 
                </head>
10
 
                <body>
11
 
                        <div class="page-body">                 
12
 
<h2 class="class-name">Class FeedItem</h2>
13
 
 
14
 
<a name="sec-description"></a>
15
 
<div class="info-box">
16
 
        <div class="info-box-title">Description</div>
17
 
        <div class="nav-bar">
18
 
                                        <span class="disabled">Description</span> |
19
 
                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20
 
                                                |                                                                                       <a href="#sec-methods">Methods</a>
21
 
                                                
22
 
                                        </div>
23
 
        <div class="info-box-body">
24
 
                        <!-- ========== Info from phpDoc block ========= -->
25
 
<p class="short-description">A FeedItem is a part of a FeedCreator feed.</p>
26
 
        <ul class="tags">
27
 
                                <li><span class="field">author:</span> Kai Blankenhorn &lt;<a href="mailto:kaib@bitfolge.de">kaib@bitfolge.de</a>&gt;</li>
28
 
                                <li><span class="field">since:</span> 1.3</li>
29
 
                        </ul>
30
 
                <p class="notes">
31
 
                        Located in <a class="field" href="_lib---feedcreator.class.php.html">/lib/feedcreator.class.php</a> (line <span class="field">177</span>)
32
 
                </p>
33
 
                
34
 
                                
35
 
                <pre><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a>
36
 
   |
37
 
   --FeedItem</pre>
38
 
        
39
 
                        </div>
40
 
</div>
41
 
 
42
 
 
43
 
 
44
 
        <a name="sec-var-summary"></a>
45
 
        <div class="info-box">
46
 
                <div class="info-box-title">Variable Summary</span></div>
47
 
                <div class="nav-bar">
48
 
                        <a href="#sec-description">Description</a> |
49
 
                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
50
 
                                                        | 
51
 
                                                                        <a href="#sec-methods">Methods</a>
52
 
                                                        
53
 
                                                                </div>
54
 
                <div class="info-box-body">
55
 
                        <div class="var-summary">
56
 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <div class="var-title">
57
 
                                        <span class="var-type">mixed</span>
58
 
                                        <a href="#$additionalElements" title="details" class="var-name">$additionalElements</a>
59
 
                                </div>
60
 
                                                                                                                                <div class="var-title">
61
 
                                        <span class="var-type">mixed</span>
62
 
                                        <a href="#$author" title="details" class="var-name">$author</a>
63
 
                                </div>
64
 
                                                                                                                                <div class="var-title">
65
 
                                        <span class="var-type">mixed</span>
66
 
                                        <a href="#$authorEmail" title="details" class="var-name">$authorEmail</a>
67
 
                                </div>
68
 
                                                                                                                                <div class="var-title">
69
 
                                        <span class="var-type">mixed</span>
70
 
                                        <a href="#$category" title="details" class="var-name">$category</a>
71
 
                                </div>
72
 
                                                                                                                                <div class="var-title">
73
 
                                        <span class="var-type">mixed</span>
74
 
                                        <a href="#$comments" title="details" class="var-name">$comments</a>
75
 
                                </div>
76
 
                                                                                                                                <div class="var-title">
77
 
                                        <span class="var-type">mixed</span>
78
 
                                        <a href="#$creator" title="details" class="var-name">$creator</a>
79
 
                                </div>
80
 
                                                                                                                                <div class="var-title">
81
 
                                        <span class="var-type">mixed</span>
82
 
                                        <a href="#$date" title="details" class="var-name">$date</a>
83
 
                                </div>
84
 
                                                                                                                                <div class="var-title">
85
 
                                        <span class="var-type">mixed</span>
86
 
                                        <a href="#$description" title="details" class="var-name">$description</a>
87
 
                                </div>
88
 
                                                                                                                                <div class="var-title">
89
 
                                        <span class="var-type">mixed</span>
90
 
                                        <a href="#$guid" title="details" class="var-name">$guid</a>
91
 
                                </div>
92
 
                                                                                                                                <div class="var-title">
93
 
                                        <span class="var-type">mixed</span>
94
 
                                        <a href="#$image" title="details" class="var-name">$image</a>
95
 
                                </div>
96
 
                                                                                                                                <div class="var-title">
97
 
                                        <span class="var-type">mixed</span>
98
 
                                        <a href="#$link" title="details" class="var-name">$link</a>
99
 
                                </div>
100
 
                                                                                                                                <div class="var-title">
101
 
                                        <span class="var-type">mixed</span>
102
 
                                        <a href="#$source" title="details" class="var-name">$source</a>
103
 
                                </div>
104
 
                                                                                                                                <div class="var-title">
105
 
                                        <span class="var-type">mixed</span>
106
 
                                        <a href="#$title" title="details" class="var-name">$title</a>
107
 
                                </div>
108
 
                                                                                        </div>
109
 
                </div>
110
 
        </div>
111
 
 
112
 
 
113
 
        <a name="sec-vars"></a>
114
 
        <div class="info-box">
115
 
                <div class="info-box-title">Variables</div>
116
 
                <div class="nav-bar">
117
 
                        <a href="#sec-description">Description</a> |
118
 
                                                                                <span class="disabled">Vars</span>
119
 
                                                
120
 
                        
121
 
                                                                                | 
122
 
                                                                        <a href="#sec-methods">Methods</a>
123
 
                                                        
124
 
                                        </div>
125
 
                <div class="info-box-body">
126
 
                        <a name="var$additionalElements" id="$additionalElements"><!-- --></A>
127
 
<div class="evenrow">
128
 
 
129
 
        <div class="var-header">
130
 
                <span class="var-title">
131
 
                        <span class="var-type">mixed</span>
132
 
                        <span class="var-name">$additionalElements</span>
133
 
                         = <span class="var-default">array()</span>                     (line <span class="line-number">211</span>)
134
 
                </span>
135
 
        </div>
136
 
 
137
 
        <!-- ========== Info from phpDoc block ========= -->
138
 
<p class="short-description">Any additional elements to include as an assiciated array. All $key =&gt; $value pairs</p>
139
 
<p class="description"><p>will be included unencoded in the feed item in the form      &lt;$key&gt;$value&lt;/$key&gt;  Again: No encoding will be used! This means you can invalidate or enhance the feed  if $value contains markup. This may be abused to embed tags not implemented by  the FeedCreator class used.</p></p>
140
 
        
141
 
        
142
 
                
143
 
                
144
 
 
145
 
</div>
146
 
<a name="var$author" id="$author"><!-- --></A>
147
 
<div class="oddrow">
148
 
 
149
 
        <div class="var-header">
150
 
                <span class="var-title">
151
 
                        <span class="var-type">mixed</span>
152
 
                        <span class="var-name">$author</span>
153
 
                                                (line <span class="line-number">186</span>)
154
 
                </span>
155
 
        </div>
156
 
 
157
 
        <!-- ========== Info from phpDoc block ========= -->
158
 
<p class="short-description">Optional attributes of an item.</p>
159
 
        
160
 
        
161
 
                
162
 
                
163
 
 
164
 
</div>
165
 
<a name="var$authorEmail" id="$authorEmail"><!-- --></A>
166
 
<div class="evenrow">
167
 
 
168
 
        <div class="var-header">
169
 
                <span class="var-title">
170
 
                        <span class="var-type">mixed</span>
171
 
                        <span class="var-name">$authorEmail</span>
172
 
                                                (line <span class="line-number">186</span>)
173
 
                </span>
174
 
        </div>
175
 
 
176
 
        <!-- ========== Info from phpDoc block ========= -->
177
 
        
178
 
        
179
 
                
180
 
                
181
 
 
182
 
</div>
183
 
<a name="var$category" id="$category"><!-- --></A>
184
 
<div class="oddrow">
185
 
 
186
 
        <div class="var-header">
187
 
                <span class="var-title">
188
 
                        <span class="var-type">mixed</span>
189
 
                        <span class="var-name">$category</span>
190
 
                                                (line <span class="line-number">186</span>)
191
 
                </span>
192
 
        </div>
193
 
 
194
 
        <!-- ========== Info from phpDoc block ========= -->
195
 
        
196
 
        
197
 
                
198
 
                
199
 
 
200
 
</div>
201
 
<a name="var$comments" id="$comments"><!-- --></A>
202
 
<div class="evenrow">
203
 
 
204
 
        <div class="var-header">
205
 
                <span class="var-title">
206
 
                        <span class="var-type">mixed</span>
207
 
                        <span class="var-name">$comments</span>
208
 
                                                (line <span class="line-number">186</span>)
209
 
                </span>
210
 
        </div>
211
 
 
212
 
        <!-- ========== Info from phpDoc block ========= -->
213
 
        
214
 
        
215
 
                
216
 
                
217
 
 
218
 
</div>
219
 
<a name="var$creator" id="$creator"><!-- --></A>
220
 
<div class="oddrow">
221
 
 
222
 
        <div class="var-header">
223
 
                <span class="var-title">
224
 
                        <span class="var-type">mixed</span>
225
 
                        <span class="var-name">$creator</span>
226
 
                                                (line <span class="line-number">186</span>)
227
 
                </span>
228
 
        </div>
229
 
 
230
 
        <!-- ========== Info from phpDoc block ========= -->
231
 
        
232
 
        
233
 
                
234
 
                
235
 
 
236
 
</div>
237
 
<a name="var$date" id="$date"><!-- --></A>
238
 
<div class="evenrow">
239
 
 
240
 
        <div class="var-header">
241
 
                <span class="var-title">
242
 
                        <span class="var-type">mixed</span>
243
 
                        <span class="var-name">$date</span>
244
 
                                                (line <span class="line-number">201</span>)
245
 
                </span>
246
 
        </div>
247
 
 
248
 
        <!-- ========== Info from phpDoc block ========= -->
249
 
<p class="short-description">Publishing date of an item. May be in one of the following formats:</p>
250
 
<p class="description"><p>RFC 822:      &quot;Mon, 20 Jan 03 18:05:41 +0400&quot;       &quot;20 Jan 03 18:05:41 +0000&quot;</p><p>ISO 8601:    &quot;2003-01-20T18:05:41+04:00&quot;</p><p>Unix:       1043082341</p></p>
251
 
        
252
 
        
253
 
                
254
 
                
255
 
 
256
 
</div>
257
 
<a name="var$description" id="$description"><!-- --></A>
258
 
<div class="oddrow">
259
 
 
260
 
        <div class="var-header">
261
 
                <span class="var-title">
262
 
                        <span class="var-type">mixed</span>
263
 
                        <span class="var-name">$description</span>
264
 
                                                (line <span class="line-number">181</span>)
265
 
                </span>
266
 
        </div>
267
 
 
268
 
        <!-- ========== Info from phpDoc block ========= -->
269
 
        
270
 
        
271
 
                
272
 
                
273
 
 
274
 
</div>
275
 
<a name="var$guid" id="$guid"><!-- --></A>
276
 
<div class="evenrow">
277
 
 
278
 
        <div class="var-header">
279
 
                <span class="var-title">
280
 
                        <span class="var-type">mixed</span>
281
 
                        <span class="var-name">$guid</span>
282
 
                                                (line <span class="line-number">186</span>)
283
 
                </span>
284
 
        </div>
285
 
 
286
 
        <!-- ========== Info from phpDoc block ========= -->
287
 
        
288
 
        
289
 
                
290
 
                
291
 
 
292
 
</div>
293
 
<a name="var$image" id="$image"><!-- --></A>
294
 
<div class="oddrow">
295
 
 
296
 
        <div class="var-header">
297
 
                <span class="var-title">
298
 
                        <span class="var-type">mixed</span>
299
 
                        <span class="var-name">$image</span>
300
 
                                                (line <span class="line-number">186</span>)
301
 
                </span>
302
 
        </div>
303
 
 
304
 
        <!-- ========== Info from phpDoc block ========= -->
305
 
        
306
 
        
307
 
                
308
 
                
309
 
 
310
 
</div>
311
 
<a name="var$link" id="$link"><!-- --></A>
312
 
<div class="evenrow">
313
 
 
314
 
        <div class="var-header">
315
 
                <span class="var-title">
316
 
                        <span class="var-type">mixed</span>
317
 
                        <span class="var-name">$link</span>
318
 
                                                (line <span class="line-number">181</span>)
319
 
                </span>
320
 
        </div>
321
 
 
322
 
        <!-- ========== Info from phpDoc block ========= -->
323
 
        
324
 
        
325
 
                
326
 
                
327
 
 
328
 
</div>
329
 
<a name="var$source" id="$source"><!-- --></A>
330
 
<div class="oddrow">
331
 
 
332
 
        <div class="var-header">
333
 
                <span class="var-title">
334
 
                        <span class="var-type">mixed</span>
335
 
                        <span class="var-name">$source</span>
336
 
                                                (line <span class="line-number">186</span>)
337
 
                </span>
338
 
        </div>
339
 
 
340
 
        <!-- ========== Info from phpDoc block ========= -->
341
 
        
342
 
        
343
 
                
344
 
                
345
 
 
346
 
</div>
347
 
<a name="var$title" id="$title"><!-- --></A>
348
 
<div class="evenrow">
349
 
 
350
 
        <div class="var-header">
351
 
                <span class="var-title">
352
 
                        <span class="var-type">mixed</span>
353
 
                        <span class="var-name">$title</span>
354
 
                                                (line <span class="line-number">181</span>)
355
 
                </span>
356
 
        </div>
357
 
 
358
 
        <!-- ========== Info from phpDoc block ========= -->
359
 
<p class="short-description">Mandatory attributes of an item.</p>
360
 
        
361
 
        
362
 
                
363
 
                
364
 
 
365
 
</div>
366
 
 
 
 
b'\t\t\t\t\t\t\t<h4>Inherited Variables</h4>'
367
 
                                <A NAME='inherited_vars'><!-- --></A>
368
 
                                                                        <p>Inherited from <span class="classname"><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a></span></p>
369
 
                                        <blockquote>
370
 
                                                                                                        <span class="var-title">
371
 
                                                                <span class="var-name"><a href="../Information Resource Manager/HtmlDescribable.html#var$descriptionHtmlSyndicated">HtmlDescribable::$descriptionHtmlSyndicated</a></span><br>
372
 
                                                        </span>
373
 
                                                                                                        <span class="var-title">
374
 
                                                                <span class="var-name"><a href="../Information Resource Manager/HtmlDescribable.html#var$descriptionTruncSize">HtmlDescribable::$descriptionTruncSize</a></span><br>
375
 
                                                        </span>
376
 
                                                                                        </blockquote> 
377
 
                                                                                
378
 
                </div>
379
 
        </div>
380
 
        
381
 
        <a name="sec-methods"></a>
382
 
        <div class="info-box">
383
 
                <div class="info-box-title">Methods</div>
384
 
                <div class="nav-bar">
385
 
                        <a href="#sec-description">Description</a> |
386
 
                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
387
 
                                                                                                                                        <span class="disabled">Methods</span>
388
 
                                                
389
 
                </div>
390
 
                <div class="info-box-body">
391
 
                        <A NAME='method_detail'></A>
392
 
 
393
 
                                                        <h4>Inherited Methods</h4>
394
 
                                <a name='inherited_methods'><!-- --></a>        
395
 
                                                                        <!-- =========== Summary =========== -->
396
 
                                        <p>Inherited From <span class="classname"><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a></span></p>
397
 
                                        <blockquote>
398
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/HtmlDescribable.html#methodgetDescription">HtmlDescribable::getDescription()</a></span><br>
399
 
                                                                                        </blockquote>
400
 
                                                                                
401
 
                </div>
402
 
        </div>
403
 
 
404
 
 
405
 
        <p class="notes" id="credit">
406
 
                Documentation generated on Fri, 21 Mar 2008 22:32:44 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
407
 
        </p>
408
 
        </div></body>
409
 
</html>
 
 
b'\\ No newline at end of file'