├── .gitignore
├── .php_cs.dist
├── LICENSE.md
├── README.md
├── composer.json
└── src
    ├── Exceptions
        └── RedditAuthenticationException.php
    ├── Interfaces
        └── RedditApiInterface.php
    ├── RedditAPI.php
    ├── RedditAPIFacade.php
    ├── RedditAPIServiceProvider.php
    ├── RedditLive.php
    ├── RedditOAuth2.php
    ├── RedditRateLimiter.php
    └── config
        └── reddit-api.php


/.gitignore:
--------------------------------------------------------------------------------
1 | composer.lock
2 | vendor
3 | .php_cs.cache
4 | .idea


--------------------------------------------------------------------------------
/.php_cs.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use PhpCsFixer\Finder;
 4 | 
 5 | $project_path = getcwd();
 6 | $finder = Finder::create()
 7 |     ->in([
 8 |         $project_path . '/src',
 9 |     ])
10 |     ->name('*.php')
11 |     ->ignoreDotFiles(true)
12 |     ->ignoreVCS(true);
13 | 
14 | return JamesAusten\styles($finder);
15 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | # The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2017 CodeWizz <info@codewizz.com>
 4 | 
 5 | > Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | > of this software and associated documentation files (the "Software"), to deal
 7 | > in the Software without restriction, including without limitation the rights
 8 | > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | > copies of the Software, and to permit persons to whom the Software is
10 | > furnished to do so, subject to the following conditions:
11 | >
12 | > The above copyright notice and this permission notice shall be included in
13 | > all copies or substantial portions of the Software.
14 | >
15 | > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | > THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel-Reddit-API
 2 | 
 3 | [![Latest Version on Packagist](https://img.shields.io/packagist/v/codewizz/laravel-reddit-api.svg?style=flat-square)](https://packagist.org/packages/codewizz/laravel-reddit-api)
 4 | [![Total Downloads](https://img.shields.io/packagist/dt/codewizz/laravel-reddit-api.svg?style=flat-square)](https://packagist.org/packages/codewizz/laravel-reddit-api)
 5 | 
 6 | Using this package you can easily retrieve data from Reddit API.
 7 | 
 8 | Laravel wrapper for https://github.com/rotorcowboy/Phapper
 9 | 
10 | Supports Laravel 5.x - 8.x.
11 | 
12 | Here are a few examples of the provided methods:
13 | ```php
14 | use RedditAPI;
15 | 
16 | //fetch top Reddit posts
17 | RedditAPI::getTop();
18 | 
19 | //fetch top picture posts of Margot Robbie, limit to 100
20 | RedditAPI::search('Margot Robbie ', null, 'top', null, 'pics', 100);
21 | ```
22 | 
23 | ## Install
24 | 
25 | This package can be installed through Composer.
26 | 
27 | ``` bash
28 | composer require codewizz/laravel-reddit-api
29 | ```
30 | 
31 | If you are using Laravel 5.5+, the service provider and alias will be registered automatically. You can proceed to "[Publish config](#publish-config)".
32 | 
33 | ### Manually register services
34 | 
35 | You must install this service provider.
36 | 
37 | ```php
38 | // config/app.php
39 | 'providers' => [
40 |     ...
41 |     CodeWizz\RedditAPI\RedditAPIServiceProvider::class,
42 |     ...
43 | ];
44 | ```
45 | 
46 | This package also comes with a facade, which provides an easy way to call the the class.
47 | 
48 | ```php
49 | // config/app.php
50 | 'aliases' => [
51 |     ...
52 |     'RedditAPI' => CodeWizz\RedditAPI\RedditAPIFacade::class,
53 |     ...
54 | ];
55 | ```
56 | 
57 | ### Publish config
58 | 
59 | You should publish the config file of this package with this command:
60 | 
61 | ``` bash
62 | php artisan vendor:publish --provider="CodeWizz\RedditAPI\RedditAPIServiceProvider"
63 | ```
64 | 
65 | The following config file will be published in `config/reddit-api.php`
66 | 
67 | ```php
68 | return [
69 |     'endpoint_standard' => 'https://www.reddit.com',
70 |     'endpoint_oauth' => 'https://oauth.reddit.com',
71 |     
72 |     'username' => env('REDDIT_USERNAME', ''),
73 |     'password' => env('REDDIT_PASSWORD', ''),
74 |     'app_id' => env('REDDIT_APP_ID', ''),
75 |     'app_secret' => env('REDDIT_APP_SECRET', ''),
76 |     
77 |     'response_format' => 'STD', // STD | ARRAY
78 |     
79 |     'scopes' => 'save,modposts,identity,edit,flair,history,modconfig,modflair,modlog,modposts,modwiki,mysubreddits,privatemessages,read,report,submit,subscribe,vote,wikiedit,wikiread'
80 | ];
81 | ```
82 | 
83 | 
84 | ## About CodeWizz
85 | CodeWizz is a web development agency based in Lithuania. You'll find more information [on our website](https://codewizz.com).
86 | 
87 | ## License
88 | 
89 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
90 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "codewizz/laravel-reddit-api",
 3 |     "description": "Laravel Reddit API wrapper",
 4 |     "keywords": [
 5 |         "codewizz",
 6 |         "laravel-reddit-api",
 7 |         "laravel",
 8 |         "reddit",
 9 |         "api"
10 |     ],
11 |     "homepage": "https://github.com/codewizz/laravel-reddit-api",
12 |     "license": "MIT",
13 |     "authors": [
14 |         {
15 |             "name": "Darius Šilkaitis",
16 |             "email": "darius@codewizz.com",
17 |             "homepage": "https://codewizz.com",
18 |             "role": "Developer"
19 |         }
20 |     ],
21 |     "require": {
22 |         "php": "^7.2",
23 |         "ext-curl": "*",
24 |         "ext-json": "*",
25 |         "illuminate/support": "^6.0|^7.0|^8.0|^9.0"
26 |     },
27 |     "require-dev": {
28 |         "friendsofphp/php-cs-fixer": "^2.16",
29 |         "gtjamesa/php-standards": "^1.0",
30 |         "orchestra/testbench": "^4.0|^5.0|^6.0",
31 |         "phpunit/phpunit": "^8.4|^9.0"
32 |     },
33 |     "autoload": {
34 |         "psr-4": {
35 |             "CodeWizz\\RedditAPI\\": "src"
36 |         }
37 |     },
38 |     "autoload-dev": {
39 |         "psr-4": {
40 |             "CodeWizz\\RedditAPI\\Test\\": "tests"
41 |         }
42 |     },
43 |     "extra": {
44 |         "laravel": {
45 |             "providers": [
46 |                 "CodeWizz\\RedditAPI\\RedditAPIServiceProvider"
47 |             ],
48 |             "aliases": {
49 |                 "RedditAPI": "CodeWizz\\RedditAPI\\RedditAPIFacade"
50 |             }
51 |         }
52 |     },
53 |     "config": {
54 |         "sort-packages": true
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/Exceptions/RedditAuthenticationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace CodeWizz\RedditAPI\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class RedditAuthenticationException extends Exception
 8 | {
 9 |     public function __construct($message, $code = 0, Exception $previous = null)
10 |     {
11 |         parent::__construct($message, $code, $previous);
12 |     }
13 | 
14 |     public function __toString()
15 |     {
16 |         return __CLASS__ . ": [{$this->code}]: {$this->message}";
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Interfaces/RedditApiInterface.php:
--------------------------------------------------------------------------------
   1 | <?php
   2 | 
   3 | namespace CodeWizz\RedditAPI\Interfaces;
   4 | 
   5 | use CodeWizz\RedditAPI\PhapperLive;
   6 | 
   7 | interface RedditApiInterface
   8 | {
   9 |     public function setDebug($debug): void;
  10 | 
  11 |     /**
  12 |      * Gets information about the current user's account.
  13 |      *
  14 |      * @return object An object representing the current user.
  15 |      */
  16 |     public function getMe();
  17 | 
  18 |     /**
  19 |      * Gets karma breakdown of current user.
  20 |      *
  21 |      * @return object Listing subreddits and corresponding karma values.
  22 |      */
  23 |     public function getMyKarmaBreakdown();
  24 | 
  25 |     /**
  26 |      * Gets current user's site preferences.
  27 |      *
  28 |      * @return object Object representing user's preferences.
  29 |      */
  30 |     public function getMyPrefs();
  31 | 
  32 |     /**
  33 |      * Update the current user's preferences.
  34 |      *
  35 |      * @param  array  $settings  An array of key-value pairs to update. Use getMyPrefs() to see possible values.
  36 |      *
  37 |      * @return object Object representing user's new preferences.
  38 |      */
  39 |     public function updateMyPrefs($settings);
  40 | 
  41 |     /**
  42 |      * Gets current user's trophies.
  43 |      *
  44 |      * @return object Listing of current user's trophies.
  45 |      */
  46 |     public function getMyTrophies();
  47 | 
  48 |     /**
  49 |      * Gets a list of the current user's friends.
  50 |      *
  51 |      * @return mixed|null Listing of users that are the current user's friends.
  52 |      */
  53 |     public function getMyFriends();
  54 | 
  55 |     /**
  56 |      * Gets a list of the current user's blocked users.
  57 |      *
  58 |      * @return object Listing of current user's blocked users.
  59 |      */
  60 |     public function getMyBlockedUsers();
  61 | 
  62 |     /**
  63 |      * Retrieves a list of all assigned user flair in the specified subreddit. Must be a mod of that subreddit.
  64 |      *
  65 |      * @param  string  $subreddit  Name of subreddit from which to retrieve flair list.
  66 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 1000.
  67 |      * @param  string|null  $after  Use 'next' attribute of previous call to retrieve next page.
  68 |      * @param  string|null  $before  Retrieve only flairs that are higher than this user ID on the list.
  69 |      *
  70 |      * @return object Listing of users that are assigned flair in the specified subreddit.
  71 |      */
  72 |     public function getUserFlairList($subreddit, $limit = 25, $after = null, $before = null);
  73 | 
  74 |     /**
  75 |      * Adds or modifies a flair template in a subreddit.
  76 |      *
  77 |      * @param  string  $subreddit  Name of subreddit to add flair template.
  78 |      * @param  string  $type  Specifies user or link flair template. One of 'link' or 'user'.
  79 |      * @param  string|null  $text  Flair text.
  80 |      * @param  string|null  $css_class  Flair CSS class.
  81 |      * @param  bool  $editable  Whether or not to allow users to edit the flair's text when assigning it.
  82 |      * @param  string|null  $template_id  The template ID of an existing flair to modify. If null, will add a new one.
  83 |      *
  84 |      * @return object Response to API call.
  85 |      */
  86 |     public function addFlairTemplate(
  87 |         $subreddit,
  88 |         $type,
  89 |         $text = null,
  90 |         $css_class = null,
  91 |         $editable = false,
  92 |         $template_id = null
  93 |     );
  94 | 
  95 |     /**
  96 |      * Deletes all flair templates of the selected type from the selected subreddit.
  97 |      *
  98 |      * @param  string  $subreddit  Subreddit of flairs to clear.
  99 |      * @param  string  $type  One of 'user' or 'link'.
 100 |      *
 101 |      * @return object|null Response to API call. Null if incorrect type.
 102 |      */
 103 |     public function clearFlairTemplates($subreddit, $type);
 104 | 
 105 |     /**
 106 |      * Deletes the selected flair template from the specified subreddit.
 107 |      * $template_id can be obtained with getUserFlairSelector and getLinkFlairSelector.
 108 |      *
 109 |      * @param  string  $subreddit  Subreddit from which to delete flair template.
 110 |      * @param  string  $template_id  ID of template to delete.
 111 |      *
 112 |      * @return object Response to API call.
 113 |      */
 114 |     public function deleteFlairTemplate($subreddit, $template_id);
 115 | 
 116 |     /**
 117 |      * Deletes a user's flair from the specified subreddit.
 118 |      *
 119 |      * @param  string  $subreddit  Subreddit in which to delete user flair.
 120 |      * @param  string  $user  Username of user whose flair to delete.
 121 |      *
 122 |      * @return object Response to API call.
 123 |      */
 124 |     public function deleteUserFlair($subreddit, $user);
 125 | 
 126 |     /**
 127 |      * Gets current flair and a list of possible flairs for the specified user in the specified subreddit.
 128 |      * Also useful for obtaining flair ID's.
 129 |      *
 130 |      * @param  string  $subreddit  Subreddit in which to view flair options.
 131 |      * @param  string|null  $user  Username for whom to view selection. Defaults to current user.
 132 |      *
 133 |      * @return object Response to API call.
 134 |      */
 135 |     public function getUserFlairSelector($subreddit, $user = null);
 136 | 
 137 |     /**
 138 |      * Gets current flair and a list of possible flairs for the specified link.
 139 |      *
 140 |      * @param  string  $thing_id  Thing ID of object to view flairs.
 141 |      *
 142 |      * @return object Response to API call.
 143 |      */
 144 |     public function getLinkFlairSelector($thing_id);
 145 | 
 146 |     /**
 147 |      * Selects a user flair to use from the flair selection list.
 148 |      *
 149 |      * @param  string  $subreddit  Subreddit in which to select flair.
 150 |      * @param  string  $user  Username of user to whom to apply flair. Mandatory, don't ask me why.
 151 |      * @param  string|null  $template_id  Template ID of template to select. Null will remove the user's flair.
 152 |      * @param  string|null  $text  Modified flair text, if allowed.
 153 |      *
 154 |      * @return object Response to API call.
 155 |      */
 156 |     public function selectUserFlair($subreddit, $user, $template_id = null, $text = null);
 157 | 
 158 |     /**
 159 |      * Applies a link flair template from the selection list to a link.
 160 |      *
 161 |      * @param  string  $thing_id  Thing ID of link to apply flair.
 162 |      * @param  string|null  $template_id  Template ID of template to apply to link. Null will remove the link's flair.
 163 |      * @param  string|null  $text  Modified flair text, if allowed.
 164 |      *
 165 |      * @return object Response to API call.
 166 |      */
 167 |     public function selectLinkFlair($thing_id, $template_id = null, $text = null);
 168 | 
 169 |     /**
 170 |      * Assigns the selected user custom flair text and CSS class in the specified subreddit. Mods only.
 171 |      *
 172 |      * @param  string  $subreddit  Subreddit in which to assign flair.
 173 |      * @param  string  $user  Username of user to assign flair.
 174 |      * @param  string|null  $text  Custom flair text.
 175 |      * @param  string|null  $css_class  Custom flair CSS class. If both fields are null, deletes flair.
 176 |      *
 177 |      * @return object Response to API call.
 178 |      */
 179 |     public function assignUserFlair($subreddit, $user, $text = null, $css_class = null);
 180 | 
 181 |     /**
 182 |      * Assigns the selected link custom flair text and CSS class in the specified subreddit. Mods only.
 183 |      *
 184 |      * @param  string  $subreddit  Subreddit in which to assign flair. Mandatory, don't ask me why.
 185 |      * @param  string  $thing_id  Thing ID of link to assign flair.
 186 |      * @param  string|null  $text  Custom flair text.
 187 |      * @param  string|null  $css_class  Custom flair CSS class. If both fields are null, deletes flair.
 188 |      *
 189 |      * @return object Response to API call.
 190 |      */
 191 |     public function assignLinkFlair($subreddit, $thing_id, $text = null, $css_class = null);
 192 | 
 193 |     /**
 194 |      * Selects whether or not to show the current user's flair in the selected subreddit.
 195 |      *
 196 |      * @param  string  $subreddit  Subreddit in which to enable or disable flair.
 197 |      * @param  bool  $show  True to show flair. False to hide flair.
 198 |      *
 199 |      * @return object Response to API call.
 200 |      */
 201 |     public function showMyFlair($subreddit, $show = true);
 202 | 
 203 |     /**
 204 |      * Updates all options in a subreddit's flair configuration.
 205 |      *
 206 |      * @param  string  $subreddit  Subreddit in which to configure flair.
 207 |      * @param  bool  $user_enabled  Whether or not user flair is displayed.
 208 |      * @param  string  $user_position  On which side to display user flair. One of 'left' or 'right'.
 209 |      * @param  bool  $user_self_assign  Whether or not users can select their own user flair.
 210 |      * @param  string  $link_position  On which side to display links' flair. One of 'left', 'right', or 'none'.
 211 |      * @param  bool  $link_self_assign  Whether or not users can select their own links' flair.
 212 |      *
 213 |      * @return object|null Response to API call. Null if invalid arguments.
 214 |      */
 215 |     public function configureSubredditFlair(
 216 |         $subreddit,
 217 |         $user_enabled,
 218 |         $user_position,
 219 |         $user_self_assign,
 220 |         $link_position,
 221 |         $link_self_assign
 222 |     );
 223 | 
 224 |     /**
 225 |      * UNTESTED
 226 |      * Gild a link or comment, which gives the author reddit gold. Must have sufficient gold creddits.
 227 |      * Reddit's documentation is odd, indicating that the thing ID is required both in the URL and the POST parameters.
 228 |      *
 229 |      * @param  string  $thing_id  Thing ID of link or comment to gild.
 230 |      *
 231 |      * @return object Response to API call.
 232 |      */
 233 |     public function gild($thing_id);
 234 | 
 235 |     /**
 236 |      * UNTESTED
 237 |      * Give the specified user the specified months of reddit gold. Must have sufficient gold creddits.
 238 |      * Reddit's documentation is odd, indicating that the username is required both in the URL and the POST parameters.
 239 |      *
 240 |      * @param  string  $user  Username of user to whom to give gold.
 241 |      * @param  int  $months  Number of months to give reddit gold.
 242 |      *
 243 |      * @return object Response to API call.
 244 |      */
 245 |     public function giveGold($user, $months = 1);
 246 | 
 247 |     /**
 248 |      * Submits a new link post.
 249 |      *
 250 |      * @param  string  $subreddit  Subreddit in which to post link.
 251 |      * @param  string  $title  Title of post.
 252 |      * @param  string  $url  Link to post.
 253 |      * @param  bool  $send_replies  Send comment replies to the current user's inbox. True to enable, false to disable.
 254 |      * @param  bool  $distinguish  Whether or not it should be mod distinguished (for modded subreddits only).
 255 |      *
 256 |      * @return object Response to API call.
 257 |      */
 258 |     public function submitLinkPost($subreddit, $title, $url, $send_replies = true, $distinguish = false);
 259 | 
 260 |     /**
 261 |      * Submits a new text post.
 262 |      *
 263 |      * @param  string  $subreddit  Subreddit in which to post.
 264 |      * @param  string  $title  Title of post.
 265 |      * @param  string|null  $text  Text of post.
 266 |      * @param  bool  $send_replies  Send comment replies to the current user's inbox. True to enable, false to disable.
 267 |      * @param  bool  $distinguish  Whether or not it should be mod distinguished (for modded subreddits only).
 268 |      *
 269 |      * @return object Response to API call.
 270 |      */
 271 |     public function submitTextPost($subreddit, $title, $text = null, $send_replies = true, $distinguish = false);
 272 | 
 273 |     /**
 274 |      * Comments on an object.
 275 |      *
 276 |      * @param  string  $parent  Thing ID of parent object on which to comment. Could be link, text post, or comment.
 277 |      * @param  string  $text  Comment text.
 278 |      * @param  bool  $distinguish  Whether or not it should be mod distinguished (for modded subreddits only).
 279 |      *
 280 |      * @return object Response to API call.
 281 |      */
 282 |     public function comment($parent, $text, $distinguish = false);
 283 | 
 284 |     /**
 285 |      * Deletes a post or comment.
 286 |      *
 287 |      * @param  string  $thing_id  Thing ID of object to delete. Could be link, text post, or comment.
 288 |      *
 289 |      * @return object Response to API call, probably empty.
 290 |      */
 291 |     public function delete($thing_id);
 292 | 
 293 |     /**
 294 |      * Edits the text of a comment or text post.
 295 |      *
 296 |      * @param  string  $thing_id  Thing ID of text object to edit. Could be text post or comment.
 297 |      * @param  string  $text  New text to replace the old.
 298 |      *
 299 |      * @return object Response to API call, probably object of thing that was just edited.
 300 |      */
 301 |     public function editText($thing_id, $text);
 302 | 
 303 |     /**
 304 |      * Hides a post from user's listings.
 305 |      *
 306 |      * @param  string|array  $thing_ids  String or array of thing ID's of links to hide.
 307 |      *
 308 |      * @return bool|null Response to API call.
 309 |      */
 310 |     public function hide($thing_ids): ?bool;
 311 | 
 312 |     /**
 313 |      * Unhides a post from user's hidden posts.
 314 |      *
 315 |      * @param  string|array  $thing_ids  String or array of thing ID's of links to unhide.
 316 |      *
 317 |      * @return bool|null Returns true if success. Null if failed.
 318 |      */
 319 |     public function unhide($thing_ids): ?bool;
 320 | 
 321 |     /**
 322 |      * Gives a listing of information on objects.
 323 |      *
 324 |      * @param  string|array  $thing_ids  String or array of single or multiple thing ID's.
 325 |      *
 326 |      * @return object Listing objects requested.
 327 |      */
 328 |     public function getInfo($thing_ids);
 329 | 
 330 |     /**
 331 |      * Marks a post as NSFW.
 332 |      *
 333 |      * @param  string  $thing_id  Thing ID of post to mark as NSFW.
 334 |      *
 335 |      * @return object Response to API call, probably empty.
 336 |      */
 337 |     public function markNSFW($thing_id);
 338 | 
 339 |     /**
 340 |      * Unmarks a post as NSFW.
 341 |      *
 342 |      * @param  string  $thing_id  Thing ID of post to unmark as NSFW.
 343 |      *
 344 |      * @return object Response to API call, probably empty.
 345 |      */
 346 |     public function unmarkNSFW($thing_id);
 347 | 
 348 |     /**
 349 |      * Get comments in a tree that are hidden by "load more comments".
 350 |      * NOTE: Only make one request for this at a time. Higher concurrency will result in an error.
 351 |      *
 352 |      * @param  string  $link_id  Fullname (thing ID) of link/post of the comment tree.
 353 |      * @param  string|array  $comment_ids  ID36 or fullname of one or more parent comments for which to retrieve children.
 354 |      *
 355 |      * @return object Complex object containing comment's children.
 356 |      */
 357 |     public function getCommentChildren($link_id, $comment_ids);
 358 | 
 359 |     /**
 360 |      * Reports a post, comment, or message.
 361 |      *
 362 |      * @param  string  $thing_id  Thing ID of object to report.
 363 |      * @param  null  $reason  The reason for the report. Must be <100 characters.
 364 |      *
 365 |      * @return object Response to API call.
 366 |      */
 367 |     public function report($thing_id, $reason = null);
 368 | 
 369 |     /**
 370 |      * Saves a post or comment in the selected category.
 371 |      *
 372 |      * @param  string  $thing_id  Thing ID of object to save. Can be post or comment.
 373 |      * @param  null  $category  Category in which to save object. Defaults to none.
 374 |      *
 375 |      * @return object Response to API call, probably empty.
 376 |      */
 377 |     public function save($thing_id, $category = null);
 378 | 
 379 |     /**
 380 |      * Unsaves a post or comment from the current user's saved posts.
 381 |      *
 382 |      * @param  string  $thing_id  Thing ID of object to unsave. Can be post or comment.
 383 |      *
 384 |      * @return object Response to API call, probably empty.
 385 |      */
 386 |     public function unsave($thing_id);
 387 | 
 388 |     /**
 389 |      * Gets the current user's save categories.
 390 |      *
 391 |      * @return object Contains an array of categories.
 392 |      */
 393 |     public function getSavedCategories();
 394 | 
 395 |     /**
 396 |      * Toggles whether or not the current user should receive replies to a specific post or comment to their inbox.
 397 |      *
 398 |      * @param  string  $thing_id  Thing ID of object to toggle.
 399 |      * @param  bool  $state  State of inbox replies. True to receive, false for not.
 400 |      *
 401 |      * @return object Response to API call, probably empty.
 402 |      */
 403 |     public function sendInboxReplies($thing_id, $state = true);
 404 | 
 405 |     /**
 406 |      * Store that the current user has visited a certain link.
 407 |      *
 408 |      * @param  string|array  $thing_ids  String or array of thing ID's of links to store as visited.
 409 |      *
 410 |      * @return object Response to API call, probably empty.
 411 |      */
 412 |     public function storeVisits($thing_ids);
 413 | 
 414 |     /**
 415 |      * VOTES MUST BE CAST BY A HUMAN!!
 416 |      * Proxying a person's single vote is okay, but bots should not use vote functions on their own.
 417 |      *
 418 |      * Upvotes a post or comment.
 419 |      *
 420 |      * @param  string  $thing_id  Thing ID of object to upvote.
 421 |      *
 422 |      * @return object Response to API call, probably empty.
 423 |      */
 424 |     public function upvote($thing_id);
 425 | 
 426 |     /**
 427 |      * Downvotes a post or comment.
 428 |      *
 429 |      * @param  string  $thing_id  Thing ID of object to downvote.
 430 |      *
 431 |      * @return object Response to API call, probably empty.
 432 |      */
 433 |     public function downvote($thing_id);
 434 | 
 435 |     /**
 436 |      * Resets the current user's vote on a post or comment.
 437 |      *
 438 |      * @param  string  $thing_id  Thing ID of object to reset vote.
 439 |      *
 440 |      * @return object Response to API call, probably empty.
 441 |      */
 442 |     public function unvote($thing_id);
 443 | 
 444 |     /**
 445 |      * Retrieves a listing of links by their specified thing ID.
 446 |      *
 447 |      * @param  string  $thing_ids  Thing ID's of links to retrieve.
 448 |      *
 449 |      * @return object A listing of links.
 450 |      */
 451 |     public function getLinksById($thing_ids);
 452 | 
 453 |     /**
 454 |      * Retrieves a listing of comments and children for a link and optionally a specific comment.
 455 |      *
 456 |      * @param  string  $link_id  ID36 or fullname of link for comments to fetch.
 457 |      * @param  string|null  $comment_id  Optional, ID36 or fullname of a single comment to fetch with children, much like permalink.
 458 |      * @param  int|null  $context  Number of levels up of parent comments to retrieve. Only applicable to child comments.
 459 |      * @param  int|null  $depth  Depth of child comments to retrieve.
 460 |      * @param  int|null  $limit  Limit of comments to retrieve.
 461 |      * @param  string|null  $sort  How to sort the comments, one of 'confidence', 'top', 'new', 'hot', 'controversial', 'old', 'random', 'qa'
 462 |      * @param  bool  $show_edits  Show edited comments, perhaps? Not well documented by reddit.
 463 |      * @param  bool  $show_more  Include links to show more comments, maybe? Not well documented by reddit.
 464 |      *
 465 |      * @return object Listing of link and specified comment(s).
 466 |      */
 467 |     public function getComments(
 468 |         $link_id,
 469 |         $comment_id = null,
 470 |         $context = null,
 471 |         $depth = null,
 472 |         $limit = null,
 473 |         $sort = null,
 474 |         $show_edits = false,
 475 |         $show_more = false
 476 |     );
 477 | 
 478 |     /**
 479 |      * Retrieves the specified link and a listing of other links that are to duplicate destinations.
 480 |      *
 481 |      * @param  string  $thing_id  ID36 or fullname of link to check for duplicates.
 482 |      * @param  int  $limit  Limit of duplicate links to retrieve.
 483 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 484 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 485 |      *
 486 |      * @return object Listing of original link and listing of duplicate links.
 487 |      */
 488 |     public function getDuplicateLinks($thing_id, $limit = 25, $after = null, $before = null);
 489 | 
 490 |     /**
 491 |      * Retrieves the hot listing for the optionally specified subreddit.
 492 |      *
 493 |      * @param  string|null  $subreddit  Subreddit of listing to retrieve. If none, defaults to front page.
 494 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 495 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 496 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 497 |      *
 498 |      * @return mixed|null Returns listing object on success. Null if failed.
 499 |      */
 500 |     public function getHot($subreddit = null, $limit = 25, $after = null, $before = null);
 501 | 
 502 |     /**
 503 |      * Retrieves the new listing for the optionally specified subreddit.
 504 |      *
 505 |      * @param  string|null  $subreddit  Subreddit of listing to retrieve. If none, defaults to front page.
 506 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 507 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 508 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 509 |      *
 510 |      * @return mixed|null Returns listing object on success. Null if failed.
 511 |      */
 512 |     public function getNew($subreddit = null, $limit = 25, $after = null, $before = null);
 513 | 
 514 |     /**
 515 |      * Retrieves the controversial listing for the optionally specified subreddit.
 516 |      *
 517 |      * @param  string|null  $subreddit  Subreddit of listing to retrieve. If none, defaults to front page.
 518 |      * @param  string  $time  Time constraint for age of items on list. One of hour, day, week, month, year, all.
 519 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 520 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 521 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 522 |      *
 523 |      * @return mixed|null Returns listing object on success. Null if failed.
 524 |      */
 525 |     public function getControversial($subreddit = null, $time = 'all', $limit = 25, $after = null, $before = null);
 526 | 
 527 |     /**
 528 |      * Retrieves the top listing for the optionally specified subreddit.
 529 |      *
 530 |      * @param  string|null  $subreddit  Subreddit of listing to retrieve. If none, defaults to front page.
 531 |      * @param  string  $time  Time constraint for age of items on list. One of 'hour', 'day', 'week', 'month', 'year', 'all'.
 532 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 533 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 534 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 535 |      *
 536 |      * @return mixed|null Returns listing object on success. Null if failed.
 537 |      */
 538 |     public function getTop($subreddit = null, $time = 'all', $limit = 25, $after = null, $before = null);
 539 | 
 540 |     /**
 541 |      * NOT CURRENTLY SUPPORTED BY REDDIT. HERE ANYWAY IN CASE IT IS IN THE FUTURE.
 542 |      * Retrieves a random link from the optionally specified subreddit. If none, choose from any subreddit.
 543 |      *
 544 |      * @param  string|null  $subreddit  Subreddit from which to retrieve a random link.
 545 |      *
 546 |      * @return object Who knows? Probably a listing of a single link.
 547 |      */
 548 |     public function getRandom($subreddit = null);
 549 | 
 550 |     /**
 551 |      * Retrieves a list of links that are the result of a search of the specified link's title.
 552 |      *
 553 |      * @param  string  $thing_id  ID36 or fullname of link to search with.
 554 |      * @param  int  $limit  Upper limit of the number of links to retrieve. Maximum is 100.
 555 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 556 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 557 |      *
 558 |      * @return object Listing of original link and listing of related links.
 559 |      */
 560 |     public function getRelatedLinks($thing_id, $limit = 25, $after = null, $before = null);
 561 | 
 562 |     /**
 563 |      * Creates a new live thread. To use an existing one, use attachLiveThread().
 564 |      *
 565 |      * @param  string  $title  The thread's title.
 566 |      * @param  string|null  $description  The thread's description.
 567 |      * @param  string|null  $resources  The thread's resources section in the sidebar.
 568 |      * @param  bool  $nsfw  Whether or not the thread is NSFW. Prompts guests to continue when visiting.
 569 |      *
 570 |      * @return PhapperLive|null New PHP object representing a reddit live thread.
 571 |      */
 572 |     public function createLiveThread($title, $description = null, $resources = null, $nsfw = false): ?PhapperLive;
 573 | 
 574 |     /**
 575 |      * Uses an existing live thread to create a Live object. You do not necessarily need to be a contributor to attach.
 576 |      *
 577 |      * @param  string  $thread_id  Thread ID of the thread to attach.
 578 |      *
 579 |      * @return PhapperLive Returns the resulting PHP Live object.
 580 |      */
 581 |     public function attachLiveThread($thread_id): PhapperLive;
 582 | 
 583 |     /**
 584 |      * Block a user based on the thing ID of a *message* they sent you. Does not work directly on user objects.
 585 |      *
 586 |      * @param  string  $thing_id  Thing ID of message that the user to block sent you.
 587 |      *
 588 |      * @return object Response to API call, probably empty.
 589 |      */
 590 |     public function blockByMessage($thing_id);
 591 | 
 592 |     /**
 593 |      * CURRENTLY NOT SUPPORTED WITH OAUTH.
 594 |      * Collapse one or more messages in modmail.
 595 |      *
 596 |      * @param  string|array  $thing_ids  Comma-separated or array of thing ID's of messages to collapse.
 597 |      *
 598 |      * @return object Undetermined.
 599 |      */
 600 |     public function collapseMessage($thing_ids);
 601 | 
 602 |     /**
 603 |      * CURRENTLY NOT SUPPORTED WITH OAUTH.
 604 |      * Uncollapse one or more messages in modmail.
 605 |      *
 606 |      * @param  string|array  $thing_ids  Comma-separated or array of thing ID's of messages to uncollapse.
 607 |      *
 608 |      * @return object Undetermined.
 609 |      */
 610 |     public function uncollapseMessage($thing_ids);
 611 | 
 612 |     /**
 613 |      * Sends a message to a user or subreddit.
 614 |      *
 615 |      * @param  string  $to  Username or subreddit to send to.
 616 |      * @param  string  $subject  Subject of message.
 617 |      * @param  string  $body  Body of message.
 618 |      * @param  string|null  $from_subreddit  Optionally the name of the subreddit from which to send the message.
 619 |      *
 620 |      * @return object Response to API call.
 621 |      */
 622 |     public function composeMessage($to, $subject, $body, $from_subreddit = null);
 623 | 
 624 |     /**
 625 |      * Deletes a message from the recipient's inbox.
 626 |      * Be aware that messages sent both from and to yourself cannot be deleted.
 627 |      *
 628 |      * @param $thing_id string Thing ID of message to delete.
 629 |      *
 630 |      * @return mixed Response to API call.
 631 |      */
 632 |     public function deleteMessage($thing_id);
 633 | 
 634 |     /**
 635 |      * Queues a job for all of your messages to be marked as read.
 636 |      *
 637 |      * @return string Raw body response from reddit since it's not in JSON.
 638 |      */
 639 |     public function markAllMessagesAsRead(): string;
 640 | 
 641 |     /**
 642 |      * Marks one or more messages as read.
 643 |      *
 644 |      * @param  string|array  $thing_ids  A comma-separated string or array of one or more message thing ID's (t4_).
 645 |      *
 646 |      * @return object Response to API call, probably empty.
 647 |      */
 648 |     public function markMessageRead($thing_ids);
 649 | 
 650 |     /**
 651 |      * Marks one or more messages as unread.
 652 |      *
 653 |      * @param  string|array  $thing_ids  A comma-separated string or array of one or more message thing ID's (t4_).
 654 |      *
 655 |      * @return object Response to API call, probably empty.
 656 |      */
 657 |     public function markMessageUnread($thing_ids);
 658 | 
 659 |     /**
 660 |      * Unblock a subreddit using a message they sent you.
 661 |      *
 662 |      * @param  string  $thing_id  Thing ID of a message sent by the subreddit to unblock.
 663 |      *
 664 |      * @return object Response to API call.
 665 |      */
 666 |     public function unblockSubredditByMessage($thing_id);
 667 | 
 668 |     /**
 669 |      * Retrieves the current user's personal message inbox.
 670 |      *
 671 |      * @param  int  $limit  Upper limit of the number of links to retrieve. Maximum is 100.
 672 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 673 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 674 |      *
 675 |      * @return object Listing of messages in user's inbox.
 676 |      */
 677 |     public function getInbox($limit = 25, $after = null, $before = null);
 678 | 
 679 |     /**
 680 |      * Retrieves the current user's unread personal messages.
 681 |      *
 682 |      * @param  int  $limit  Upper limit of the number of links to retrieve. Maximum is 100.
 683 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 684 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 685 |      *
 686 |      * @return object Listing of unread messages in user's inbox.
 687 |      */
 688 |     public function getUnread($limit = 25, $after = null, $before = null);
 689 | 
 690 |     /**
 691 |      * Retrieves the current user's sent personal messages.
 692 |      *
 693 |      * @param  int  $limit  Upper limit of the number of links to retrieve. Maximum is 100.
 694 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 695 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 696 |      *
 697 |      * @return object Listing of unread messages in user's inbox.
 698 |      */
 699 |     public function getSent($limit = 25, $after = null, $before = null);
 700 | 
 701 |     /**
 702 |      * Retrieves modmail messages.
 703 |      *
 704 |      * @param  string  $subreddit  Subreddit for which to retrieve modmail. 'mod' means all moderated subreddits.
 705 |      * @param  bool  $messages_read  Whether or not to turn off the orangered mail icon. Does not mark each message as read.
 706 |      * @param  int  $limit  Upper limit of the number of message threads to retrieve. Maximum of 100.
 707 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 708 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 709 |      *
 710 |      * @return object Listing of modmail messages.
 711 |      */
 712 |     public function getModmail($subreddit = 'mod', $messages_read = false, $limit = 25, $after = null, $before = null);
 713 | 
 714 |     /**
 715 |      * Retrieve a list of all of reddit's OAuth2 scopes.
 716 |      *
 717 |      * @return object Contains several objects representing each OAuth2 scope
 718 |      */
 719 |     public function getOAuthScopes();
 720 | 
 721 |     /**
 722 |      * Toggles contest mode on a post.
 723 |      *
 724 |      * @param  string  $thing_id  Thing ID of post to toggle contest mode.
 725 |      * @param  bool  $state  True to enable contest mode, false to disable.
 726 |      *
 727 |      * @return object Response to API call, probably empty.
 728 |      */
 729 |     public function setContestMode($thing_id, $state = true);
 730 | 
 731 |     /**
 732 |      * Stickies a post at the top of the subreddit.
 733 |      *
 734 |      * @param  string  $thing_id  Thing ID of post to sticky.
 735 |      * @param  int  $num  Position of new sticky. 1 for top, 2 for bottom. Defaults to 2.
 736 |      *
 737 |      * @return object Response to API call.
 738 |      */
 739 |     public function stickyPost($thing_id, $num = 2);
 740 | 
 741 |     /**
 742 |      * Unsticky a post from the top of a subreddit.
 743 |      *
 744 |      * @param  string  $thing_id  Thing ID of post to unsticky.
 745 |      *
 746 |      * @return object Response to API call.
 747 |      */
 748 |     public function unstickyPost($thing_id);
 749 | 
 750 |     /**
 751 |      * Sets the default sort of a link's comments.
 752 |      *
 753 |      * @param  string  $thing_id  Thing ID of link to set suggested sort.
 754 |      * @param  string  $sort  Sort method. One of: 'confidence', 'top', 'new', 'hot', 'controversial', 'old', 'random', 'qa'
 755 |      *
 756 |      * @return object Response to API call, probably empty.
 757 |      */
 758 |     public function setSuggestedSort($thing_id, $sort);
 759 | 
 760 |     /**
 761 |      * Clears the default sort of a link's comments.
 762 |      *
 763 |      * @param  string  $thing_id  Thing ID of link to clear suggested sort.
 764 |      *
 765 |      * @return object Response to API call, probably empty.
 766 |      */
 767 |     public function clearSuggestedSort($thing_id);
 768 | 
 769 |     /**
 770 |      * Mod distinguish a post or comment.
 771 |      *
 772 |      * @param  string  $thing_id  Thing ID of object to distinguish.
 773 |      * @param  bool  $how  True to set [M] distinguish. False to undistinguish.
 774 |      *
 775 |      * @return object Response to API call.
 776 |      */
 777 |     public function distinguish($thing_id, $how = true);
 778 | 
 779 |     /**
 780 |      * Retrieves recent entries from the moderation log for the specified subreddit.
 781 |      *
 782 |      * @param  string  $subreddit  Subreddit of log to retrieve. All moderated subreddits by default.
 783 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 500.
 784 |      * @param  string|null  $after  Obtain the page of the results that come after the specified ModAction.
 785 |      * @param  string|null  $mod  Filter by moderator.
 786 |      * @param  string|null  $action  Filter by mod action.
 787 |      * @param  string|null  $before  Obtain the page of the results that come before the specified ModAction.
 788 |      *
 789 |      * @return object Listing object with modaction children.
 790 |      */
 791 |     public function getModerationLog(
 792 |         $subreddit = 'mod',
 793 |         $limit = 25,
 794 |         $after = null,
 795 |         $mod = null,
 796 |         $action = null,
 797 |         $before = null
 798 |     );
 799 | 
 800 |     /**
 801 |      * Retrieves a list of things that have been reported in the specified subreddit.
 802 |      *
 803 |      * @param  string  $subreddit  Subreddit of items to retrieve. All moderated subreddits by default.
 804 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 805 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 806 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 807 |      * @param  null  $only  Obtain only links or comments. One of 'links' or 'comments'. Null for both.
 808 |      *
 809 |      * @return mixed|null Returns a listing object with link and/or comment children.
 810 |      */
 811 |     public function getReports($subreddit = 'mod', $limit = 25, $after = null, $before = null, $only = null);
 812 | 
 813 |     /**
 814 |      * Retrieves a list of things that have been marked as spam in the specified subreddit.
 815 |      *
 816 |      * @param  string  $subreddit  Subreddit of items to retrieve. All moderated subreddits by default.
 817 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 818 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 819 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 820 |      * @param  null  $only  Obtain only links or comments. One of 'links' or 'comments'. Null for both.
 821 |      *
 822 |      * @return mixed|null Returns a listing object with link and/or comment children.
 823 |      */
 824 |     public function getSpam($subreddit = 'mod', $limit = 25, $after = null, $before = null, $only = null);
 825 | 
 826 |     /**
 827 |      * Retrieves a list of things that have been placed in the modqueue of the specified subreddit.
 828 |      *
 829 |      * @param  string  $subreddit  Subreddit of items to retrieve. All moderated subreddits by default.
 830 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 831 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 832 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 833 |      * @param  null  $only  Obtain only links or comments. One of 'links' or 'comments'. Null for both.
 834 |      *
 835 |      * @return mixed|null Returns a listing object with link and/or comment children.
 836 |      */
 837 |     public function getModqueue($subreddit = 'mod', $limit = 25, $after = null, $before = null, $only = null);
 838 | 
 839 |     /**
 840 |      * Retrieves a list of things that have not been moderated in the specified subreddit.
 841 |      *
 842 |      * @param  string  $subreddit  Subreddit of items to retrieve. All moderated subreddits by default.
 843 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 844 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 845 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 846 |      *
 847 |      * @return mixed|null Returns a listing object with link and/or comment children.
 848 |      */
 849 |     public function getUnmoderated($subreddit = 'mod', $limit = 25, $after = null, $before = null);
 850 | 
 851 |     /**
 852 |      * Retrieves a list of comments that have been edited by the author in the specified subreddit.
 853 |      *
 854 |      * @param  string  $subreddit  Subreddit of items to retrieve. All moderated subreddits by default.
 855 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
 856 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
 857 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
 858 |      *
 859 |      * @return mixed|null Returns a listing object with link and/or comment children.
 860 |      */
 861 |     public function getEditedComments($subreddit = 'mod', $limit = 25, $after = null, $before = null);
 862 | 
 863 |     /**
 864 |      * Accepts a moderator invitation for the specified subreddit. You must have a pending invitation for that subreddit.
 865 |      *
 866 |      * @param  string  $subreddit  Subreddit to accept invitation.
 867 |      *
 868 |      * @return object Response to API call.
 869 |      */
 870 |     public function acceptModeratorInvite($subreddit);
 871 | 
 872 |     /**
 873 |      * Marks the specified thing as approved.
 874 |      *
 875 |      * @param  string  $thing_id  Thing ID of object to be approved.
 876 |      *
 877 |      * @return object Response to API call, probably empty.
 878 |      */
 879 |     public function approve($thing_id);
 880 | 
 881 |     /**
 882 |      * Removes a post or comment from a subreddit.
 883 |      *
 884 |      * @param  string  $thing_id  Thing ID of object to remove.
 885 |      *
 886 |      * @return object Response to API call, probably empty.
 887 |      */
 888 |     public function remove($thing_id);
 889 | 
 890 |     /**
 891 |      * Removes a post or comment from a subreddit as spam.
 892 |      *
 893 |      * @param  string  $thing_id  Thing ID of object to remove.
 894 |      *
 895 |      * @return object Response to API call, probably empty.
 896 |      */
 897 |     public function spam($thing_id);
 898 | 
 899 |     /**
 900 |      * Ignores reports for the specified thing.
 901 |      *
 902 |      * @param  string  $thing_id  Thing ID of object to be ignored.
 903 |      *
 904 |      * @return object Response to API call, probably empty.
 905 |      */
 906 |     public function ignoreReports($thing_id);
 907 | 
 908 |     /**
 909 |      * Unignores reports for the specified thing.
 910 |      *
 911 |      * @param  string  $thing_id  Thing ID of object to be unignored.
 912 |      *
 913 |      * @return object Response to API call, probably empty.
 914 |      */
 915 |     public function unignoreReports($thing_id);
 916 | 
 917 |     /**
 918 |      * Abdicate approved submitter status in a subreddit.
 919 |      *
 920 |      * @param  string  $subreddit  Name of subreddit to leave.
 921 |      *
 922 |      * @return object Response to API call, probably empty.
 923 |      */
 924 |     public function leaveContributor($subreddit);
 925 | 
 926 |     /**
 927 |      * Abdicate moderator status in a subreddit.
 928 |      *
 929 |      * @param  string  $subreddit  Name of subreddit to leave.
 930 |      *
 931 |      * @return object Response to API call, probably empty.
 932 |      */
 933 |     public function leaveModerator($subreddit);
 934 | 
 935 |     /**
 936 |      * Ban a user from the selected subreddit.
 937 |      *
 938 |      * @param  string  $subreddit  Subreddit from which to ban user.
 939 |      * @param  string  $user  Username of user to ban.
 940 |      * @param  string|null  $note  Ban note in banned users list. Not shown to user.
 941 |      * @param  string|null  $message  Ban message sent to user.
 942 |      * @param  int|null  $duration  Duration of ban in days.
 943 |      *
 944 |      * @return object Response to API call.
 945 |      */
 946 |     public function ban($subreddit, $user, $note = null, $message = null, $duration = null);
 947 | 
 948 |     /**
 949 |      * Unban a user from a subreddit.
 950 |      *
 951 |      * @param  string  $subreddit  Subreddit from which to unban the user.
 952 |      * @param  string  $user  Username of user to unban.
 953 |      *
 954 |      * @return object Response to API call, probably empty.
 955 |      */
 956 |     public function unban($subreddit, $user);
 957 | 
 958 |     /**
 959 |      * Add a user as a contributor to a subreddit.
 960 |      *
 961 |      * @param  string  $subreddit  Subreddit to which to add user.
 962 |      * @param  string  $user  Username of user to add.
 963 |      *
 964 |      * @return object Response to API call.
 965 |      */
 966 |     public function addContributor($subreddit, $user);
 967 | 
 968 |     /**
 969 |      * Remove a user as a contributor from a subreddit.
 970 |      *
 971 |      * @param  string  $subreddit  Subreddit from which to remove the user.
 972 |      * @param  string  $user  Username of user to remove.
 973 |      *
 974 |      * @return object Response to API call, probably empty..
 975 |      */
 976 |     public function removeContributor($subreddit, $user);
 977 | 
 978 |     /**
 979 |      * Invite a user to become a moderator to a subreddit.
 980 |      *
 981 |      * @param  string  $subreddit  Subreddit to which to invite user.
 982 |      * @param  string  $user  Username of user to invite.
 983 |      * @param  bool  $perm_all  If the user should have full permissions.
 984 |      * @param  bool  $perm_access  If the user should have the 'access' permission.
 985 |      * @param  bool  $perm_config  If the user should have the 'config' permission.
 986 |      * @param  bool  $perm_flair  If the user should have the 'flair' permission.
 987 |      * @param  bool  $perm_mail  If the user should have the 'mail' permission.
 988 |      * @param  bool  $perm_posts  If the user should have the 'posts' permission.
 989 |      * @param  bool  $perm_wiki  If the user should have the 'wiki' permission.
 990 |      *
 991 |      * @return object Response to API call.
 992 |      */
 993 |     public function inviteModerator(
 994 |         $subreddit,
 995 |         $user,
 996 |         $perm_all = true,
 997 |         $perm_access = false,
 998 |         $perm_config = false,
 999 |         $perm_flair = false,
1000 |         $perm_mail = false,
1001 |         $perm_posts = false,
1002 |         $perm_wiki = false
1003 |     );
1004 | 
1005 |     /**
1006 |      * Remove an existing moderator as a moderator from a subreddit. To revoke an invitation, use uninviteModerator().
1007 |      *
1008 |      * @param  string  $subreddit  Subreddit from which to remove a user as a moderator.
1009 |      * @param  string  $user  Username of user to remove
1010 |      *
1011 |      * @return object Response to API call, probably empty.
1012 |      */
1013 |     public function removeModerator($subreddit, $user);
1014 | 
1015 |     /**
1016 |      * Revoke a user's pending invitation to moderate a subreddit. To remove an existing moderator, use removeModerator().
1017 |      *
1018 |      * @param  string  $subreddit  Subreddit from which to revoke a user's invitation.
1019 |      * @param  string  $user  User whose invitation to revoke.
1020 |      *
1021 |      * @return object Response to API call, probably empty.
1022 |      */
1023 |     public function uninviteModerator($subreddit, $user);
1024 | 
1025 |     /**
1026 |      * Modify an existing moderator's permission set. To modify an invited moderator's permissions, use setInvitationPermissions().
1027 |      *
1028 |      * @param  string  $subreddit  Subreddit in which to edit a user's permissions
1029 |      * @param  string  $user  Username of user to edit permissions.
1030 |      * @param  bool  $perm_all  If the user should have full permissions.
1031 |      * @param  bool  $perm_access  If the user should have the 'access' permission.
1032 |      * @param  bool  $perm_config  If the user should have the 'config' permission.
1033 |      * @param  bool  $perm_flair  If the user should have the 'flair' permission.
1034 |      * @param  bool  $perm_mail  If the user should have the 'mail' permission.
1035 |      * @param  bool  $perm_posts  If the user should have the 'posts' permission.
1036 |      * @param  bool  $perm_wiki  If the user should have the 'wiki' permission.
1037 |      *
1038 |      * @return object Response to API call.
1039 |      */
1040 |     public function setModeratorPermissions(
1041 |         $subreddit,
1042 |         $user,
1043 |         $perm_all = true,
1044 |         $perm_access = false,
1045 |         $perm_config = false,
1046 |         $perm_flair = false,
1047 |         $perm_mail = false,
1048 |         $perm_posts = false,
1049 |         $perm_wiki = false
1050 |     );
1051 | 
1052 |     /**
1053 |      * Modify an invited moderator's permission set. To modify an existing moderator's permissions, use setModeratorPermissions().
1054 |      *
1055 |      * @param  string  $subreddit  Subreddit in which to edit a user's permissions
1056 |      * @param  string  $user  Username of user to edit permissions.
1057 |      * @param  bool  $perm_all  If the user should have full permissions.
1058 |      * @param  bool  $perm_access  If the user should have the 'access' permission.
1059 |      * @param  bool  $perm_config  If the user should have the 'config' permission.
1060 |      * @param  bool  $perm_flair  If the user should have the 'flair' permission.
1061 |      * @param  bool  $perm_mail  If the user should have the 'mail' permission.
1062 |      * @param  bool  $perm_posts  If the user should have the 'posts' permission.
1063 |      * @param  bool  $perm_wiki  If the user should have the 'wiki' permission.
1064 |      *
1065 |      * @return object Response to API call.
1066 |      */
1067 |     public function setInvitationPermissions(
1068 |         $subreddit,
1069 |         $user,
1070 |         $perm_all = true,
1071 |         $perm_access = false,
1072 |         $perm_config = false,
1073 |         $perm_flair = false,
1074 |         $perm_mail = false,
1075 |         $perm_posts = false,
1076 |         $perm_wiki = false
1077 |     );
1078 | 
1079 |     /**
1080 |      * Ban a user from contributing to a subreddit's wiki.
1081 |      *
1082 |      * @param  string  $subreddit  Subreddit from which to ban user.
1083 |      * @param  string  $user  Username of user to ban.
1084 |      * @param  string|null  $note  Ban note in banned users list. Not shown to user.
1085 |      * @param  int|null  $duration  Duration of ban in days.
1086 |      *
1087 |      * @return object Response to API call.
1088 |      */
1089 |     public function wikiBan($subreddit, $user, $note = null, $duration = null);
1090 | 
1091 |     /**
1092 |      * Unban a user from a subreddit's wiki.
1093 |      *
1094 |      * @param  string  $subreddit  Subreddit from which to unban the user.
1095 |      * @param  string  $user  Username of user to unban.
1096 |      *
1097 |      * @return object Response to API call, probably empty.
1098 |      */
1099 |     public function wikiUnban($subreddit, $user);
1100 | 
1101 |     /**
1102 |      * Add a user as a contributor to a subreddit's wiki.
1103 |      *
1104 |      * @param  string  $subreddit  Subreddit to which to add user.
1105 |      * @param  string  $user  Username of user to add.
1106 |      *
1107 |      * @return object Response to API call.
1108 |      */
1109 |     public function addWikiContributor($subreddit, $user);
1110 | 
1111 |     /**
1112 |      * Remove a user as a contributor from a subreddit's wiki.
1113 |      *
1114 |      * @param  string  $subreddit  Subreddit from which to remove the user.
1115 |      * @param  string  $user  Username of user to remove.
1116 |      *
1117 |      * @return mixed|null Response to API call, probably empty.
1118 |      */
1119 |     public function removeWikiContributor($subreddit, $user);
1120 | 
1121 |     /**
1122 |      * Mute a user in the specified subreddit by username.
1123 |      *
1124 |      * @param  string  $subreddit  Subreddit in which to mute the user.
1125 |      * @param  string  $user  Username of user to mute.
1126 |      * @param  string|null  $note  Mute note in muted users list. Not shown to user.
1127 |      *
1128 |      * @return object Response to API call.
1129 |      */
1130 |     public function mute($subreddit, $user, $note = null);
1131 | 
1132 |     /**
1133 |      * Unmute a user in the specified subreddit by username.
1134 |      *
1135 |      * @param  string  $subreddit  Subreddit to which to unmute the user.
1136 |      * @param  string  $user  Username of user to unmute.
1137 |      *
1138 |      * @return object Response to API call, probably empty.
1139 |      */
1140 |     public function unmute($subreddit, $user);
1141 | 
1142 |     /**
1143 |      * Mute a user from a subreddit based on the thing ID of a message they sent.
1144 |      *
1145 |      * @param  string  $thing_id  Thing ID of the message author to be muted.
1146 |      *
1147 |      * @return object Response to API call, probably empty.
1148 |      */
1149 |     public function muteUserByMessage($thing_id);
1150 | 
1151 |     /**
1152 |      * Unmute a user from a subreddit based on the thing ID of a message they sent.
1153 |      *
1154 |      * @param  string  $thing_id  Thing ID of the message author to be unmuted.
1155 |      *
1156 |      * @return object Response to API call, probably empty.
1157 |      */
1158 |     public function unmuteUserByMessage($thing_id);
1159 | 
1160 |     /**
1161 |      * Lock a post and prevent any new comments by non-moderators.
1162 |      *
1163 |      * @param  string  $thing_id  Thing ID of post to lock. Must be a post, not a comment.
1164 |      *
1165 |      * @return object Response to API call, probably empty.
1166 |      */
1167 |     public function lockThread($thing_id);
1168 | 
1169 |     /**
1170 |      * Unlock a post and allow any new comments.
1171 |      *
1172 |      * @param  string  $thing_id  Thing ID of post to unlock.
1173 |      *
1174 |      * @return object Response to API call, probably empty.
1175 |      */
1176 |     public function unlockThread($thing_id);
1177 | 
1178 |     /**
1179 |      * Copy an existing multireddit to your own set.
1180 |      *
1181 |      * @param  string  $from_user  Owner of multireddit to copy.
1182 |      * @param  string  $from_name  Name of multireddit to copy.
1183 |      * @param  string  $to_name  Name of destination multireddit.
1184 |      *
1185 |      * @return object Resulting multireddit object.
1186 |      */
1187 |     public function multiCopy($from_user, $from_name, $to_name);
1188 | 
1189 |     /**
1190 |      * Retrieves a list of multireddits that are owned by the current user.
1191 |      *
1192 |      * @return array Contains multireddit objects.
1193 |      */
1194 |     public function multiGetMine(): array;
1195 | 
1196 |     /**
1197 |      * Retrieves a list of multireddits owned by the specified user.
1198 |      *
1199 |      * @param  string  $user  Username of user for which to retrieve owned multireddits.
1200 |      * @param  bool  $expand_srs  Obtain extra details about the subreddits of each multireddit.
1201 |      *
1202 |      * @return array Multireddit objects.
1203 |      */
1204 |     public function multiGetUser($user, $expand_srs = false): array;
1205 | 
1206 |     /**
1207 |      * Renames a subreddit. Functions like copying the existing subreddit then deleting the old one.
1208 |      *
1209 |      * @param  string  $from_name  Name of multireddit to rename.
1210 |      * @param  string  $to_name  Destination name.
1211 |      *
1212 |      * @return object Resulting multireddit object.
1213 |      */
1214 |     public function multiRename($from_name, $to_name);
1215 | 
1216 |     /**
1217 |      * Retrieves a multireddit.
1218 |      *
1219 |      * @param  string  $user  Owner of multireddit to retrieve.
1220 |      * @param  string  $name  Name of multireddit to retrieve.
1221 |      *
1222 |      * @return object Multireddit object.
1223 |      */
1224 |     public function multiGet($user, $name);
1225 | 
1226 |     /**
1227 |      * Create a multireddit. If multireddit of name already exists, an incremented number is appended to the end.
1228 |      *
1229 |      * @param  string  $name  Name (and URL) of new multireddit.
1230 |      * @param  string|array  $subreddits  Array or comma-delimited string of one or more subreddits that should go in the multireddit.
1231 |      * @param  string|null  $description  Multireddit sidebar text.
1232 |      * @param  string  $visibility  One of 'public', 'private', 'hidden'. Hidden multireddits will not be visible to you except through the API.
1233 |      * @param  string  $weighting_scheme  One of 'classic', 'fresh'.
1234 |      * @param  string|null  $icon  Not really used, but see https://www.reddit.com/dev/api#POST_api_multi_{multipath} for possible values.
1235 |      * @param  string  $key_color  Not really used, but can be hex color.
1236 |      *
1237 |      * @return object Multireddit object of new multireddit.
1238 |      */
1239 |     public function multiCreate(
1240 |         $name,
1241 |         $subreddits = [],
1242 |         $description = null,
1243 |         $visibility = 'private',
1244 |         $weighting_scheme = 'classic',
1245 |         $icon = null,
1246 |         $key_color = '#cee3f8'
1247 |     );
1248 | 
1249 |     /**
1250 |      * Update an existing multireddit. If one of the specified name does not exits, one will be created.
1251 |      * Fields to not be updated should be null.
1252 |      *
1253 |      * @param  string  $name  Name (and URL) of new multireddit.
1254 |      * @param  string|null  $subreddits  Array or comma-delimited string of one or more subreddits that should go in the multireddit.
1255 |      * @param  string|null  $description  Multireddit sidebar text.
1256 |      * @param  string  $visibility  One of 'public', 'private', 'hidden'. Hidden multireddits will not be visible to you except through the API.
1257 |      * @param  string|null  $weighting_scheme  One of 'classic', 'fresh'.
1258 |      * @param  string|null  $icon  Not really used, but see https://www.reddit.com/dev/api#POST_api_multi_{multipath} for possible values.
1259 |      * @param  string|null  $key_color  Not really used, but can be hex color.
1260 |      *
1261 |      * @return object Multireddit object of resulting multireddit.
1262 |      */
1263 |     public function multiEdit(
1264 |         $name,
1265 |         $subreddits = null,
1266 |         $description = null,
1267 |         $visibility = null,
1268 |         $weighting_scheme = null,
1269 |         $icon = null,
1270 |         $key_color = null
1271 |     );
1272 | 
1273 |     /**
1274 |      * Deletes the specified multireddit.
1275 |      *
1276 |      * @param  string  $name  Name of multireddit to delete.
1277 |      *
1278 |      * @return null Response to API call, probably null.
1279 |      */
1280 |     public function multiDelete($name);
1281 | 
1282 |     /**
1283 |      * Get the description/sidebar for the specified multireddit.
1284 |      *
1285 |      * @param  string  $user  Owner of multireddit.
1286 |      * @param  string  $name  Name of multireddit.
1287 |      *
1288 |      * @return object Response to API call, a LabeledMultiDescription object.
1289 |      */
1290 |     public function multiGetDescription($user, $name);
1291 | 
1292 |     /**
1293 |      * Edit the description/sidebar for the specified multireddit.
1294 |      *
1295 |      * @param  string  $name  Name of multireddit.
1296 |      * @param  string  $description  New description.
1297 |      *
1298 |      * @return object Response to API call, LabeledMultiDescription object.
1299 |      */
1300 |     public function multiEditDescription($name, $description);
1301 | 
1302 |     /**
1303 |      * Get information about the specified subreddit in the specified multireddit. Kinda useless, since it only returns the name at this point.
1304 |      *
1305 |      * @param  string  $user  Owner of multireddit.
1306 |      * @param  string  $name  Name of multireddit.
1307 |      * @param  string  $subreddit  Subreddit for which to obtain information.
1308 |      *
1309 |      * @return object Response to API call, only contains subreddit name.
1310 |      */
1311 |     public function multiGetSubreddit($user, $name, $subreddit);
1312 | 
1313 |     /**
1314 |      * Add the specified subreddit to the specified multireddit.
1315 |      *
1316 |      * @param  string  $name  Name of multireddit.
1317 |      * @param  string  $subreddit  Name of subreddit to add.
1318 |      *
1319 |      * @return object Response to API call, only contains the subreddit name.
1320 |      */
1321 |     public function multiAddSubreddit($name, $subreddit);
1322 | 
1323 |     /**
1324 |      * Remove the specified subreddit from the specified multireddit.
1325 |      *
1326 |      * @param  string  $name  Name of multireddit.
1327 |      * @param  string  $subreddit  Name of subreddit to remove.
1328 |      *
1329 |      * @return object Response to API call, probably null.
1330 |      */
1331 |     public function multiRemoveSubreddit($name, $subreddit);
1332 | 
1333 |     /**
1334 |      * Perform a search query.
1335 |      * Somewhat untested due to the complexity of and possible combinations to use in the search function.
1336 |      *
1337 |      * @param  string  $query  Query of which to search.
1338 |      * @param  string|null  $subreddit  Subreddit to which to restrict search.
1339 |      * @param  string|null  $sort  Sort results by one of 'relevance', 'hot', 'top', 'new', 'comments'. Defaults to 'relevance'.
1340 |      * @param  string|null  $time  One of 'hour', 'day', 'week', 'month', 'year', 'all'. Defaults to all.
1341 |      * @param  string|null  $type  Comma-delimited list of result types: 'sr', 'link', or null.
1342 |      * @param  int  $limit  Upper limit of results to return.
1343 |      * @param  string|null  $after  Obtain list items below this thing ID.
1344 |      * @param  string|null  $before  Obtain list of items above this thing ID.
1345 |      *
1346 |      * @return object Listing of search results
1347 |      */
1348 |     public function search(
1349 |         $query,
1350 |         $subreddit = null,
1351 |         $sort = null,
1352 |         $time = null,
1353 |         $type = null,
1354 |         $limit = 25,
1355 |         $after = null,
1356 |         $before = null
1357 |     );
1358 | 
1359 |     /**
1360 |      * Retrieves information about the specified subreddit, including subreddit ID.
1361 |      *
1362 |      * @param  string  $subreddit  Name of subreddit for which to retrieve information.
1363 |      *
1364 |      * @return object Contains subreddit information.
1365 |      */
1366 |     public function aboutSubreddit($subreddit);
1367 | 
1368 |     /**
1369 |      * Retrieve a list of banned users from the specified subreddit. Must be a mod with access permissions.
1370 |      * Using pagination will result in the last item of the previous page appearing as the first item of the next page.
1371 |      *
1372 |      * @param  string  $subreddit  Subreddit for which to retrieve banned users.
1373 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1374 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1375 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1376 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1377 |      *
1378 |      * @return object Listing of users.
1379 |      */
1380 |     public function getBanned($subreddit, $user = null, $limit = 25, $after = null, $before = null);
1381 | 
1382 |     /**
1383 |      * Retrieve a list of muted users from the specified subreddit. Must be a mod with access permissions.
1384 |      * Using pagination will result in the last item of the previous page appearing as the first item of the next page.
1385 |      *
1386 |      * @param  string  $subreddit  Subreddit for which to retrieve muted users.
1387 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1388 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1389 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1390 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1391 |      *
1392 |      * @return object Listing of users.
1393 |      */
1394 |     public function getMuted($subreddit, $user = null, $limit = 25, $after = null, $before = null);
1395 | 
1396 |     /**
1397 |      * Retrieve a list of wiki banned users from the specified subreddit. Must be a mod with access permissions.
1398 |      * Using pagination will result in the last item of the previous page appearing as the first item of the next page.
1399 |      *
1400 |      * @param  string  $subreddit  Subreddit for which to retrieve wiki banned users.
1401 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1402 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1403 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1404 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1405 |      *
1406 |      * @return object Listing of users.
1407 |      */
1408 |     public function getWikiBanned($subreddit, $user = null, $limit = 25, $after = null, $before = null);
1409 | 
1410 |     /**
1411 |      * Retrieve a list of approved submitters from the specified subreddit. Must be a mod or approved submitter in subreddit.
1412 |      * Using pagination will result in the last item of the previous page appearing as the first item of the next page.
1413 |      *
1414 |      * @param  string  $subreddit  Subreddit for which to retrieve approved submitters.
1415 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1416 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1417 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1418 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1419 |      *
1420 |      * @return object Listing of users.
1421 |      */
1422 |     public function getContributors($subreddit, $user = null, $limit = 25, $after = null, $before = null);
1423 | 
1424 |     /**
1425 |      * Retrieve a list of approved wiki contributors from the specified subreddit. Must be a mod or approved wiki contributor in subreddit.
1426 |      * Using pagination will result in the last item of the previous page appearing as the first item of the next page.
1427 |      *
1428 |      * @param  string  $subreddit  Subreddit for which to retrieve approved wiki contributors.
1429 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1430 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1431 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1432 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1433 |      *
1434 |      * @return object Listing of users.
1435 |      */
1436 |     public function getWikiContributors($subreddit, $user = null, $limit = 25, $after = null, $before = null);
1437 | 
1438 |     /**
1439 |      * Retrieve a list of moderators from the specified subreddit. Must have read access to subreddit.
1440 |      * This function does not use pagination, but it's here anyway in case that's changed in the future.
1441 |      *
1442 |      * @param  string  $subreddit  Subreddit for which to retrieve moderators.
1443 |      * @param  string|null  $user  Jump to a specific user. Will return an empty list if user is not on list.
1444 |      *
1445 |      * @return object Listing of users.
1446 |      */
1447 |     public function getModerators($subreddit, $user = null);
1448 | 
1449 |     /**
1450 |      * Upload an image to the specified subreddit.
1451 |      *
1452 |      * @param  string  $subreddit  Subreddit to which to upload image.
1453 |      * @param  string  $file  Relative or absolute path of file to upload from local machine.
1454 |      * @param  string  $name  If $upload_type is 'img', assign the image this name. Ignored otherwise.
1455 |      * @param  string  $upload_type  One of 'img', 'header', 'icon', 'banner'. As of now, 'icon' and 'banner' will result in an error.
1456 |      * @param  string  $image_type  One of 'png' or 'jpg'.
1457 |      *
1458 |      * @return object Response to API call. On success, shows image URL. Null if the local file cannot be found.
1459 |      */
1460 |     public function uploadSubredditImage($subreddit, $file, $name, $upload_type = 'img', $image_type = 'png');
1461 | 
1462 |     /**
1463 |      * Remove the subreddit's custom mobile banner.
1464 |      *
1465 |      * @param  string  $subreddit  Subreddit from which to remove the banner.
1466 |      *
1467 |      * @return object Response to API call.
1468 |      */
1469 |     public function deleteSubredditBanner($subreddit);
1470 | 
1471 |     /**
1472 |      * Remove the subreddit's custom header image.
1473 |      *
1474 |      * @param  string  $subreddit  Subreddit from which to remove the header image.
1475 |      *
1476 |      * @return object Response to API call.
1477 |      */
1478 |     public function deleteSubredditHeaderImage($subreddit);
1479 | 
1480 |     /**
1481 |      * Remove the subreddit's custom mobile icon.
1482 |      *
1483 |      * @param  string  $subreddit  Subreddit from which to remove the icon.
1484 |      *
1485 |      * @return object Response to API call.
1486 |      */
1487 |     public function deleteSubredditIcon($subreddit);
1488 | 
1489 |     /**
1490 |      * Remove an image from the subreddit's custom image set.
1491 |      *
1492 |      * @param  string  $subreddit  Subreddit from which to remove the image.
1493 |      * @param  string  $image_name  The name of the image to delete.
1494 |      *
1495 |      * @return object Response to API call.
1496 |      */
1497 |     public function deleteSubredditImage($subreddit, $image_name);
1498 | 
1499 |     /**
1500 |      * Retrieve a list of recommended subreddits based on the names of existing ones.
1501 |      *
1502 |      * @param  string  $subreddits  Comma-delimited list of subreddits on which to base recommendations.
1503 |      * @param  string|null  $omit  Omit these specific subreddits from results.
1504 |      *
1505 |      * @return array Recommended subreddit objects containing subreddit names.
1506 |      */
1507 |     public function getRecommendedSubreddits($subreddits, $omit = null): array;
1508 | 
1509 |     /**
1510 |      * List subreddit names that begin with a query string.
1511 |      *
1512 |      * @param  string  $query  Search for subreddits that start with this. Maximum 50 characters, all printable.
1513 |      * @param  bool  $include_nsfw  Include subreddits that are set as NSFW (over_18).
1514 |      * @param  bool  $exact  Only return exact match.
1515 |      *
1516 |      * @return object Contains an array of subreddit names.
1517 |      */
1518 |     public function searchSubredditsByName($query, $include_nsfw = true, $exact = false);
1519 | 
1520 |     /**
1521 |      * Retrieves the "submitting to /r/$subreddit" text for the selected subreddit.
1522 |      *
1523 |      * @param  string  $subreddit  Name of subreddit from which to obtain submit text.
1524 |      *
1525 |      * @return object Response to API call, containing the subreddit's submit_text.
1526 |      */
1527 |     public function getSubmitText($subreddit);
1528 | 
1529 |     /**
1530 |      * Get a subreddit's stylesheet.
1531 |      *
1532 |      * @param  string  $subreddit  Subreddit of which to retrieve stylesheet.
1533 |      *
1534 |      * @return object Wikipage object of subreddit's stylesheet, including text and list of images.
1535 |      */
1536 |     public function getSubredditStylesheet($subreddit);
1537 | 
1538 |     /**
1539 |      * Set a subreddit's stylesheet.
1540 |      *
1541 |      * @param  string  $subreddit  Subreddit of which to set stylesheet.
1542 |      * @param  string  $contents  Contents of stylesheet, probably pretty long.
1543 |      * @param  string|null  $reason  Since the stylesheet is a wiki page, optionally provide a reason for editing.
1544 |      *
1545 |      * @return object Response to API call, possibly containing errors if invalid CSS.
1546 |      */
1547 |     public function setSubredditStylesheet($subreddit, $contents, $reason = null);
1548 | 
1549 |     /**
1550 |      * Search for subreddits by topic keywords.
1551 |      *
1552 |      * @param  string  $query  Query with which to search.
1553 |      *
1554 |      * @return array List of objects containing subreddit names.
1555 |      */
1556 |     public function searchSubredditsByTopic($query): array;
1557 | 
1558 |     /**
1559 |      * Subscribe to a subreddit. Must have read access to the subreddit.
1560 |      *
1561 |      * @param  string  $subreddit  Subreddit to which to subscribe.
1562 |      *
1563 |      * @return object Response to API call, probably empty.
1564 |      */
1565 |     public function subscribe($subreddit);
1566 | 
1567 |     /**
1568 |      * Unsubscribe from a subreddit.
1569 |      *
1570 |      * @param  string  $subreddit  Subreddit from which to unsubscribe.
1571 |      *
1572 |      * @return object Response to API call, probably empty. 404 error if not already subscribed.
1573 |      */
1574 |     public function unsubscribe($subreddit);
1575 | 
1576 |     /**
1577 |      * Retrieve a list of the subreddit's settings. Must be a moderator.
1578 |      *
1579 |      * @param  string  $subreddit  The subreddit to retrieve.
1580 |      *
1581 |      * @return object Contains information about a subreddit's settings.
1582 |      */
1583 |     public function getSubredditSettings($subreddit);
1584 | 
1585 |     /**
1586 |      * Get a subreddit's sidebar contents.
1587 |      *
1588 |      * @param  string  $subreddit  Subreddit of which to retrieve sidebar.
1589 |      *
1590 |      * @return object Wikipage object of subreddit's sidebar.
1591 |      */
1592 |     public function getSubredditSidebar($subreddit);
1593 | 
1594 |     /**
1595 |      * Retrieve a subreddit's stickied posts.
1596 |      *
1597 |      * @param  string  $subreddit  Subreddit from which to retrieve sticky posts.
1598 |      *
1599 |      * @return array Contains link objects that are stickied in the subreddit. None if no sticky. If two, top sticky is first.
1600 |      */
1601 |     public function getStickies($subreddit): array;
1602 | 
1603 |     /**
1604 |      * Search for subreddits by title and description.
1605 |      *
1606 |      * @param  string  $query  Query with which to search
1607 |      * @param  string  $sort  Sorting method. One of 'relevance', 'activity'
1608 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1609 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1610 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1611 |      *
1612 |      * @return object Listing of subreddits that match the search query.
1613 |      */
1614 |     public function searchSubreddits($query, $sort = 'relevance', $limit = 25, $after = null, $before = null);
1615 | 
1616 |     /**
1617 |      * Retrieve a list of the current user's subscribed subreddits.
1618 |      *
1619 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1620 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1621 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1622 |      *
1623 |      * @return object Listing of subreddits.
1624 |      */
1625 |     public function getMySubscribedSubreddits($limit = 25, $after = null, $before = null);
1626 | 
1627 |     /**
1628 |      * Retrieve a list of the current user's subreddits in which they are an approved submitter.
1629 |      *
1630 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1631 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1632 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1633 |      *
1634 |      * @return object Listing of subreddits.
1635 |      */
1636 |     public function getMyContributedSubreddits($limit = 25, $after = null, $before = null);
1637 | 
1638 |     /**
1639 |      * Retrieve a list of the current user's subreddits in which they are a moderator.
1640 |      *
1641 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1642 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1643 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1644 |      *
1645 |      * @return object Listing of subreddits.
1646 |      */
1647 |     public function getMyModeratedSubreddits($limit = 25, $after = null, $before = null);
1648 | 
1649 |     /**
1650 |      * Retrieves a list of popular subreddits.
1651 |      *
1652 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1653 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1654 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1655 |      *
1656 |      * @return object Listing of subreddits.
1657 |      */
1658 |     public function getPopularSubreddits($limit = 25, $after = null, $before = null);
1659 | 
1660 |     /**
1661 |      * Retrieves a list of new subreddits.
1662 |      *
1663 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1664 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1665 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1666 |      *
1667 |      * @return object Listing of subreddits.
1668 |      */
1669 |     public function getNewSubreddits($limit = 25, $after = null, $before = null);
1670 | 
1671 |     /**
1672 |      * Retrieves a list of gold-only subreddits.
1673 |      *
1674 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1675 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1676 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1677 |      *
1678 |      * @return object Listing of subreddits.
1679 |      */
1680 |     public function getGoldOnlySubreddits($limit = 25, $after = null, $before = null);
1681 | 
1682 |     /**
1683 |      * Retrieves a list of default subreddits.
1684 |      *
1685 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1686 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1687 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1688 |      *
1689 |      * @return object Listing of subreddits.
1690 |      */
1691 |     public function getDefaultSubreddits($limit = 25, $after = null, $before = null);
1692 | 
1693 |     /**
1694 |      * Create a new subreddit.
1695 |      *
1696 |      * @param  string  $subreddit  Name of subreddit to create.
1697 |      * @param  array  $settings  An array containing a key-value pair for each option you want to set (TITLE IS REQUIRED):
1698 |      *                                         'allow_top' (boolean) Allow this subreddit to be included /r/all as well as the default and trending lists.
1699 |      *                                         'collapse_deleted_comments' (boolean) Collapse deleted and removed comments.
1700 |      *                                         'comment_score_hide_mins' (int) Minutes to hide comment scores.
1701 |      *                                         'description' (string) Sidebar text.
1702 |      *                                         'exclude_banned_modqueue' (boolean) Exclude posts by site-wide banned users from modqueue/unmoderated.
1703 |      *                                         'header-title' (string) Header mouseover text.
1704 |      *                                         'hide_ads' (boolean) Hide ads (only available for gold only subreddits).
1705 |      *                                         'lang' (string) Language, a valid IETF language tag (underscore separated).
1706 |      *                                         'link_type' (string) Content options. One of 'any', 'link', 'self'.
1707 |      *                                         'over_18' (boolean) Viewers must be over eighteen years old.
1708 |      *                                         'public_description' (string) Description, appears in search results and social media links.
1709 |      *                                         'public_traffic' (boolean) Make the traffic stats page available to everyone.
1710 |      *                                         'show_media' (boolean) Show thumbnail images of content.
1711 |      *                                         'spam_comments' (string) Spam filter strength for comments. One of 'low', 'high', 'all'.
1712 |      *                                         'spam_links' (string) Spam filter strength for links. One of 'low', 'high', 'all'.
1713 |      *                                         'spam_selfposts' (string) Spam filter strength for self posts. One of 'low', 'high', 'all'.
1714 |      *                                         'submit_link_label' (string) Custom label for submit link button (blank for default).
1715 |      *                                         'submit_text' (string) Submission text, text to show on submission page.
1716 |      *                                         'submit_text_label' (string) Custom label for submit text post button (blank for default).
1717 |      *                                         'suggested_comment_sort' (string) Suggested comment sort. One of 'confidence', 'top', 'new', 'hot', 'controversial', 'old', 'random', 'qa'
1718 |      *                                         'title' (string) Subreddit title, shown in the browser tab.
1719 |      *                                         'type' (string) Subreddit type. One of 'restricted', 'private', 'public'. Other values are 'gold_restricted', 'archived', 'gold_only' and 'employees_only', but result in errors.
1720 |      *                                         'wiki_edit_age' (int) Account age (days) required to edit and create wiki pages.
1721 |      *                                         'wiki_edit_karma' (int) Subreddit karma required to edit and create wiki pages.
1722 |      *                                         'wikimode' (string) Who should be able to edit the wiki. One of 'disabled', 'modonly', 'anyone'.
1723 |      * @param  bool  $i_read_the_documentation  Must be set to true to show that you've read this.
1724 |      *
1725 |      * @return object Response to API call. (Watch for RATELIMIT errors.)
1726 |      */
1727 |     public function createSubreddit($subreddit, $settings, $i_read_the_documentation = false);
1728 | 
1729 |     /**
1730 |      * Change a subreddit's configuration.
1731 |      *
1732 |      * @param  string  $subreddit  Name of subreddit to change.
1733 |      * @param  array  $settings  An array containing a key-value pair for each option you want to change:
1734 |      *                                         'allow_top' (boolean) Allow this subreddit to be included /r/all as well as the default and trending lists.
1735 |      *                                         'collapse_deleted_comments' (boolean) Collapse deleted and removed comments.
1736 |      *                                         'comment_score_hide_mins' (int) Minutes to hide comment scores.
1737 |      *                                         'description' (string) Sidebar text.
1738 |      *                                         'exclude_banned_modqueue' (boolean) Exclude posts by site-wide banned users from modqueue/unmoderated.
1739 |      *                                         'header-title' (string) Header mouseover text.
1740 |      *                                         'hide_ads' (boolean) Hide ads (only available for gold only subreddits).
1741 |      *                                         'lang' (string) Language, a valid IETF language tag (underscore separated).
1742 |      *                                         'link_type' (string) Content options. One of 'any', 'link', 'self'.
1743 |      *                                         'over_18' (boolean) Viewers must be over eighteen years old.
1744 |      *                                         'public_description' (string) Description, appears in search results and social media links.
1745 |      *                                         'public_traffic' (boolean) Make the traffic stats page available to everyone.
1746 |      *                                         'show_media' (boolean) Show thumbnail images of content.
1747 |      *                                         'spam_comments' (string) Spam filter strength for comments. One of 'low', 'high', 'all'.
1748 |      *                                         'spam_links' (string) Spam filter strength for links. One of 'low', 'high', 'all'.
1749 |      *                                         'spam_selfposts' (string) Spam filter strength for self posts. One of 'low', 'high', 'all'.
1750 |      *                                         'submit_link_label' (string) Custom label for submit link button (blank for default).
1751 |      *                                         'submit_text' (string) Submission text, text to show on submission page.
1752 |      *                                         'submit_text_label' (string) Custom label for submit text post button (blank for default).
1753 |      *                                         'suggested_comment_sort' (string) Suggested comment sort. One of 'confidence', 'top', 'new', 'hot', 'controversial', 'old', 'random', 'qa'.
1754 |      *                                         'title' (string) Subreddit title, shown in the browser tab.
1755 |      *                                         'type' (string) Subreddit type. One of 'restricted', 'private', 'public'. Other values are 'gold_restricted', 'archived', 'gold_only' and 'employees_only', but result in errors.
1756 |      *                                         'wiki_edit_age' (int) Account age (days) required to edit and create wiki pages.
1757 |      *                                         'wiki_edit_karma' (int) Subreddit karma required to edit and create wiki pages.
1758 |      *                                         'wikimode' (string) Who should be able to edit the wiki. One of 'disabled', 'modonly', 'anyone'.
1759 |      * @param  bool  $i_read_the_documentation  Must be set to true to show that you've read this.
1760 |      *
1761 |      * @return object Response to API call. (RATELIMIT errors can be ignored if you have recently created a subreddit.)
1762 |      */
1763 |     public function editSubreddit($subreddit, $settings, $i_read_the_documentation = false);
1764 | 
1765 |     /**
1766 |      * Adds the specified user as a friend.
1767 |      *
1768 |      * @param  string  $user  Username of friend to add.
1769 |      * @param  string|null  $note  Note to add to friend record. Currently only available to those with reddit gold.
1770 |      *
1771 |      * @return object A friend record object.
1772 |      */
1773 |     public function addFriend($user, $note = null);
1774 | 
1775 |     /**
1776 |      * Removes the specified user as a friend.
1777 |      *
1778 |      * @param  string  $user  Username of user to remove.
1779 |      *
1780 |      * @return null Response to API call, null for some reason.
1781 |      */
1782 |     public function removeFriend($user);
1783 | 
1784 |     /**
1785 |      * Unblock a user by username.
1786 |      *
1787 |      * @param  string  $user  Username of user to unblock.
1788 |      *
1789 |      * @return object Response to API call.
1790 |      */
1791 |     public function unblockUser($user);
1792 | 
1793 |     /**
1794 |      * Presumably checks whether the specified username is available, but endpoint is not working at this time.
1795 |      *
1796 |      * @param  string  $username  Username to check for availability.
1797 |      *
1798 |      * @return object Response to API call.
1799 |      */
1800 |     public function usernameAvailable($username);
1801 | 
1802 |     /**
1803 |      * Check notifications? Not documented by reddit.
1804 |      *
1805 |      * @param  string|null  $start_date  Start date of notification records.
1806 |      * @param  string|null  $end_date  End date of notification records.
1807 |      * @param  string|null  $sort  One of 'new', 'old', or null.
1808 |      *
1809 |      * @return array List of notification objects from reddit.
1810 |      */
1811 |     public function getNotifications($start_date = null, $end_date = null, $sort = null): array;
1812 | 
1813 |     /**
1814 |      * Mark a notification as read based on its thing ID.
1815 |      *
1816 |      * @param  string  $thing_id  Thing ID of the notification to mark as read.
1817 |      * @param  bool  $read  Whether or not to mark as read. False doesn't seem to be working.
1818 |      *
1819 |      * @return mixed Response to API call, probably null, but could change in the future.
1820 |      */
1821 |     public function markNotificationAsRead($thing_id, $read = true);
1822 | 
1823 |     /**
1824 |      * Get a user's trophies.
1825 |      *
1826 |      * @param  string  $user  Username of user for whom to retrieve trophies.
1827 |      *
1828 |      * @return object Listing of trophies.
1829 |      */
1830 |     public function getUserTrophies($user);
1831 | 
1832 |     /**
1833 |      * Retrieve information about the specified user.
1834 |      *
1835 |      * @param  string  $user  Username of user to retrieve.
1836 |      *
1837 |      * @return object Response to API call containing user object.
1838 |      */
1839 |     public function getUser($user);
1840 | 
1841 |     /**
1842 |      * Obtain posts and comments made by the specified user.
1843 |      *
1844 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1845 |      * @param  string|null  $sort  Sorting method. One of 'hot', 'new', 'top', 'controversial', or null.
1846 |      * @param  string|null  $time  One of 'hour', 'day', 'week', 'month', 'year', 'all', or null.
1847 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1848 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1849 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1850 |      *
1851 |      * @return object Listing of posts and comments made by the specified user.
1852 |      */
1853 |     public function getUserOverview(
1854 |         $user = null,
1855 |         $sort = null,
1856 |         $time = null,
1857 |         $limit = 25,
1858 |         $after = null,
1859 |         $before = null
1860 |     );
1861 | 
1862 |     /**
1863 |      * Obtain only posts made by the specified user.
1864 |      *
1865 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1866 |      * @param  string|null  $sort  Sorting method. One of 'hot', 'new', 'top', 'controversial', or null.
1867 |      * @param  string|null  $time  One of 'hour', 'day', 'week', 'month', 'year', 'all', or null.
1868 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1869 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1870 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1871 |      *
1872 |      * @return object Listing of posts comments made by the specified user.
1873 |      */
1874 |     public function getUserSubmitted(
1875 |         $user = null,
1876 |         $sort = null,
1877 |         $time = null,
1878 |         $limit = 25,
1879 |         $after = null,
1880 |         $before = null
1881 |     );
1882 | 
1883 |     /**
1884 |      * Obtain only comments made by the specified user.
1885 |      *
1886 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1887 |      * @param  string|null  $sort  Sorting method. One of 'hot', 'new', 'top', 'controversial', or null.
1888 |      * @param  string|null  $time  One of 'hour', 'day', 'week', 'month', 'year', 'all', or null.
1889 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1890 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1891 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1892 |      *
1893 |      * @return object Listing of comments made by the specified user.
1894 |      */
1895 |     public function getUserComments(
1896 |         $user = null,
1897 |         $sort = null,
1898 |         $time = null,
1899 |         $limit = 25,
1900 |         $after = null,
1901 |         $before = null
1902 |     );
1903 | 
1904 |     /**
1905 |      * Obtain posts and comments upvoted by the specified user.
1906 |      *
1907 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1908 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1909 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1910 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1911 |      *
1912 |      * @return object Listing of posts and comments upvoted by the specified user.
1913 |      */
1914 |     public function getUserUpvoted($user = null, $limit = 25, $after = null, $before = null);
1915 | 
1916 |     /**
1917 |      * Obtain posts and comments downvoted by the specified user.
1918 |      *
1919 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1920 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1921 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1922 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1923 |      *
1924 |      * @return object Listing of posts and comments downvoted by the specified user.
1925 |      */
1926 |     public function getUserDownvoted($user = null, $limit = 25, $after = null, $before = null);
1927 | 
1928 |     /**
1929 |      * Obtain posts and comments hidden by the specified user.
1930 |      *
1931 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1932 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1933 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1934 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1935 |      *
1936 |      * @return object Listing of posts and comments hidden by the specified user.
1937 |      */
1938 |     public function getUserHidden($user = null, $limit = 25, $after = null, $before = null);
1939 | 
1940 |     /**
1941 |      * Obtain posts and comments saved by the specified user.
1942 |      *
1943 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1944 |      * @param  string|null  $sort  Sorting method. One of 'hot', 'new', 'top', 'controversial', or null.
1945 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1946 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1947 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1948 |      *
1949 |      * @return object Listing of posts and comments saved by the specified user.
1950 |      */
1951 |     public function getUserSaved($user = null, $sort = null, $limit = 25, $after = null, $before = null);
1952 | 
1953 |     /**
1954 |      * Obtain posts and comments gilded (received) by the specified user.
1955 |      *
1956 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1957 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1958 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1959 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1960 |      *
1961 |      * @return object Listing of posts and/or comments made by the specified user.
1962 |      */
1963 |     public function getUserGildingsReceived($user = null, $limit = 25, $after = null, $before = null);
1964 | 
1965 |     /**
1966 |      * Obtain posts and comments gilded (given) by the specified user.
1967 |      *
1968 |      * @param  string  $user  Username of user for whom to retrieve records. Defaults to the current user.
1969 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
1970 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
1971 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
1972 |      *
1973 |      * @return object Listing of posts and/or comments made by the specified user.
1974 |      */
1975 |     public function getUserGildingsGiven($user = null, $limit = 25, $after = null, $before = null);
1976 | 
1977 |     /**
1978 |      * Allow the specified user to edit the specified wiki page.
1979 |      *
1980 |      * @param  string  $subreddit  Subreddit of the wiki page.
1981 |      * @param  string  $username  Username of user to allow.
1982 |      * @param  string  $pagename  Name of page to allow user to edit.
1983 |      *
1984 |      * @return object Response to API call. Probably empty, but could contain errors, such as PAGE_NOT_FOUND.
1985 |      */
1986 |     public function wikiAllowEditor($subreddit, $username, $pagename);
1987 | 
1988 |     /**
1989 |      * Remove the specified user from the allowed editors list of the specified wiki page.
1990 |      *
1991 |      * @param  string  $subreddit  Subreddit of the wiki page.
1992 |      * @param  string  $username  Username of user to allow.
1993 |      * @param  string  $pagename  Name of page to disallow user to edit.
1994 |      *
1995 |      * @return object Response to API call. Probably empty, but could contain errors, such as PAGE_NOT_FOUND.
1996 |      */
1997 |     public function wikiDisallowEditor($subreddit, $username, $pagename);
1998 | 
1999 |     /**
2000 |      * Retrieves a list of all pages of the specified subreddit's wiki.
2001 |      *
2002 |      * @param  string  $subreddit  Subreddit for which to retrieve pages.
2003 |      *
2004 |      * @return object Listing of wiki pages.
2005 |      */
2006 |     public function wikiGetPages($subreddit);
2007 | 
2008 |     /**
2009 |      * Retrieves the specified wiki page, optionally at a specific revision or a comparison between revisions.
2010 |      *
2011 |      * @param  string  $subreddit  Subreddit in which to retrieve page.
2012 |      * @param  string  $pagename  Page to retrieve.
2013 |      * @param  string|null  $revision_id  Specific revision ID to retrieve (optional).
2014 |      * @param  string|null  $compare_with  ID of revision with which to compare $revision_id (optional2). May not be working.
2015 |      *
2016 |      * @return mixed
2017 |      */
2018 |     public function wikiGetPage($subreddit, $pagename, $revision_id = null, $compare_with = null);
2019 | 
2020 |     /**
2021 |      * Retrieves a listing of wiki revisions for all pages within the specified subreddit.
2022 |      *
2023 |      * @param  string  $subreddit  Subreddit for which to retrieve revisions.
2024 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
2025 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
2026 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
2027 |      *
2028 |      * @return object Listing of wiki page revisions.
2029 |      */
2030 |     public function wikiGetRevisions($subreddit, $limit = 25, $after = null, $before = null);
2031 | 
2032 |     /**
2033 |      * Retrieves a listing of wiki revisions for the specified page within the specified subreddit.
2034 |      *
2035 |      * @param  string  $subreddit  Subreddit for which to retrieve revisions.
2036 |      * @param  string  $pagename  Page for which to retrieve revisions.
2037 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
2038 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
2039 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
2040 |      *
2041 |      * @return object Listing of wiki page revisions.
2042 |      */
2043 |     public function wikiGetPageRevisions($subreddit, $pagename, $limit = 25, $after = null, $before = null);
2044 | 
2045 |     /**
2046 |      * Edit or create a wiki page.
2047 |      *
2048 |      * @param  string  $subreddit  Subreddit in which to edit page.
2049 |      * @param  string  $pagename  Page to edit.
2050 |      * @param  string  $content  Content with which to overwrite page.
2051 |      * @param  string|null  $reason  Reason for revision, optional.
2052 |      * @param  string|null  $previous  Revision ID on which to base this edit. Handled by function, so optional.
2053 |      *
2054 |      * @return object
2055 |      */
2056 |     public function wikiEditPage($subreddit, $pagename, $content, $reason = null, $previous = null);
2057 | 
2058 |     /**
2059 |      * Toggle a revision's status of hidden.
2060 |      *
2061 |      * @param  string  $subreddit  Subreddit of revision.
2062 |      * @param  string  $pagename  Pagename of revision.
2063 |      * @param  string  $revision_id  ID of revision to toggle hidden status.
2064 |      *
2065 |      * @return object Response to API call. Status attribute is true if the revision is now hidden, false if shown.
2066 |      */
2067 |     public function wikiToggleHideRevision($subreddit, $pagename, $revision_id);
2068 | 
2069 |     /**
2070 |      * Hide a revision from revision listing.
2071 |      * This may take two calls, since the only way to get a revision's hidden status is to toggle it.
2072 |      *
2073 |      * @param  string  $subreddit  Subreddit of revision.
2074 |      * @param  string  $pagename  Pagename of revision.
2075 |      * @param  string  $revision_id  ID of revision to hide.
2076 |      *
2077 |      * @return object Response to API call. Status attribute is true if the revision is now hidden, false if shown.
2078 |      */
2079 |     public function wikiHideRevision($subreddit, $pagename, $revision_id);
2080 | 
2081 |     /**
2082 |      * Unhide a revision in the revision listing.
2083 |      * This may take two calls, since the only way to get a revision's hidden status is to toggle it.
2084 |      *
2085 |      * @param  string  $subreddit  Subreddit of revision.
2086 |      * @param  string  $pagename  Pagename of revision.
2087 |      * @param  string  $revision_id  ID of revision to unhide.
2088 |      *
2089 |      * @return object Response to API call. Status attribute is true if the revision is now hidden, false if shown.
2090 |      */
2091 |     public function wikiUnhideRevision($subreddit, $pagename, $revision_id);
2092 | 
2093 |     /**
2094 |      * Revert a wiki page to a previous revision.
2095 |      *
2096 |      * @param  string  $subreddit  Subreddit of revision.
2097 |      * @param  string  $pagename  Pagename of revision.
2098 |      * @param  string  $revision_id  ID of revision to which to revert.
2099 |      *
2100 |      * @return object Response to API call, probably empty.
2101 |      */
2102 |     public function wikiRevertToRevision($subreddit, $pagename, $revision_id);
2103 | 
2104 |     /**
2105 |      * Retrieves a listing of discussions about a certain wiki page.
2106 |      *
2107 |      * @param  string  $subreddit  Subreddit of page.
2108 |      * @param  string  $pagename  Page for which to retrieve discussions.
2109 |      * @param  int  $limit  Upper limit of number of items to retrieve. Maximum is 100.
2110 |      * @param  string|null  $after  Get items lower on list than this entry. Does not mean chronologically.
2111 |      * @param  string|null  $before  Get items higher on list than this entry. Does not mean chronologically.
2112 |      *
2113 |      * @return object Listing of posts.
2114 |      */
2115 |     public function wikiGetPageDiscussions($subreddit, $pagename, $limit = 25, $after = null, $before = null);
2116 | 
2117 |     /**
2118 |      * Get the specified page's settings in the specified subreddit.
2119 |      *
2120 |      * @param  string  $subreddit  Subreddit of page.
2121 |      * @param  string  $pagename  Name of page.
2122 |      *
2123 |      * @return object Settings object for wiki page.
2124 |      */
2125 |     public function wikiGetPageSettings($subreddit, $pagename);
2126 | 
2127 |     /**
2128 |      * Update the specified page's settings in the specified subreddit.
2129 |      *
2130 |      * @param  string  $subreddit  Subreddit of page.
2131 |      * @param  string  $pagename  Name of page.
2132 |      * @param  int|null  $permlevel  Permissions level for page. 0 for use subreddit wiki permissions, 1 for only approved editors, 2 for only mods, null to not update.
2133 |      * @param  bool|null  $listed  Show this page on the list of wiki pages. True to show, false to hide, null to not update.
2134 |      *
2135 |      * @return object Settings object for wiki page.
2136 |      */
2137 |     public function wikiUpdatePageSettings($subreddit, $pagename, $permlevel = null, $listed = null);
2138 | 
2139 |     public function apiCall($path, $method = 'GET', $params = null, $json = false);
2140 | }


--------------------------------------------------------------------------------
/src/RedditAPIFacade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace CodeWizz\RedditAPI;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class RedditAPIFacade extends Facade
 8 | {
 9 |     protected static function getFacadeAccessor()
10 |     {
11 |         return 'laravel-reddit-api';
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/src/RedditAPIServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace CodeWizz\RedditAPI;
 4 | 
 5 | use CodeWizz\RedditAPI\Interfaces\RedditApiInterface;
 6 | use Illuminate\Support\ServiceProvider;
 7 | 
 8 | class RedditAPIServiceProvider extends ServiceProvider
 9 | {
10 |     /**
11 |      * Perform post-registration booting of services.
12 |      */
13 |     public function boot(): void
14 |     {
15 |         $this->publishes([
16 |             __DIR__ . '/config/reddit-api.php' => config_path('reddit-api.php'),
17 |         ], 'config');
18 |     }
19 | 
20 |     /**
21 |      * Register the service provider.
22 |      */
23 |     public function register()
24 |     {
25 |         $this->mergeConfigFrom(__DIR__ . '/config/reddit-api.php', 'reddit-api');
26 | 
27 |         $redditAPIConfig = config('reddit-api');
28 | 
29 |         $this->app->singleton('laravel-reddit-api', static function () use ($redditAPIConfig) {
30 |             return new RedditAPI($redditAPIConfig['username'], $redditAPIConfig['password'], $redditAPIConfig['app_id'], $redditAPIConfig['app_secret'], $redditAPIConfig['endpoint_standard'], $redditAPIConfig['endpoint_oauth'], $redditAPIConfig['response_format']);
31 |         });
32 | 
33 |         $this->app->bind(RedditApiInterface::class, function () use ($redditAPIConfig) {
34 |             return new RedditAPI(
35 |                 $redditAPIConfig['username'],
36 |                 $redditAPIConfig['password'],
37 |                 $redditAPIConfig['app_id'],
38 |                 $redditAPIConfig['app_secret'],
39 |                 $redditAPIConfig['endpoint_standard'],
40 |                 $redditAPIConfig['endpoint_oauth'],
41 |                 $redditAPIConfig['response_format']
42 |             );
43 |         });
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/src/RedditLive.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace CodeWizz\RedditAPI;
  4 | 
  5 | class RedditLive
  6 | {
  7 |     /** @var RedditAPI */
  8 |     private $redditAPI;
  9 |     private $thread_id;
 10 | 
 11 |     public function __construct($redditAPI, $thread_id)
 12 |     {
 13 |         $this->redditAPI = $redditAPI;
 14 |         $this->thread_id = $thread_id;
 15 |     }
 16 | 
 17 |     /**
 18 |      * Returns the thread ID of the current thread. Useful for newly created threads.
 19 |      *
 20 |      * @return string Thread ID.
 21 |      */
 22 |     public function getThreadId(): string
 23 |     {
 24 |         return $this->thread_id;
 25 |     }
 26 | 
 27 |     /**
 28 |      * Accepts a pending invitation to contribute to the live thread.
 29 |      *
 30 |      * @return object Response to API call.
 31 |      */
 32 |     public function acceptContributorInvite()
 33 |     {
 34 |         $params = [
 35 |             'api_type' => 'json',
 36 |         ];
 37 | 
 38 |         return $this->apiCall('/accept_contributor_invite', 'POST', $params);
 39 |     }
 40 | 
 41 |     /**
 42 |      * Permanently closes the live thread.
 43 |      *
 44 |      * @return object Response to API call.
 45 |      */
 46 |     public function close()
 47 |     {
 48 |         $params = [
 49 |             'api_type' => 'json',
 50 |         ];
 51 | 
 52 |         return $this->apiCall('/close_thread', 'POST', $params);
 53 |     }
 54 | 
 55 |     /**
 56 |      * Deletes the specified update.
 57 |      *
 58 |      * @param string $update_id ID (rather, name attribute) of update to delete.
 59 |      *
 60 |      * @return object Response to API call.
 61 |      */
 62 |     public function deleteUpdate($update_id)
 63 |     {
 64 |         $params = [
 65 |             'api_type' => 'json',
 66 |             'id'       => $update_id,
 67 |         ];
 68 | 
 69 |         return $this->apiCall('/delete_update', 'POST', $params);
 70 |     }
 71 | 
 72 |     /**
 73 |      * Edit the settings for the live thread.
 74 |      *
 75 |      * @param string|null $title       The thread's title.
 76 |      * @param string|null $description The thread's description.
 77 |      * @param string|null $resources   The thread's resources section in the sidebar.
 78 |      * @param bool|null   $nsfw        Whether or not the thread is NSFW. Prompts guests to continue when visiting.
 79 |      *
 80 |      * @return mixed|null Response to API call OR null if not all settings defined and getting current settings failed.
 81 |      */
 82 |     public function editSettings($title = null, $description = null, $resources = null, $nsfw = null)
 83 |     {
 84 |         $current_settings = null;
 85 |         if ($title === null || $description === null || $resources === null || $nsfw === null) {
 86 |             $current_settings = $this->about();
 87 |             if (!isset($current_settings->data)) {
 88 |                 return null;
 89 |             }
 90 |         }
 91 |         $params = [
 92 |             'api_type'    => 'json',
 93 |             'description' => ($description === null) ? $current_settings->data->description : $description,
 94 |             'nsfw'        => ($nsfw === null) ? $current_settings->data->nsfw : (($nsfw) ? 'true' : 'false'),
 95 |             'resources'   => ($resources === null) ? $current_settings->data->resources : $resources,
 96 |             'title'       => ($title === null) ? $current_settings->data->title : $title,
 97 |         ];
 98 | 
 99 |         return $this->apiCall('/edit', 'POST', $params);
100 |     }
101 | 
102 |     /**
103 |      * Invite a user as a contributor to the live thread.
104 |      *
105 |      * @param string $user          Username of user to invite.
106 |      * @param bool   $perm_all      If the user should have full permissions.
107 |      * @param bool   $perm_close    If the user should have the 'close live thread' permission. User must have 'settings' too to close via the web UI.
108 |      * @param bool   $perm_edit     If the user should have the 'edit' permission.
109 |      * @param bool   $perm_manage   If the user should have the 'manage contributors' permission.
110 |      * @param bool   $perm_settings If the user should have the 'settings' permission.
111 |      * @param bool   $perm_update   If the user should have the 'update' permission.
112 |      *
113 |      * @return object Response to API call.
114 |      */
115 |     public function inviteContributor($user, $perm_all = true, $perm_close = false, $perm_edit = false, $perm_manage = false, $perm_settings = false, $perm_update = false)
116 |     {
117 |         $permissions = [];
118 |         if ($perm_all) {
119 |             $permissions[] = '+all';
120 |         } else {
121 |             if ($perm_close) {
122 |                 $permissions[] = '+close';
123 |             }
124 |             if ($perm_edit) {
125 |                 $permissions[] = '+edit';
126 |             }
127 |             if ($perm_manage) {
128 |                 $permissions[] = '+manage';
129 |             }
130 |             if ($perm_settings) {
131 |                 $permissions[] = '+settings';
132 |             }
133 |             if ($perm_update) {
134 |                 $permissions[] = '+update';
135 |             }
136 |         }
137 |         if (count($permissions) == 0) {
138 |             $permissions = ['-all', '-close', '-edit', '-manage', '-settings', '-update'];
139 |         }
140 |         $params = [
141 |             'api_type'    => 'json',
142 |             'name'        => $user,
143 |             'permissions' => implode(',', $permissions),
144 |             'type'        => 'liveupdate_contributor_invite',
145 |         ];
146 | 
147 |         return $this->apicall('/invite_contributor', 'POST', $params);
148 |     }
149 | 
150 |     /**
151 |      * Abdicate contributorship of the thread.
152 |      *
153 |      * @return object Response to API call.
154 |      */
155 |     public function leaveContributor()
156 |     {
157 |         $params = [
158 |             'api_type' => 'json',
159 |         ];
160 | 
161 |         return $this->apiCall('/leave_contributor', 'POST', $params);
162 |     }
163 | 
164 |     /**
165 |      * Report the thread to the reddit admins for breaking one of the site's rules.
166 |      *
167 |      * @param string $type One of 'spam', 'vote-manipulation', 'personal-information', 'sexualizing-minors', 'site-breaking'.
168 |      *
169 |      * @return object Response to API call.
170 |      */
171 |     public function report($type)
172 |     {
173 |         $params = [
174 |             'api_type' => 'json',
175 |             'type'     => $type,
176 |         ];
177 | 
178 |         return $this->apiCall('/report', 'POST', $params);
179 |     }
180 | 
181 |     /**
182 |      * Remove a user as a contributor from the thread. To revoke a pending invitation, use uninviteContributor().
183 |      *
184 |      * @param string $user Username of user to remove from thread's contributor list.
185 |      *
186 |      * @return object|null Response to API call OR null if the user does not exist.
187 |      */
188 |     public function removeContributor($user)
189 |     {
190 |         $user_object = $this->redditAPI->getUser($user);
191 |         if (!isset($user_object->data)) {
192 |             return null;
193 |         }
194 |         $user_id = $user_object->kind . '_' . $user_object->data->id;
195 |         $params = [
196 |             'api_type' => 'json',
197 |             'id'       => $user_id,
198 |         ];
199 | 
200 |         return $this->apiCall('/rm_contributor', 'POST', $params);
201 |     }
202 | 
203 |     /**
204 |      * Revoke a pending contributor invitation. To remove a current contributor, use removeContributor().
205 |      *
206 |      * @param string $user Username of user to uninvite.
207 |      *
208 |      * @return object|null Response to API call OR null if the user does not exit.
209 |      */
210 |     public function uninviteContributor($user)
211 |     {
212 |         $user_object = $this->redditAPI->getUser($user);
213 |         if (!isset($user_object->data)) {
214 |             return null;
215 |         }
216 |         $user_id = $user_object->kind . '_' . $user_object->data->id;
217 |         $params = [
218 |             'api_type' => 'json',
219 |             'id'       => $user_id,
220 |         ];
221 | 
222 |         return $this->apiCall('/rm_contributor_invite', 'POST', $params);
223 |     }
224 | 
225 |     /**
226 |      * Modify a current contributor's permission set. To modify an invited contributor's permissions, use setInvitationPermissions().
227 |      *
228 |      * @param string $user          Username of user for which to edit permissions.
229 |      * @param bool   $perm_all      If the user should have full permissions.
230 |      * @param bool   $perm_close    If the user should have the 'close live thread' permission. User must have 'settings' too to close via the web UI.
231 |      * @param bool   $perm_edit     If the user should have the 'edit' permission.
232 |      * @param bool   $perm_manage   If the user should have the 'manage contributors' permission.
233 |      * @param bool   $perm_settings If the user should have the 'settings' permission.
234 |      * @param bool   $perm_update   If the user should have the 'update' permission.
235 |      *
236 |      * @return object Response to API call.
237 |      */
238 |     public function setContributorPermissions($user, $perm_all = true, $perm_close = false, $perm_edit = false, $perm_manage = false, $perm_settings = false, $perm_update = false)
239 |     {
240 |         $permissions = [];
241 |         if ($perm_all) {
242 |             $permissions[] = '+all';
243 |         } else {
244 |             if ($perm_close) {
245 |                 $permissions[] = '+close';
246 |             }
247 |             if ($perm_edit) {
248 |                 $permissions[] = '+edit';
249 |             }
250 |             if ($perm_manage) {
251 |                 $permissions[] = '+manage';
252 |             }
253 |             if ($perm_settings) {
254 |                 $permissions[] = '+settings';
255 |             }
256 |             if ($perm_update) {
257 |                 $permissions[] = '+update';
258 |             }
259 |         }
260 |         if (count($permissions) == 0) {
261 |             $permissions = ['-all', '-close', '-edit', '-manage', '-settings', '-update'];
262 |         }
263 |         $params = [
264 |             'api_type'    => 'json',
265 |             'name'        => $user,
266 |             'permissions' => implode(',', $permissions),
267 |             'type'        => 'liveupdate_contributor',
268 |         ];
269 | 
270 |         return $this->apicall('/set_contributor_permissions', 'POST', $params);
271 |     }
272 | 
273 |     /**
274 |      * Modify an invited contributor's permission set. To modify a current contributor's permissions, use setContributorPermissions().
275 |      *
276 |      * @param string $user          Username of user for which to edit permissions.
277 |      * @param bool   $perm_all      If the user should have full permissions.
278 |      * @param bool   $perm_close    If the user should have the 'close live thread' permission. User must have 'settings' too to close via the web UI.
279 |      * @param bool   $perm_edit     If the user should have the 'edit' permission.
280 |      * @param bool   $perm_manage   If the user should have the 'manage contributors' permission.
281 |      * @param bool   $perm_settings If the user should have the 'settings' permission.
282 |      * @param bool   $perm_update   If the user should have the 'update' permission.
283 |      *
284 |      * @return object Response to API call.
285 |      */
286 |     public function setInvitationPermissions($user, $perm_all = true, $perm_close = false, $perm_edit = false, $perm_manage = false, $perm_settings = false, $perm_update = false)
287 |     {
288 |         $permissions = [];
289 |         if ($perm_all) {
290 |             $permissions[] = '+all';
291 |         } else {
292 |             if ($perm_close) {
293 |                 $permissions[] = '+close';
294 |             }
295 |             if ($perm_edit) {
296 |                 $permissions[] = '+edit';
297 |             }
298 |             if ($perm_manage) {
299 |                 $permissions[] = '+manage';
300 |             }
301 |             if ($perm_settings) {
302 |                 $permissions[] = '+settings';
303 |             }
304 |             if ($perm_update) {
305 |                 $permissions[] = '+update';
306 |             }
307 |         }
308 |         if (count($permissions) == 0) {
309 |             $permissions = ['-all', '-close', '-edit', '-manage', '-settings', '-update'];
310 |         }
311 |         $params = [
312 |             'api_type'    => 'json',
313 |             'name'        => $user,
314 |             'permissions' => implode(',', $permissions),
315 |             'type'        => 'liveupdate_contributor_invite',
316 |         ];
317 | 
318 |         return $this->apiCall('/set_contributor_permissions', 'POST', $params);
319 |     }
320 | 
321 |     /**
322 |      * Strikes the specified update, which will show up as crossed out in the live thread.
323 |      *
324 |      * @param string $update_id ID (rather, name attribute) of update to strike.
325 |      *
326 |      * @return object Response to API call.
327 |      */
328 |     public function strikeUpdate($update_id)
329 |     {
330 |         $params = [
331 |             'api_type' => 'json',
332 |             'id'       => $update_id,
333 |         ];
334 | 
335 |         return $this->apiCall('/strike_update', 'POST', $params);
336 |     }
337 | 
338 |     /**
339 |      * Makes an update on the live thread.
340 |      *
341 |      * @param string $body Body of update to post.
342 |      *
343 |      * @return object Response to API call. Unfortunately, no update ID is returned yet. You need to run getUpdates() to find this.
344 |      */
345 |     public function update($body)
346 |     {
347 |         $params = [
348 |             'api_type' => 'json',
349 |             'body'     => $body,
350 |         ];
351 | 
352 |         return $this->apiCall('/update', 'POST', $params);
353 |     }
354 | 
355 |     /**
356 |      * Retrieves updates on a thread.
357 |      *
358 |      * @param int         $limit  Upper limit of the number of links to retrieve. Maximum is 100.
359 |      * @param string|null $after  Get items lower on list than this entry. Does not mean chronologically. Should be the *name* of an update: "LiveUpdate_..."
360 |      * @param string|null $before Get items higher on list than this entry. Does not mean chronologically. Should be the *name* of an update: "LiveUpdate_..."
361 |      *
362 |      * @return object Listing of LiveUpdate objects.
363 |      */
364 |     public function getUpdates($limit = 25, $after = null, $before = null)
365 |     {
366 |         $params = [
367 |             'after'  => $after,
368 |             'before' => $before,
369 |             'limit'  => $limit,
370 |         ];
371 | 
372 |         return $this->liveCall('.json', 'GET', $params);
373 |     }
374 | 
375 |     /**
376 |      * Retrieves information about the live thread.
377 |      *
378 |      * @return object LiveUpdateEvent object.
379 |      */
380 |     public function about()
381 |     {
382 |         return $this->liveCall('/about.json');
383 |     }
384 | 
385 |     /**
386 |      * Retrieves a list of contributors for the thread. To see invitations, the current user must have the 'manage' permission.
387 |      *
388 |      * @return object|array UserList object OR array of two UserList objects if there are visible pending invitations.
389 |      */
390 |     public function getContributors()
391 |     {
392 |         return $this->liveCall('/contributors.json');
393 |     }
394 | 
395 |     /**
396 |      * Retrieves a list of discussions about the current thread.
397 |      *
398 |      * @param int         $limit  Upper limit of the number of links to retrieve. Maximum is 100.
399 |      * @param string|null $after  Get items lower on list than this entry. Does not mean chronologically.
400 |      * @param string|null $before Get items higher on list than this entry. Does not mean chronologically.
401 |      *
402 |      * @return object Listing of posts.
403 |      */
404 |     public function getDiscussions($limit = 25, $after = null, $before = null)
405 |     {
406 |         $params = [
407 |             'after'  => $after,
408 |             'before' => $before,
409 |             'limit'  => $limit,
410 |             'show'   => 'all',
411 |         ];
412 | 
413 |         return $this->liveCall('/discussions', 'GET', $params);
414 |     }
415 | 
416 |     public function apiCall($path, $method = 'GET', $params = null)
417 |     {
418 |         return $this->redditAPI->apiCall("/api/live/{$this->thread_id}$path", $method, $params);
419 |     }
420 | 
421 |     public function liveCall($path, $method = 'GET', $params = null)
422 |     {
423 |         return $this->redditAPI->apiCall("/live/{$this->thread_id}$path", $method, $params);
424 |     }
425 | }
426 | 


--------------------------------------------------------------------------------
/src/RedditOAuth2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace CodeWizz\RedditAPI;
 4 | 
 5 | use CodeWizz\RedditAPI\Exceptions\RedditAuthenticationException;
 6 | 
 7 | class RedditOAuth2
 8 | {
 9 |     private $access_token;
10 |     private $token_type;
11 |     private $expiration;
12 |     private $scope;
13 |     public $username;
14 |     private $password;
15 |     private $app_id;
16 |     private $app_secret;
17 |     private $user_agent;
18 |     private $endpoint;
19 | 
20 |     public function __construct($username, $password, $app_id, $app_secret, $user_agent, $endpoint)
21 |     {
22 |         $this->username = $username;
23 |         $this->password = $password;
24 |         $this->app_id = $app_id;
25 |         $this->app_secret = $app_secret;
26 |         $this->user_agent = $user_agent;
27 |         $this->endpoint = $endpoint;
28 |         $this->requestAccessToken();
29 |     }
30 | 
31 |     public function getAccessToken(): array
32 |     {
33 |         if (!(isset($this->access_token, $this->token_type) && time() < $this->expiration)) {
34 |             $this->requestAccessToken();
35 |         }
36 | 
37 |         return [
38 |             'access_token' => $this->access_token,
39 |             'token_type'   => $this->token_type,
40 |         ];
41 |     }
42 | 
43 |     private function requestAccessToken(): void
44 |     {
45 |         $url = "{$this->endpoint}/api/v1/access_token";
46 |         $params = [
47 |             'grant_type' => 'password',
48 |             'username'   => $this->username,
49 |             'password'   => $this->password,
50 |         ];
51 |         $options[CURLOPT_USERAGENT] = $this->user_agent;
52 |         $options[CURLOPT_USERPWD] = $this->app_id . ':' . $this->app_secret;
53 |         $options[CURLOPT_RETURNTRANSFER] = true;
54 |         $options[CURLOPT_CONNECTTIMEOUT] = 5;
55 |         $options[CURLOPT_TIMEOUT] = 10;
56 |         $options[CURLOPT_CUSTOMREQUEST] = 'POST';
57 |         $options[CURLOPT_POSTFIELDS] = $params;
58 | 
59 |         $response = null;
60 |         $got_token = false;
61 |         while (!$got_token) {
62 |             $ch = curl_init($url);
63 |             curl_setopt_array($ch, $options);
64 |             $response_raw = curl_exec($ch);
65 |             $response = json_decode($response_raw);
66 |             curl_close($ch);
67 |             if (isset($response->access_token)) {
68 |                 $got_token = true;
69 |             } else {
70 |                 if (isset($response->error)) {
71 |                     if ($response->error === 'invalid_grant') {
72 |                         throw new RedditAuthenticationException('Supplied reddit username/password are invalid or the threshold for invalid logins has been exceeded.', 1);
73 |                     }
74 | 
75 |                     if ($response->error === 401) {
76 |                         throw new RedditAuthenticationException('Supplied reddit app ID/secret are invalid.', 2);
77 |                     }
78 |                 } else {
79 |                     fwrite(STDERR, "WARNING: Request for reddit access token has failed. Check your connection.\n");
80 |                     sleep(5);
81 |                 }
82 |             }
83 |         }
84 | 
85 |         $this->access_token = $response->access_token;
86 |         $this->token_type = $response->token_type;
87 |         $this->expiration = time() + $response->expires_in;
88 |         $this->scope = $response->scope;
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/src/RedditRateLimiter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace CodeWizz\RedditAPI;
 4 | 
 5 | class RedditRateLimiter
 6 | {
 7 |     private $enabled;
 8 |     private $interval;
 9 |     private $last_request;
10 | 
11 |     public function __construct($enabled = true, $interval = 2)
12 |     {
13 |         $this->enabled = $enabled;
14 |         $this->interval = $interval;
15 |         $this->last_request = microtime(true) * 10000;
16 |     }
17 | 
18 |     /**
19 |      * Enable the rate limiter, on by default.
20 |      */
21 |     public function enable(): void
22 |     {
23 |         $this->enabled = true;
24 |     }
25 | 
26 |     /**
27 |      * Disable the rate limiter.
28 |      * This is meant to allow you to perform requests in bursts, but me mindful of reddit's rate limits and your program's structure.
29 |      * https://github.com/reddit/reddit/wiki/API.
30 |      */
31 |     public function disable(): void
32 |     {
33 |         $this->enabled = false;
34 |     }
35 | 
36 |     /**
37 |      * Set the rate limiter to wait the specified number of seconds past the previous API call to make the next one.
38 |      * If this time has already elapsed during execution of other parts of the program, no wait is needed.
39 |      *
40 |      * @param int|float $interval Number of seconds that must elapse between each API call.
41 |      */
42 |     public function setInterval($interval): void
43 |     {
44 |         $this->interval = $interval;
45 |     }
46 | 
47 |     /**
48 |      * Used by Phapper object to wait until another API call can be made.
49 |      */
50 |     public function wait(): void
51 |     {
52 |         $now = microtime(true) * 10000;
53 |         $wait_until = $this->last_request + ($this->interval * 10000);
54 |         if ($this->enabled && $now < $wait_until) {
55 |             usleep(($wait_until - $now) * 100);
56 |         }
57 |         $this->last_request = microtime(true) * 10000;
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/src/config/reddit-api.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'endpoint_standard' => 'https://www.reddit.com',
 5 |     'endpoint_oauth'    => 'https://oauth.reddit.com',
 6 | 
 7 |     'username'   => env('REDDIT_USERNAME', ''),
 8 |     'password'   => env('REDDIT_PASSWORD', ''),
 9 |     'app_id'     => env('REDDIT_APP_ID', ''),
10 |     'app_secret' => env('REDDIT_APP_SECRET', ''),
11 | 
12 |     'response_format' => 'STD', // STD | ARRAY
13 | 
14 |     'scopes' => 'save,modposts,identity,edit,flair,history,modconfig,modflair,modlog,modposts,modwiki,mysubreddits,privatemessages,read,report,submit,subscribe,vote,wikiedit,wikiread',
15 | ];
16 | 


--------------------------------------------------------------------------------