Download the PHP package usman/reddit-php-api without Composer
On this page you can find all versions of the php package usman/reddit-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package reddit-php-api
Reddit API client in PHP
A PHP library to handle authentication and communication with Reddit API. The library/SDK helps you to get an access token and when authenticated it helps you to send API requests. You will not get everything for free though... You have to read the Reddit documentation to understand how you should query the API.
To get an overview what this library actually is doing for you. Take a look at the authentication page from the API docs.
Features
Here is a list of features that might convince you to choose this Reddit client over some of our competitors'.
- Flexible and easy to extend
- Developed with modern PHP standards
- Not developed for a specific framework.
- Handles the authentication process
- Respects the CSRF protection
Installation
TL;DR
This library does not have a dependency on Guzzle or any other library that sends HTTP requests. We use the awesome HTTPlug to achieve the decoupling. We want you to choose what library to use for sending HTTP requests. Consult this list of packages that support php-http/client-implementation find clients to use. For more information about virtual packages please refer to HTTPlug. Example:
You do also need to install a PSR-7 implementation and a factory to create PSR-7 messages (PSR-17 whenever that is released). You could use Guzzles PSR-7 implementation and factories from php-http:
Now you may install the library by running the following:
Usage
In order to use this API client (or any other Reddit clients) you have to register your application with Reddit to receive an API key. Once you've registered your Reddit app, you will be provided with an API Key and Secret Key.
Reddit login
This example below is showing how to login with Reddit.
How to post on Reddit wall
The example below shows how you can post on a users wall. The access token is fetched from the database.
You may of course do the same in xml. Use the following options array.
Configuration
The api options
The third parameter of Reddit::api is an array with options. Below is a table of array keys that you may use.
| Option name | Description |
|---|---|
| body | The body of a HTTP request. Put your xml string here. |
| format | Set this to 'json', 'xml' or 'simple_xml' to override the default value. |
| headers | This is HTTP headers to the request |
| json | This is an array with json data that will be encoded to a json string. Using this option you do need to specify a format. |
| response_data_type | To override the response format for one request |
| query | This is an array with query parameters |
Changing request format
The default format when communicating with Reddit API is json. You can let the API do json_encode for you.
The following code shows you how.
When using array('json'=>$body) as option the format will always be json. You can change the request format in three ways.
Understanding response data type
The data type returned from Reddit::api can be configured. You may use the forth construtor argument, the
Reddit::setResponseDataType or as an option for Reddit::api
Below is a table that specifies what the possible return data types are when you call Reddit::api.
| Type | Description |
|---|---|
| array | An assosiative array. This can only be used with the json format. |
| simple_xml | A SimpleXMLElement. See PHP manual. This can only be used with the xml format. |
| psr7 | A PSR7 response. |
| stream | A file stream. |
| string | A plain old string. |
Use different Session classes
You might want to use an other storage than the default SessionStorage. If you are using Laravel
you are more likely to inject the IlluminateSessionStorage.
You can inject any class implementing DataStorageInterface. You can also inject different UrlGenerator classes.
Using different scopes
If you want to define special scopes when you authenticate the user you should specify them when you are generating the login url. If you don't specify scopes Reddit will use the default scopes that you have configured for the app.
All versions of reddit-php-api with dependencies
php-http/client-implementation Version ^2.0
php-http/httplug Version ^2.0
php-http/message-factory Version ^1.0
php-http/discovery Version ^1.0