coliving/laravel-reddit-api

Laravel Reddit API wrapper

0.1.8 2022-04-04 08:12 UTC

Requires

• php: ^7.4|^8.0|^8.1
• ext-curl: *
• illuminate/support: ^5.1|^6.0|^7.0|^8.0|^9.0

Requires (Dev)

• phpunit/phpunit: 9.*

MIT

• Dzung Nguyen

• api
• laravel
• reddit
• codewizz
• laravel-reddit-api
• coliving

README

Using this package you can easily retrieve data from Reddit API.

Laravel wrapper for https://github.com/rotorcowboy/Phapper

Supports Laravel 5.x, 6.x, 7.x, 8.x, 9.x

Here are a few examples of the provided methods:

use RedditAPI;

//fetch top Reddit posts
RedditAPI::getTop();

//fetch top picture posts of Margot Robbie, limit to 100
RedditAPI::search('Margot Robbie ', null, 'top', null, 'pics', 100);

Install

This package can be installed through Composer.

composer require coliving/laravel-reddit-api

You must install this service provider.

// config/app.php
'providers' => [
    ...
    CodeWizz\RedditAPI\RedditAPIServiceProvider::class,
    ...
];

This package also comes with a facade, which provides an easy way to call the the class.

// config/app.php
'aliases' => [
    ...
    'RedditAPI' => CodeWizz\RedditAPI\RedditAPIFacade::class,
    ...
];

You should publish the config file of this package with this command:

php artisan vendor:publish --provider="CodeWizz\RedditAPI\RedditAPIServiceProvider"

The following config file will be published in config/reddit-api.php

return [
    'endpoint_standard' => 'https://www.reddit.com',
    'endpoint_oauth' => 'https://oauth.reddit.com',

    'username' => '',
    'password' => '',
    'app_id' => '',
    'app_secret' => '',

    'response_format' => 'STD', // STD | ARRAY

    'scopes' => 'save,modposts,identity,edit,flair,history,modconfig,modflair,modlog,modposts,modwiki,mysubreddits,privatemessages,read,report,submit,subscribe,vote,wikiedit,wikiread'
];

About CodeWizz

CodeWizz is a web development agency based in Lithuania. You'll find more information on our website.

License

The MIT License (MIT). Please see License File for more information.