Download the PHP package the-real-start/yii2-oauth2-server-tools without Composer
On this page you can find all versions of the php package the-real-start/yii2-oauth2-server-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download the-real-start/yii2-oauth2-server-tools
More information about the-real-start/yii2-oauth2-server-tools
Files in the-real-start/yii2-oauth2-server-tools
Package yii2-oauth2-server-tools
Short Description Set of simple tools for
License MIT
Homepage https://github.com/TheRealStart/yii2-oauth2-server-tools
Informations about the package yii2-oauth2-server-tools
yii2-oauth2-server-tools
Set of simple tools that helps to build API based on
alegz/yii2-oauth2-server
package.
Installation
Via command line:
composer require the-real-start/yii2-oauth2-server-tools
Or add lime to composer.json requirement section:
Usage
Package namepsace: TRS\yii2\oauth2server\tools
Package provides 5 classes for setting up oauth2-server:
- Abstract class AppIdentity
- Abstract class User
- Class ErrorHandler
- Class AccessRules
- Class JsonHttpException
AppIdentity
Abstract class for client credentials
grant_type
(see https://tools.ietf.org/html/rfc6749 for details).
You should declare getIsPublic method for you version of AppIdentity
class. See example below:
Example with setting up module of yii2-oauth2-server
:
User
This abstract class extends yii\web\User
adds getIsPublic
method and
changes logic around logging user out.
This class requires to declare method getIsPublic
for User
Example of class:
Setting up example:
ErrorHandler
Simple error handler that were designed to be used with API.
Setup example in yii2 main.php
config file in components
section:
AccessRules
Extended version of yii2 AccessRule
. Adds support of user scope
filtering.
Example of rule
Setup example:
In this and previous examples accessRules were declared as abstract method in base controller.
JsonHttpException
It's simple wrapper over HTTPException that can accept array as message.
Array is converted to json.
Designed to use with ErrorHandler but you are free to adopt it to your tools.
Small example
Participation and development
Hope you will find this set of tools helpful.
If you have suggestions welcome to issues on github.
If you wish to improve thia package feel free to submit pull requests.
All versions of yii2-oauth2-server-tools with dependencies
alegz/yii2-oauth2-server Version ~2.2
the-real-start/yii2-jsend-response Version ^0.1.4