lichv / socialite
从 lichv/socialite 提取的 OAuth 2 包集合。
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~5.0|~6.0
- symfony/http-foundation: ~2.6|~2.7|~2.8|~3.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-09-29 02:18:37 UTC
README
参考 overtrue/socialite 添加 QQ 公众号登录,后续添加支付宝登录
需求
PHP >= 5.4
安装
$ composer require "lichv/socialite:~0.1"
用法
authorize.php
:
<?php use Lichv\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(); // "lichv" $user->getName(); // "安正超" $user->getEmail(); // "anzhengchao@gmail.com" ...
配置
现在我们支持以下网站
facebook
, 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',
],
...
作用域
在重定向用户之前,您还可以使用范围方法在请求上设置 "scopes"。此方法将覆盖所有现有的作用域
$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": "lichv", "name": "安正超", "email": "anzhengchao@gmail.com", "avatar": "https://avatars.githubusercontent.com/u/1472352?v=3", "original": { "login": "lichv", "id": 1472352, "avatar_url": "https://avatars.githubusercontent.com/u/1472352?v=3", "gravatar_id": "", "url": "https://api.github.com/users/lichv", "html_url": "https://github.com/lichv", ... }, "token": { "access_token": "5b1dc56d64fffbd052359f032716cc4e0a1cb9a0", "token_type": "bearer", "scope": "user:email" } }
您可以根据如下方式获取用户属性作为数组键
$user['id']; // 1472352 $user['nickname']; // "lichv" $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
实例(其中 instanceof 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 YourCustomSessionManager(); $socialite->getRequest()->setSession($session);
您的自定义会话管理器必须实现
Symfony\Component\HttpFoundation\Session\SessionInterface
。
享受它!❤️
参考
- Google - OpenID Connect
- Facebook - Graph API
- Linkedin - 使用 OAuth 2.0 认证
- 微博 - OAuth 2.0 授权机制说明
- QQ - 使用 OAuth 2.0 登录 QQ
- 微信公众平台 - OAuth 文档
- 微信开放平台 - 网站应用微信登录开发指南
- 豆瓣 - OAuth 2.0 授权机制说明
许可证
MIT