Skip to content

phantomate/laravel-reddit-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel-Reddit-API

Latest Version on Packagist Total Downloads

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

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

Supports Laravel 5.x - 8.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 codewizz/laravel-reddit-api

If you are using Laravel 5.5+, the service provider and alias will be registered automatically. You can proceed to "Publish config".

Manually register services

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,
    ...
];

Publish config

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' => env('REDDIT_USERNAME', ''),
    'password' => env('REDDIT_PASSWORD', ''),
    'app_id' => env('REDDIT_APP_ID', ''),
    'app_secret' => env('REDDIT_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.

About

Laravel Reddit API wrapper

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%