Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/desarrolla2/rssclient
Service for provide RSS client in your website
https://github.com/desarrolla2/rssclient
Last synced: about 1 month ago
JSON representation
Service for provide RSS client in your website
- Host: GitHub
- URL: https://github.com/desarrolla2/rssclient
- Owner: desarrolla2
- License: mit
- Created: 2012-10-02T23:51:50.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-02-22T09:10:33.000Z (almost 11 years ago)
- Last Synced: 2024-10-29T07:22:21.306Z (2 months ago)
- Language: PHP
- Size: 928 KB
- Stars: 34
- Watchers: 5
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warning !!
RSSClient will not be updated, you should consider migrating to FastFeed https://github.com/FastFeed/FastFeed
# RSSClient
RSSClient is a simple to use RSS library to fetch and use RSS feeds. RSSClient is very fast!
[](http://travis-ci.org/desarrolla2/RSSClient) [](https://scrutinizer-ci.com/g/desarrolla2/RSSClient/) [](https://scrutinizer-ci.com/g/desarrolla2/RSSClient/)
[](https://packagist.org/packages/desarrolla2/rss-client) [](https://packagist.org/packages/desarrolla2/rss-client) [](https://bitdeli.com/desarrolla2)
## Formats Supported
* [RSS2.0](http://cyber.law.harvard.edu/rss/rss.html)
* [Atom1.0](http://tools.ietf.org/html/rfc4287)
## Installation
### With Composer
It is best installed it through [packagist](http://packagist.org/packages/desarrolla2/rss-client)
by including `desarrolla2/rss-client` in your project composer.json require:
``` json
"require": {
// ...
"desarrolla2/rss-client": "dev-master"
}
```
### Without Composer
You can also download it from [Github] (https://github.com/desarrolla2/RSSClient),
but no autoloader is provided so you'll need to register it with your own PSR-0
compatible autoloader.
## Usage
### Without Cache
This example does not use any cache, so it probably will be too slow to be used on
a website, you should implement your system cache, or use the cache system described below
``` php
addFeeds(
array(
'http://news.ycombinator.com/rss',
'http://feeds.feedburner.com/TechCrunch/',
),
'news'
);
$feeds = $client->fetch('news');
```
### With Cache
This example uses the cache implemented by `desarrolla2/cache` you must
select the adapter depending on your needs, you can find all the info in the
[Github repository] (https://github.com/desarrolla2/Cache).
``` php
setCache(new Cache(new File('/tmp')));
```
You can see how to configure desarrolla2/cache in its [README] (https://github.com/desarrolla2/Cache)
The rest of the procedure is exactly the same as if you were using the client without cache.
``` php
addFeeds(
array(
'http://news.ycombinator.com/rss',
'http://feeds.feedburner.com/TechCrunch/',
),
'news'
);
$feeds = $client->fetch('news');
```
### Limiting the number of elements
You can use the second parameter of `fetch` to limit the number of elements
``` php
fetch('news', 20);
```
## Other
* Do you need a [custom processor] (https://github.com/desarrolla2/RSSClient/blob/master/doc/custom-process.md) ?
* [API docs](http://rssclient.desarrolla2.com/api/namespaces/Desarrolla2.RSSClient.html)
## Contact
You can contact with me on [twitter](https://twitter.com/desarrolla2).