https://github.com/kbariotis/feedly-api
PHP wrapper around Feedly's REST API
https://github.com/kbariotis/feedly-api
feedly php php-wrapper
Last synced: 10 months ago
JSON representation
PHP wrapper around Feedly's REST API
- Host: GitHub
- URL: https://github.com/kbariotis/feedly-api
- Owner: kbariotis
- License: mit
- Created: 2014-01-16T16:36:18.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2021-03-07T19:48:47.000Z (almost 5 years ago)
- Last Synced: 2025-03-30T19:07:10.403Z (10 months ago)
- Topics: feedly, php, php-wrapper
- Language: PHP
- Size: 101 KB
- Stars: 122
- Watchers: 15
- Forks: 31
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
feedly-api
=========
PHP wrapper around [Feedly's REST API](http://developer.feedly.com/).
[](https://travis-ci.org/kbariotis/feedly-api)
Notes
-----
Check the [examples](https://github.com/kbariotis/feedly-api/blob/master/example) before anything.
If you are working in Sandbox mode of Feedly's API you should know a couple of things.
* Your Client's ID, secret must taken from [here](https://groups.google.com/forum/#!topic/feedly-cloud/a_cGSAzv8bY), which is updated very often so be sure to check it once in while.
* While in Sandbox mode, only "http://localhost" is permited for callback url. So leave it as is and just replace it every time with your domain, if it's different. You can also add you own to permitted domains [here](https://groups.google.com/forum/#!topic/feedly-cloud/vSo0DuShvDg/discussion).
* Once you've done developing you can contact Feedly and ask them to put you on [production](http://developer.feedly.com/v3/sandbox/).
Installation
-----------
Add this to your composer.json
```
"require": {
"kbariotis/feedly-api": "dev-master"
}
```
Or download the [ZIP](https://github.com/stakisko/feedly-api/archive/master.zip).
Documentation
-------------
**Constructor:**
```php
$feedly = new Feedly(Mode $mode, AccessTokenStorage $accessTokenStorage);
```
The `Mode` determines if you want to use the Sandbox mode (`SandBoxMode` class) or standard one (`DeveloperMode` class).
The `AccessTokenStorage` determines where the information about token should be stored. In example in session, file or database.
***Sandbox Example
```php
$feedly = new Feedly(new feedly\Mode\SandBoxMode(), new feedly\AccessTokenStorage\AccessTokenSessionStorage());
```
***Standard Mode Example
```php
$feedly = new Feedly(new feedly\Mode\DeveloperMode(), new feedly\AccessTokenStorage\AccessTokenSessionStorage());
```
**Authentication:**
Check the [example](https://github.com/stakisko/feedly-api/blob/master/example/authentication.php).
Note that not every Feedly action needs authentication. Passing a token is optional.
**Endpoints**
[Profile:](http://developers.feedly.com/v3/profile/)
```php
$profile = $feedly->profile();
var_dump($profile->fetch());
$profile->setOptions(array(
'email'=>'odysseus@ithaca.gr'
));
$profile->persist();
```
[Categories:](http://developers.feedly.com/v3/categories/)
```php
$categories = $feedly->categories();
var_dump($categories->fetch());
$categories->changeLabel($id, 'New Label');
$categories->delete($id);
```
[Entries:](http://developers.feedly.com/v3/entries/)
```php
$entries = $feedly->entries();
var_dump($entries->get($id));
```
[Streams:](http://developers.feedly.com/v3/streams/)
```php
$streams = $feedly->streams();
//Retrieve ids from stream
var_dump($stream->get($id,"ids"));
//Retrieve contents from stream
var_dump($stream->get($id,"contents"));
```
[Markers:](http://developers.feedly.com/v3/markers/)
```php
$markers = $feedly->markers();
var_dump($markers->get($id));
var_dump($markers->getUnreadCount());
$markers->markArticleAsRead(array(
'TSxGHgRh4oAiHxRU9TgPrpYvYVBPjipkmUVSHGYCTY0=_14499073085:c034:d32dab1f',
'TSxGHgRh4oAiHxRU9TgPrpYvYVBPjipkmUVSHGYCTY0=_1449255d60a:22c3491:9c6d71ab'
));
$markers->markArticleAsUnread(array(
'TSxGHgRh4oAiHxRU9TgPrpYvYVBPjipkmUVSHGYCTY0=_14499073085:c034:d32dab1f',
'TSxGHgRh4oAiHxRU9TgPrpYvYVBPjipkmUVSHGYCTY0=_1449255d60a:22c3491:9c6d71ab'
));
$markers->markFeedAsUnread(array(
'feed/http://feeds.feedburner.com/design-milk'
));
$markers->markFeedAsUnread(array(
'user/c805fcbf-3acf-4302-a97e-d82f9d7c897f/category/design',
'user/c805fcbf-3acf-4302-a97e-d82f9d7c897f/category/photography'
));
```
Contribute
-------------
* Create a branch
* Add your models [here](src/feedly/Models)
* Run tests with `phpunit`
* Make a Pull Request
Licence
--------------------
```
The MIT License (MIT)
Copyright (c) 2014 Konstantinos Bariotis
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```