此软件包已被废弃,不再维护。作者建议使用laravel-fans/socialite-providers软件包。

CODING OAuth2 提供程序用于 Laravel Socialite

0.1.0 2020-02-24 13:20 UTC

This package is auto-updated.

Last update: 2020-09-12 04:24:37 UTC


README

标题
CODING

1. 安装

// This assumes that you have composer installed globally
composer require laravel-socialite-providers/coding

2. 服务提供者

  • 如果已经添加,请从config\app.php中的providers[]数组中移除Laravel\Socialite\SocialiteServiceProvider

  • \SocialiteProviders\Manager\ServiceProvider::class添加到config\app.php中的providers[]数组中。

例如

'providers' => [
    // a whole bunch of providers
    // remove 'Laravel\Socialite\SocialiteServiceProvider',
    \SocialiteProviders\Manager\ServiceProvider::class, // add
];
  • 注意:如果您想使用 Socialite Facade,您需要安装它。

3. 事件监听器

  • SocialiteProviders\Manager\SocialiteWasCalled事件添加到app/Providers/EventServiceProvider中的listen[]数组。

  • 将您的监听器(即来自提供者的监听器)添加到您刚刚创建的SocialiteProviders\Manager\SocialiteWasCalled[]

  • 您为此提供者添加的监听器是'LaravelSocialiteProviders\\Coding\\CodingExtendSocialite@handle',

  • 注意:除非您使用自己的提供者覆盖它们,否则您不需要为内置的社交ite提供者添加任何内容。

例如

/**
 * The event handler mappings for the application.
 *
 * @var array
 */
protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // add your listeners (aka providers) here
        'LaravelSocialiteProviders\\Coding\\CodingExtendSocialite@handle',
    ],
];

参考

4. 配置设置

您需要在服务配置文件中添加一个条目,以确保在配置文件被缓存用于生产环境(Laravel 命令artisan config:cache)后,所有配置仍然可用。

添加到config/services.php

'coding' => [
    'client_id' => env('CODING_CLIENT_ID'),
    'client_secret' => env('CODING_CLIENT_SECRET'),
    'redirect' => env('CODING_CALLBACK_URL'),
    'guzzle' => [
        'base_uri' => 'https://' . env('CODING_TEAM') . '.coding.net/',
    ],
    'scopes' => preg_split('/,/', env('CODING_SCOPES'), null, PREG_SPLIT_NO_EMPTY), // optional, can not use explode, see vlucas/phpdotenv#175
],

5. 使用

  • Laravel 配置文档

  • 现在您应该可以像常规使用 Socialite 一样使用它(假设您已安装了 facade)

return Socialite::with('coding')->redirect();

Lumen 支持

您可以使用 Socialite 提供者与 Lumen 一起使用。只需确保您已启用 facade 支持,并且正确遵循设置说明。

注意:如果您使用 Lumen,所有提供者都将自动变为无状态,因为 Lumen 不跟踪状态。

此外,Lumen 中无法从services[]中解析配置。您只能将值设置为.env文件中显示的值。如果需要,您还可以覆盖配置(如下所示)。

无状态

  • 您可以设置是否希望使用无状态提供者。请记住,OAuth 提供者(Twitter、Tumblr 等)必须支持您选择的任何选项。

注意:如果您使用 Lumen,所有提供者都将自动变为无状态,因为 Lumen 不跟踪状态。

// to turn off stateless
return Socialite::with('coding')->stateless(false)->redirect();

// to use stateless
return Socialite::with('coding')->stateless()->redirect();

覆盖配置

如果您需要在应用程序的任何位置动态覆盖提供者的环境或配置变量,您可以使用以下方法

$clientId = "id";
$clientSecret = "secret";
$redirectUrl = "http://example.com/login/coding/callback";
$additionalProviderConfig = [
    // Add additional configuration values here.
    'guzzle' => [
        'base_uri' => 'https://your-team.coding.net/',
    ],
];
$config = new \SocialiteProviders\Manager\Config(
    $clientId,
    $clientSecret,
    $redirectUrl,
    $additionalProviderConfig
);

return Socialite::with('coding')->setConfig($config)->redirect();

获取访问令牌响应体

Laravel Socialite 默认仅允许访问 access_token。可以通过 \Laravel\Socialite\User->token 公共属性访问。有时您需要访问整个响应体,可能包含如 refresh_token 等项。

在 Socialite 中调用 user() 方法后,您可以通过访问属性 $user->accessTokenResponseBody 来获取访问令牌响应体;

$user = Socialite::driver('coding')->user();
$accessTokenResponseBody = $user->accessTokenResponseBody;

参考