This repository has been archived by the owner on Apr 4, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
287 lines (267 loc) · 15.6 KB
/
index.html
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Fast Feed — FastFeed documentation</title>
<link rel="stylesheet" href="_static/fastfeed.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="FastFeed documentation" href="#" />
<link rel="next" title="1. Install" href="reference/install.html" />
</head>
<body>
<div class="header-wrapper">
<div class="header">
<div class="headertitle"><a
href="#">FastFeed documentation</a></div>
<div class="rel">
<a href="reference/install.html" title="1. Install"
accesskey="N">next</a> |
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="fast-feed">
<h1>Fast Feed<a class="headerlink" href="#fast-feed" title="Permalink to this headline">¶</a></h1>
<p>FastFeed is a library that allows you to consume “feeds” atom or rss to be used in your applications.</p>
<div class="section" id="fastfeed-status">
<h2>FastFeed Status<a class="headerlink" href="#fastfeed-status" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="26%" />
<col width="24%" />
<col width="29%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>Name</td>
<td>Badge</td>
<td>Name</td>
<td>Badge</td>
</tr>
<tr class="row-even"><td>Build Status</td>
<td><a class="reference external" href="http://travis-ci.org/FastFeed/FastFeed"><img alt="Build_Status" src="https://secure.travis-ci.org/FastFeed/FastFeed.png" /></a></td>
<td>Latest Stable</td>
<td><a class="reference external" href="https://packagist.org/packages/fastfeed/fastfeed"><img alt="Latest_Stable" src="https://poser.pugx.org/fastfeed/fastfeed/v/stable.png" /></a></td>
</tr>
<tr class="row-odd"><td>Quality Score</td>
<td><a class="reference external" href="https://scrutinizer-ci.com/g/FastFeed/FastFeed/"><img alt="Quality_Score" src="https://scrutinizer-ci.com/g/FastFeed/FastFeed/badges/quality-score.png?s=5ce39d3775f40b5946300404fa5fe3337a5ca66c" /></a></td>
<td>Latest Stable</td>
<td><a class="reference external" href="https://packagist.org/packages/fastfeed/fastfeed"><img alt="Latest_Unstable" src="https://poser.pugx.org/fastfeed/fastfeed/v/unstable.png" /></a></td>
</tr>
<tr class="row-even"><td>Code Coverage</td>
<td><a class="reference external" href="https://scrutinizer-ci.com/g/FastFeed/FastFeed/"><img alt="Code_Coverage" src="https://scrutinizer-ci.com/g/FastFeed/FastFeed/badges/coverage.png?s=50dbf6dfca4581c8e2761e5504d9de2a8db1d6fa" /></a></td>
<td>Total Downloads</td>
<td><a class="reference external" href="https://packagist.org/packages/fastfeed/fastfeed"><img alt="Total_Downloads" src="https://poser.pugx.org/fastfeed/fastfeed/downloads.png" /></a></td>
</tr>
<tr class="row-odd"><td>Insight</td>
<td><a class="reference external" href="https://insight.sensiolabs.com/projects/99e97a62-1005-4656-bd71-19639320ed0e"><img alt="Insight" src="https://insight.sensiolabs.com/projects/99e97a62-1005-4656-bd71-19639320ed0e/mini.png" /></a></td>
<td>License</td>
<td><a class="reference external" href="https://packagist.org/packages/fastfeed/fastfeed"><img alt="License" src="https://poser.pugx.org/fastfeed/fastfeed/license.png" /></a></td>
</tr>
<tr class="row-even"><td>Dependencies</td>
<td><a class="reference external" href="https://www.versioneye.com/user/projects/53256b3eec137563b4000368"><img alt="Dependencies" src="https://www.versioneye.com/user/projects/53256b3eec137563b4000368/badge.png" /></a></td>
<td>~</td>
<td>~</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Consume any number of channels grouped by feeds.</li>
<li>Extends FastFeed easily to support new formats or retrieve information added by other specifications</li>
<li>Recover ordering information according to your preferences.</li>
<li>Modular and extensible.</li>
</ul>
</div>
<div class="section" id="easy-to-use">
<h2>Easy to use<a class="headerlink" href="#easy-to-use" title="Permalink to this headline">¶</a></h2>
<p>FastFeed is easy to use.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">use</span> <span class="nx">FastFeed\Factory</span><span class="p">;</span>
<span class="nv">$fastFeed</span> <span class="o">=</span> <span class="nx">Factory</span><span class="o">::</span><span class="na">create</span><span class="p">();</span>
<span class="nv">$fastFeed</span><span class="o">-></span><span class="na">addFeed</span><span class="p">(</span><span class="s1">'default'</span><span class="p">,</span> <span class="s1">'http://desarrolla2.com/feed'</span><span class="p">);</span>
<span class="nv">$items</span> <span class="o">=</span> <span class="nv">$fastFeed</span><span class="o">-></span><span class="na">fetch</span><span class="p">(</span><span class="s1">'default'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="highly-customizable">
<h2>Highly customizable<a class="headerlink" href="#highly-customizable" title="Permalink to this headline">¶</a></h2>
<p>You have a lot of options, read the docs for Parser, Aggregators and Processors. You have the perfect tool to
manipulate all kinds of feeds.</p>
</div>
<div class="section" id="great-documentation">
<h2>Great documentation<a class="headerlink" href="#great-documentation" title="Permalink to this headline">¶</a></h2>
<p>We have a great documentation made with love.</p>
<ul class="simple">
<li><a class="reference external" href="http://fastfeed.github.io/">Documentation</a></li>
<li><a class="reference external" href="http://fastfeed.github.io/api/">API</a></li>
<li><a class="reference external" href="http://fastfeed.github.io/coverage/">Code Coverage</a></li>
</ul>
</div>
<div class="section" id="third-party">
<h2>Third party<a class="headerlink" href="#third-party" title="Permalink to this headline">¶</a></h2>
<p>We are working with various platforms to provide easier integration.</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/FastFeed/FastFeedBundle">Symfony2 Bundle</a></li>
</ul>
</div>
<div class="section" id="contact">
<h2>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h2>
<p>You can contact with me on <a class="reference external" href="https://twitter.com/desarrolla2">@twitter</a>.</p>
</div>
<div class="section" id="reference-guide">
<h2>Reference Guide<a class="headerlink" href="#reference-guide" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/install.html">1. Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/install.html#requirements">1.1. Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/install.html#by-composer">1.2. By composer</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/install.html#on-your-own">1.3. On your own</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/install.html#continue-reading">1.4. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/use.html">2. Using Fast Feed</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/use.html#factory-way">2.1. Factory way</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/use.html#manual-way">2.2. Manual way</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/use.html#instance-guzzle">2.2.1. Instance Guzzle</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/use.html#instance-monolog">2.2.2. Instance Monolog</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/use.html#put-it-together">2.2.3. Put it together</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/use.html#add-feeds">2.3. Add feeds</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/use.html#enjoy">2.4. Enjoy</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/use.html#continue-reading">2.5. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/parsers.html">3. Parsers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/parsers.html#what-are-they">3.1. What are they?</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/parsers.html#add-it-to-fastfeed">3.2. Add it to FastFeed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/parsers.html#parsers-available">3.3. Parsers available</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/parsers.html#create-custom-parser">3.4. Create custom Parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/parsers.html#continue-reading">3.5. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/aggregators.html">4. Aggregators</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/aggregators.html#what-are-they">4.1. What are they?</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/aggregators.html#add-it-to-parsers">4.2. Add it to Parsers</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/aggregators.html#aggregators-available">4.3. Aggregators available</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/aggregators.html#create-custom-aggregators">4.4. Create custom Aggregators</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/aggregators.html#continue-reading">4.5. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/processors.html">5. Processors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/processors.html#what-are-they">5.1. What are they?</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/processors.html#add-it-to-fastfeed">5.2. Add it to FastFeed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/processors.html#processors-available">5.3. Processors available</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/processors.html#create-custom-processors">5.4. Create custom Processors</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/processors.html#continue-reading">5.5. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/cache.html">6. Caching results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/cache.html#continue-reading">6.1. Continue reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/faq.html">7. Faq</a></li>
</ul>
</div>
</div>
<div class="section" id="cookbook">
<h2>Cookbook<a class="headerlink" href="#cookbook" title="Permalink to this headline">¶</a></h2>
<p>Not ready yet :(</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/install.html">1. Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/use.html">2. Using Fast Feed</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/parsers.html">3. Parsers</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/aggregators.html">4. Aggregators</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/processors.html">5. Processors</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/cache.html">6. Caching results</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/faq.html">7. Faq</a></li>
</ul>
<a href="https://github.com/FastFeed/FastFeed">See project on GitHub</a>
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<div class="clearer"></div>
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'fastfeed'; // required: replace example with your forum shortname
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<a href="reference/install.html" title="1. Install"
>next</a> |
<a href="genindex.html" title="General Index"
>index</a>
<br/>
<a href="_sources/index.txt"
rel="nofollow">Show Source</a>
</div>
<div class="right">
<div class="footer">
© Copyright 2014, [email protected].
Last updated on Apr 23, 2014.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-23939978-14', 'github.com');
ga('send', 'pageview');
</script>
</body>
</html>