Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renoki-co/reddit-json-api
Reddit JSON API is a PHP wrapper for handling JSON information from public subreddits.
https://github.com/renoki-co/reddit-json-api
api laravel pagination php php-wrapper reddit reddit-json-api subreddits wrapper
Last synced: 2 months ago
JSON representation
Reddit JSON API is a PHP wrapper for handling JSON information from public subreddits.
- Host: GitHub
- URL: https://github.com/renoki-co/reddit-json-api
- Owner: renoki-co
- License: apache-2.0
- Created: 2019-01-17T20:10:50.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T01:01:22.000Z (about 1 year ago)
- Last Synced: 2024-11-01T02:18:26.218Z (3 months ago)
- Topics: api, laravel, pagination, php, php-wrapper, reddit, reddit-json-api, subreddits, wrapper
- Language: PHP
- Homepage:
- Size: 101 KB
- Stars: 20
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/renoki-co/reddit-json-api/branch/master)
[](https://github.styleci.io/repos/166289783)
[](https://packagist.org/packages/rennokki/reddit-json-api)
[](https://packagist.org/packages/rennokki/reddit-json-api)
[](https://packagist.org/packages/rennokki/reddit-json-api)
[](https://packagist.org/packages/rennokki/reddit-json-api)
Reddit JSON API is a PHP wrapper for handling JSON information from public subreddits.
## 🚀 Installation
You can install the package via composer:
```bash
composer require rennokki/reddit-json-api
```
## 🙌 Usage
```php
use Rennokki\RedditApi\Reddit;
$app = Reddit::app(
'renoki-co/reddit-json-api',
'2.0',
'web',
'someusername'
);
$subreddit = Reddit::subreddit(
'funny', // subreddit name
$app
);
$posts = $subreddit->get();
foreach ($posts as $post) {
$id = $post['id'];
}
```
When retrieving posts, the results are wrapped in a `Rennokki\RedditApi\RedditList` class. This class is based on Laravel Collection and you can pipeline actions on it more easily. Please see [Laravel Collections documentantion](https://laravel.com/docs/master/collections).
## Pagination
For pagination purposes, you shall call `nextPage()` from the previous `$posts`:
```php
$subreddit = Reddit::subreddit('funny', $app);
$posts = $subreddit->get();
$nextPageOfPosts = $posts->nextPage();
```
## Sorting
Reddit allows sorting by posts type. The currently used ones are:
```php
public static $sorts = [
'hot', 'new', 'controversial', 'top', 'rising',
];
```
To apply the sorting, you should call `sort()`:
```php
$subreddit = Reddit::subreddit('funny', $app);
$subreddit->sort('top');
```
## Time Filtering
Same as sorting, time filters are only a few:
```php
public static $times = [
'hour', 'day', 'week', 'month', 'year', 'all',
];
```
```php
$subreddit = Reddit::subreddit('funny', $app);
// Top, all time sorting.
$subreddit
->sort('top')
->time('all');
```
## Limit
By default, each call gives you `20` posts.
```php
$subreddit = Reddit::subreddit('funny', $app);
$subreddit->setLimit(100);
```
## Debugging
If you wish to inspect the URL that is being called, you ca do so:
```php
$subreddit = Reddit::subreddit('funny', $app);
$subreddit
->setLimit(30)
->sort('top')
->time('week');
$url = $subreddit->getCallableUrl();
```
## 🐛 Testing
``` bash
vendor/bin/phpunit
```
## 🤝 Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## 🔒 Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## 🎉 Credits
- [Alex Renoki](https://github.com/rennokki)
- [All Contributors](../../contributors)