Skip to content

03-examples.md

Latest commit

 

History

History
95 lines (66 loc) · 2.72 KB

03-examples.md

File metadata and controls

95 lines (66 loc) · 2.72 KB
  1. Getting Started
  2. Obtaining OAuth Tokens For Patrons
  3. Patreon Integration Examples
  4. Method Documentation
  5. Library Architecture

Examples

A number of example integrations are available which you can find below.

Additionally, there is a full project example available at 1f991/patreon-php-example which you may download and use.

Display Patrons

Scenario: You're a Campaign Creator with a website on which you'd like to display profile photos of your Patrons.

require_once 'vendor/autoload.php';

use Squid\Patreon\Patreon;

$patreon = new Patreon('access_token');

$campaign = $patreon->campaigns()->getMyCampaignWithPledges();

$campaign->pledges->each(function ($pledge) {
    echo '<div style="display: inline-block; padding: 10px;">
            <img src="' . $pledge->patron->thumb_url . '">
          </div>';
});

Most Valuable Patrons

Scenario: You're a Campaign Creator and you'd like to generate a comma separated list of Email Addresses for each active Patron who has contributed over $20 during the lifetime of their Pledge to the Campaign.

require_once 'vendor/autoload.php';

use Squid\Patreon\Patreon;

$patreon = new Patreon('access_token');

$campaign = $patreon->campaigns()->getMyCampaignWithPledges();

echo $campaign->pledges->filter(function ($pledge) {
    return $pledge->total_historical_amount_cents >= 2000;
})->map(function ($pledge) {
    return $pledge->patron->email;
})->implode(', ');

The variable $mvps is equal to a string containing the email address of each Patron with a lifetime value of more than $20, e.g:

jane@example.com, jack@example.com, john@example.com, joe@example.com

Delete Users When Pledge Is Cancelled

Scenario: You have a website which allows people to create an account when they are a patron of your Patreon Campaign, and you need to delete the account if their Pledge is cancelled.

require_once 'vendor/autoload.php';

use Squid\Patreon\Patreon;

$patreon = new Patreon('access_token');

$pledges = $patreon->webhook()->accept(
    file_get_contents('php://input'),
    'my-secret',
    $_SERVER['HTTP_X_PATREON_SIGNATURE']
);

if ($_SERVER['HTTP_X_PATREON_EVENT'] === 'pledges:delete') {
    $pledges->each(function ($pledge) {
        User::where('email', $pledge->patron->email)->delete();
    });
}

Next Steps