~budgester/irm/trunk

« back to all changes in this revision

Viewing changes to docs/code/Information Resource Manager/AtomCreator03.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 AtomCreator03</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 AtomCreator03</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-vars">Vars</a>
20
 
                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
 
                                                
22
 
                                        </div>
23
 
        <div class="info-box-body">
24
 
                        <!-- ========== Info from phpDoc block ========= -->
25
 
<p class="short-description">AtomCreator03 is a FeedCreator that implements the atom specification,  as in http://www.intertwingly.net/wiki/pie/FrontPage.</p>
26
 
<p class="description"><p>Please note that just by using AtomCreator03 you won't automatically  produce valid atom files. For example, you have to specify either an editor  for the feed or an author for every single feed item.</p><p>Some elements have not been implemented yet. These are (incomplete list):  author URL, item author's email and URL, item contents, alternate links,  other link content types than text/html. Some of them may be created with  AtomCreator03::additionalElements.</p></p>
27
 
        <ul class="tags">
28
 
                                <li><span class="field">author:</span> Kai Blankenhorn &lt;<a href="mailto:kaib@bitfolge.de">kaib@bitfolge.de</a>&gt;, Scott Reynen &lt;scott@randomchaos.com&gt;</li>
29
 
                                <li><span class="field">see:</span> additionalElements</li>
30
 
                                <li><span class="field">since:</span> 1.6</li>
31
 
                        </ul>
32
 
                <p class="notes">
33
 
                        Located in <a class="field" href="_lib---feedcreator.class.php.html">/lib/feedcreator.class.php</a> (line <span class="field">1092</span>)
34
 
                </p>
35
 
                
36
 
                                
37
 
                <pre><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a>
38
 
   |
39
 
   --<a href="../Information Resource Manager/FeedCreator.html">FeedCreator</a>
40
 
      |
41
 
      --AtomCreator03</pre>
42
 
        
43
 
                        </div>
44
 
</div>
45
 
 
46
 
 
47
 
 
48
 
 
49
 
        <a name="sec-method-summary"></a>
50
 
        <div class="info-box">
51
 
                <div class="info-box-title">Method Summary</span></div>
52
 
                <div class="nav-bar">
53
 
                        <a href="#sec-description">Description</a> |
54
 
                                                                                                                                                <a href="#sec-vars">Vars</a>
55
 
                                 
56
 
                                |
57
 
                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
58
 
                </div>
59
 
                <div class="info-box-body">                     
60
 
                        <div class="method-summary">
61
 
                                                                                                                                                                
62
 
                                                                                                <div class="method-definition">
63
 
                                                                                        <span class="method-result">AtomCreator03</span>
64
 
                                                                                <a href="#AtomCreator03" title="details" class="method-name">AtomCreator03</a>
65
 
                                                                                ()
66
 
                                                                        </div>
67
 
                                                                                                                                <div class="method-definition">
68
 
                                                                                        <span class="method-result">void</span>
69
 
                                                                                <a href="#createFeed" title="details" class="method-name">createFeed</a>
70
 
                                                                                ()
71
 
                                                                        </div>
72
 
                                                                </div>
73
 
                </div>
74
 
        </div>          
75
 
 
76
 
        <a name="sec-vars"></a>
77
 
        <div class="info-box">
78
 
                <div class="info-box-title">Variables</div>
79
 
                <div class="nav-bar">
80
 
                        <a href="#sec-description">Description</a> |
81
 
                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
82
 
                                                
83
 
                        
84
 
                                                                                | 
85
 
                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
86
 
                                                        
87
 
                                        </div>
88
 
                <div class="info-box-body">
89
 
                        
 
 
b'\t\t\t\t\t\t\t<h4>Inherited Variables</h4>'
90
 
                                <A NAME='inherited_vars'><!-- --></A>
91
 
                                                                        <p>Inherited from <span class="classname"><a href="../Information Resource Manager/FeedCreator.html">FeedCreator</a></span></p>
92
 
                                        <blockquote>
93
 
                                                                                                        <span class="var-title">
94
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$additionalElements">FeedCreator::$additionalElements</a></span><br>
95
 
                                                        </span>
96
 
                                                                                                        <span class="var-title">
97
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$category">FeedCreator::$category</a></span><br>
98
 
                                                        </span>
99
 
                                                                                                        <span class="var-title">
100
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$copyright">FeedCreator::$copyright</a></span><br>
101
 
                                                        </span>
102
 
                                                                                                        <span class="var-title">
103
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$description">FeedCreator::$description</a></span><br>
104
 
                                                        </span>
105
 
                                                                                                        <span class="var-title">
106
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$docs">FeedCreator::$docs</a></span><br>
107
 
                                                        </span>
108
 
                                                                                                        <span class="var-title">
109
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$editor">FeedCreator::$editor</a></span><br>
110
 
                                                        </span>
111
 
                                                                                                        <span class="var-title">
112
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$editorEmail">FeedCreator::$editorEmail</a></span><br>
113
 
                                                        </span>
114
 
                                                                                                        <span class="var-title">
115
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$encoding">FeedCreator::$encoding</a></span><br>
116
 
                                                        </span>
117
 
                                                                                                        <span class="var-title">
118
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$image">FeedCreator::$image</a></span><br>
119
 
                                                        </span>
120
 
                                                                                                        <span class="var-title">
121
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$language">FeedCreator::$language</a></span><br>
122
 
                                                        </span>
123
 
                                                                                                        <span class="var-title">
124
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$lastBuildDate">FeedCreator::$lastBuildDate</a></span><br>
125
 
                                                        </span>
126
 
                                                                                                        <span class="var-title">
127
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$link">FeedCreator::$link</a></span><br>
128
 
                                                        </span>
129
 
                                                                                                        <span class="var-title">
130
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$pubDate">FeedCreator::$pubDate</a></span><br>
131
 
                                                        </span>
132
 
                                                                                                        <span class="var-title">
133
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$rating">FeedCreator::$rating</a></span><br>
134
 
                                                        </span>
135
 
                                                                                                        <span class="var-title">
136
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$skipDays">FeedCreator::$skipDays</a></span><br>
137
 
                                                        </span>
138
 
                                                                                                        <span class="var-title">
139
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$skipHours">FeedCreator::$skipHours</a></span><br>
140
 
                                                        </span>
141
 
                                                                                                        <span class="var-title">
142
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$syndicationURL">FeedCreator::$syndicationURL</a></span><br>
143
 
                                                        </span>
144
 
                                                                                                        <span class="var-title">
145
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$title">FeedCreator::$title</a></span><br>
146
 
                                                        </span>
147
 
                                                                                                        <span class="var-title">
148
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$ttl">FeedCreator::$ttl</a></span><br>
149
 
                                                        </span>
150
 
                                                                                                        <span class="var-title">
151
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$webmaster">FeedCreator::$webmaster</a></span><br>
152
 
                                                        </span>
153
 
                                                                                                        <span class="var-title">
154
 
                                                                <span class="var-name"><a href="../Information Resource Manager/FeedCreator.html#var$xslStyleSheet">FeedCreator::$xslStyleSheet</a></span><br>
155
 
                                                        </span>
156
 
                                                                                        </blockquote> 
157
 
                                                                        <p>Inherited from <span class="classname"><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a></span></p>
158
 
                                        <blockquote>
159
 
                                                                                                        <span class="var-title">
160
 
                                                                <span class="var-name"><a href="../Information Resource Manager/HtmlDescribable.html#var$descriptionHtmlSyndicated">HtmlDescribable::$descriptionHtmlSyndicated</a></span><br>
161
 
                                                        </span>
162
 
                                                                                                        <span class="var-title">
163
 
                                                                <span class="var-name"><a href="../Information Resource Manager/HtmlDescribable.html#var$descriptionTruncSize">HtmlDescribable::$descriptionTruncSize</a></span><br>
164
 
                                                        </span>
165
 
                                                                                        </blockquote> 
166
 
                                                                                
167
 
                </div>
168
 
        </div>
169
 
        
170
 
        <a name="sec-methods"></a>
171
 
        <div class="info-box">
172
 
                <div class="info-box-title">Methods</div>
173
 
                <div class="nav-bar">
174
 
                        <a href="#sec-description">Description</a> |
175
 
                                                                                                                        <a href="#sec-vars">Vars</a>
176
 
                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
177
 
                                                
178
 
                </div>
179
 
                <div class="info-box-body">
180
 
                        <A NAME='method_detail'></A>
181
 
 
182
 
<a name="methodAtomCreator03" id="AtomCreator03"><!-- --></a>
183
 
<div class="oddrow">
184
 
        
185
 
        <div class="method-header">
186
 
                <span class="method-title">Constructor AtomCreator03</span> (line <span class="line-number">1094</span>)
187
 
        </div> 
188
 
        
189
 
        <!-- ========== Info from phpDoc block ========= -->
190
 
        
191
 
        <div class="method-signature">
192
 
                <span class="method-result">AtomCreator03</span>
193
 
                <span class="method-name">
194
 
                        AtomCreator03
195
 
                </span>
196
 
                                ()
197
 
                        </div>
198
 
        
199
 
                
200
 
                        
201
 
        </div>
202
 
<a name="methodcreateFeed" id="createFeed"><!-- --></a>
203
 
<div class="evenrow">
204
 
        
205
 
        <div class="method-header">
206
 
                <span class="method-title">createFeed</span> (line <span class="line-number">1099</span>)
207
 
        </div> 
208
 
        
209
 
        <!-- ========== Info from phpDoc block ========= -->
210
 
        
211
 
        <div class="method-signature">
212
 
                <span class="method-result">void</span>
213
 
                <span class="method-name">
214
 
                        createFeed
215
 
                </span>
216
 
                                ()
217
 
                        </div>
218
 
        
219
 
                
220
 
                        <hr class="separator" />
221
 
                <div class="notes">Redefinition of:</div>
222
 
                <dl>
223
 
                        <dt><a href="../Information Resource Manager/FeedCreator.html#methodcreateFeed">FeedCreator::createFeed()</a></dt>
224
 
                                                <dd>Builds the feed's text.</dd>
225
 
                                        </dl>
226
 
                        
227
 
        </div>
228
 
                                                        <h4>Inherited Methods</h4>
229
 
                                <a name='inherited_methods'><!-- --></a>        
230
 
                                                                        <!-- =========== Summary =========== -->
231
 
                                        <p>Inherited From <span class="classname"><a href="../Information Resource Manager/FeedCreator.html">FeedCreator</a></span></p>
232
 
                                        <blockquote>
233
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#methodaddItem">FeedCreator::addItem()</a></span><br>
234
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#methodcreateFeed">FeedCreator::createFeed()</a></span><br>
235
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#methodiTrunc">FeedCreator::iTrunc()</a></span><br>
236
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#methodsaveFeed">FeedCreator::saveFeed()</a></span><br>
237
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#methoduseCached">FeedCreator::useCached()</a></span><br>
238
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#method_createAdditionalElements">FeedCreator::_createAdditionalElements()</a></span><br>
239
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#method_createGeneratorComment">FeedCreator::_createGeneratorComment()</a></span><br>
240
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/FeedCreator.html#method_createStylesheetReferences">FeedCreator::_createStylesheetReferences()</a></span><br>
241
 
                                                                                        </blockquote>
242
 
                                                                        <!-- =========== Summary =========== -->
243
 
                                        <p>Inherited From <span class="classname"><a href="../Information Resource Manager/HtmlDescribable.html">HtmlDescribable</a></span></p>
244
 
                                        <blockquote>
245
 
                                                                                                        <span class="method-name"><a href="../Information Resource Manager/HtmlDescribable.html#methodgetDescription">HtmlDescribable::getDescription()</a></span><br>
246
 
                                                                                        </blockquote>
247
 
                                                                                
248
 
                </div>
249
 
        </div>
250
 
 
251
 
 
252
 
        <p class="notes" id="credit">
253
 
                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>
254
 
        </p>
255
 
        </div></body>
256
 
</html>
 
 
b'\\ No newline at end of file'