专业网站 / 社交达人
从laravel/socialite中提取的OAuth 2包集合。
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~5.0
- symfony/http-foundation: ~2.8|~2.7|~3.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
README
社交达人是一个OAuth2认证工具。它受到laravel/socialite的启发,您可以在任何PHP项目中轻松使用它。
对于Laravel 5: overtrue/laravel-socialite
要求
PHP >= 5.4
安装
$ composer require "professionalweb/socialite:*"
用法
authorize.php
:
<?php use Overtrue\Socialite\SocialiteManager; $config = [ 'github' => [ 'client_id' => 'your-app-id', 'client_secret' => 'your-app-secret', 'redirect' => 'https:///socialite/callback.php', ], ]; $socialite = new SocialiteManager($config); $response = $socialite->driver('github')->redirect(); echo $response;// or $response->send();
callback.php
:
<?php // ... $user = $socialite->driver('github')->user(); $user->getId(); // 1472352 $user->getNickname(); // "overtrue" $user->getName(); // "安正超" $user->getEmail(); // "anzhengchao@gmail.com" ...
配置
现在我们支持以下网站
vkontakte
、odnoklassniki
、facebook
、twitter
、github
、google
、linkedin
、weibo
、qq
、wechat
和douban
。
每个驱动都使用相同的配置键:client_id
、client_secret
、redirect
。
示例
...
'weibo' => [
'client_id' => 'your-app-id',
'client_secret' => 'your-app-secret',
'redirect' => 'https:///socialite/callback.php',
],
...
作用域
在重定向用户之前,您还可以使用scope方法在请求上设置“作用域”。此方法将覆盖所有现有作用域
$response = $socialite->driver('github') ->scopes(['scope1', 'scope2'])->redirect();
重定向URL
您还可以动态设置redirect
,您可以使用以下方法更改redirect
URL
$socialite->redirect($url); // or $socialite->withRedirectUrl($url)->redirect(); // or $socialite->setRedirectUrl($url)->redirect();
微信作用域
snsapi_base
、snsapi_userinfo
- 用于媒体平台认证。snsapi_login
- 用于网页认证。
附加参数
要包含请求中的任何可选参数,请使用关联数组调用with方法
$response = $socialite->driver('google') ->with(['hd' => 'example.com'])->redirect();
用户界面
标准用户API
$user = $socialite->driver('weibo')->user();
{ "id": 1472352, "nickname": "overtrue", "name": "安正超", "email": "anzhengchao@gmail.com", "avatar": "https://avatars.githubusercontent.com/u/1472352?v=3", "original": { "login": "overtrue", "id": 1472352, "avatar_url": "https://avatars.githubusercontent.com/u/1472352?v=3", "gravatar_id": "", "url": "https://api.github.com/users/overtrue", "html_url": "https://github.com/overtrue", ... }, "token": { "access_token": "5b1dc56d64fffbd052359f032716cc4e0a1cb9a0", "token_type": "bearer", "scope": "user:email" } }
您可以将用户属性作为数组键获取,如下所示
$user['id']; // 1472352 $user['nickname']; // "overtrue" $user['name']; // "安正超" $user['email']; // "anzhengchao@gmail.com" ...
或使用方法
$user->getId(); $user->getNickname(); $user->getName(); $user->getEmail(); $user->getAvatar(); $user->getOriginal(); $user->getToken();// or $user->getAccessToken()
获取OAuth API原始响应
方法$user->getOriginal()
将返回API原始响应的数组。
获取访问令牌对象
您可以通过调用$user->getToken()
、$user->getAccessToken()
或$user['token']
来获取当前会话的访问令牌实例。
使用访问令牌获取用户
$accessToken = new AccessToken(['access_token' => $accessToken]); $user = $socialite->user($accessToken);
自定义会话或请求实例。
您可以设置请求为您的自定义Request
实例,该实例为Symfony\Component\HttpFoundation\Request
的实例。
$request = new Request(); // or use AnotherCustomRequest. $socialite = new SocialiteManager($config, $request);
或将请求设置为SocialiteManager
实例
$socialite->setRequest($request);
您可以通过getRequest()
从SocialiteManager
实例中获取请求
$request = $socialite->getRequest();
设置自定义会话管理器。
默认情况下,SocialiteManager
使用Symfony\Component\HttpFoundation\Session\Session
实例作为会话管理器,您可以根据以下行更改它
$session = new YouCustomSessionManager(); $socialite->getRequest()->setSession($session);
您的自定义会话管理器必须实现
[Symfony\Component\HttpFoundation\Session\SessionInterface](http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/Session/SessionInterface.html)
。
享受它! ❤️
参考
- 谷歌 - OpenID Connect
- Facebook - 图形API
- 领英 - 使用OAuth 2.0进行认证
- 微博 - OAuth 2.0 授权机制说明
- QQ - OAuth 2.0 登录QQ
- 微信公众平台 - OAuth文档
- 微信开放平台 - 网站应用微信登录开发指南
- 豆瓣 - OAuth 2.0 授权机制说明
- Twitter API
- VK API
- Ok API
许可证
MIT