README

这是Soatok对Patreon-PHP库的分支。

通过OAuth与Patreon API（版本2）交互。需要PHP 7。

本库与Patreon库的区别

• 本库需要PHP 7或更高版本，而Patreon库只需要PHP 5.3。
• 本库加载了hidden-string包（防止秘密在堆栈跟踪中泄露）和sodium_compat包（确保即使以奇怪的方式，libsodium也可在标准化的PHP 7.2+ API中访问）。
• 如果可能，本库使用BLAKE2b进行响应缓存，而不是MD5。
• 本库具有新的Patreon\AuthUrl类，可以生成不需要手动URL编码和连接字符串的认证URL。
  • 这应该会使PHP开发者更容易通过OAuth与Patreon集成。

安装

从Packagist获取插件

composer require soatok/patreon

尽管可以不使用Composer加载此库，但强烈建议使用Composer。

Soatok不会支持非Composer安装。

使用

步骤1. 获取您的client_id和client_secret

以Patreon创建者的身份登录，访问Patreon平台文档页面并注册您的客户端。

这将为您提供client_id和client_secret。

步骤2. 在您的代码中使用此插件

假设您想要创建一个“通过Patreon登录”按钮。

您已阅读说明，并尝试使用您的服务器实现“步骤2：处理OAuth重定向”。

用户将在您将他们发送到授权页面进行步骤1后到达您的页面之一，因此在他们查询参数到达此页面时，他们将有一个参数'code'。

（如果您正在进行除“通过Patreon登录”以外的操作，请参阅示例文件夹以获取更多示例。）

（特别是统一流程是用户在您的网站或应用程序中解锁锁定功能或内容的好方法 - 它允许用户在一个流畅统一的流程中注册、登录、承诺并返回您的应用程序。在示例文件夹中查看。）

<?php

// This example shows how to have your users log in via Patreon, and acquire access and refresh tokens after logging in

require_once __DIR__.'/vendor/autoload.php';
use Patreon\{
    API,
    AuthUrl,
    OAuth
};

$client_id = '';      // Replace with your data
$client_secret = '';  // Replace with your data

// Set the redirect url where the user will land after oAuth. 
// That url is where the access code will be sent as a _GET parameter.
// This may be any url in your app that you can accept and process the access code and login
// In this case, say, /patreon_login request uri

$redirect_uri = "http://mydomain.com/patreon_login";

$href = (new AuthUrl($client_id))
    ->withRedirectUri($redirect_uri);

// You can send an array of vars to Patreon and receive them back as they are. Ie, state vars to set the user state, app state or any other info which should be sent back and forth.
 

$state = array();
// For example lets set final page which the user needs to land at - this may be a content the user is unlocking via oauth, or a welcome/thank you page
// Lets make it a thank you page
$state['final_page'] = 'http://mydomain.com/thank_you';

// Add any number of vars you need to this array by $state['YOURKEY'] = VARIABLE

$href = $href->withState($state);
// Scopes! You must request the scopes you need to have the access token.
// In this case, we are requesting the user's identity (basic user info), user's email
// For example, if you do not request email scope while logging the user in, later you wont be able to get user's email via /identity endpoint when fetching the user details
// You can only have access to data identified with the scopes you asked. Read more at https://docs.patreon.com/#scopes

// Lets request identity of the user, and email.
$href = $href
    ->withAddedScope('identity')
    ->withAddedScope('identity[email]');

// Simply echoing it here. You can present the login link/button in any other way.

echo '<a href="'.$href.'">Click here to login via Patreon</a>';

// Up to this part we handled the way to prepare a login link for users to log in via Patreon oAuth using API v2. From this point on starts the processing of a logged in user or user returning from Patreon oAuth.

// The below code snippet needs to be active wherever the the user is landing in $redirect_uri parameter above. It will grab the auth code from Patreon and get the tokens via the oAuth client

if (!empty($_GET['code'])) {
	$oauth_client = new OAuth($client_id, $client_secret);
	$tokens = $oauth_client->get_tokens($_GET['code'], $redirect_uri);
	$access_token = $tokens['access_token'];
	$refresh_token = $tokens['refresh_token'];
	
	// Here, you should save the access and refresh tokens for this user somewhere. Conceptually this is the point either you link an existing user of your app with his/her Patreon account, or, if the user is a new user, create an account for him or her in your app, log him or her in, and then link this new account with the Patreon account. More or less a social login logic applies here.
	// Only use user's email address info coming from Patreon if the email is verified. Check for is_email_verified value in user's API return.
}
if (empty($access_token)) {
    exit;
}

// After linking an existing account or a new account with Patreon by saving and matching the tokens for a given user, you can then read the access token (from the database or whatever resource), and then just check if the user is logged into Patreon by using below code. Code from down below can be placed wherever in your app, it doesnt need to be in the redirect_uri at which the Patreon user ends after oAuth. You just need the $access_token for the current user and thats it.
// Lets say you read $access_token for current user via db resource, or you just acquired it through oAuth earlier like the above - create a new API client

$api_client = new API($access_token);

// Return from the API can be received in either array, object or JSON formats by setting the return format. It defaults to array if not specifically set. Specifically setting return format is not necessary. Below is shown as an example of having the return parsed as an object. Default is array (associated) and there is no need to specifically set it if you are going to use it as an array. If there is anyone using Art4 JSON parser lib or any other parser, they can just set the API return to json and then have the return parsed by that parser

// You dont need the below line if you are going to use the return as array. 
$api_client->api_return_format = 'object';

// Now get the current user:

$patron_response = $api_client->fetch_user();

// At this point you can do anything with the user return. For example, if there is no return for this user, then you can consider the user not logged into Patreon. Or, if there is return, then you can get the user's Patreon id or pledge info. For example if you are able to acquire user's id, then you can consider the user logged into Patreon.