omnifund/github-sponsors API reference

Omnifund\GitHubSponsors

GitHubSponsorsFactory class

final class GitHubSponsorsFactory extends ProviderFactory GitHubSponsorsFactory.php:19

GitHub Sponsors, from its options:

account the user or organization whose listing is read: "glitchr-studio" (required) token a GitHub token (required: GitHub's GraphQL API answers no anonymous call). Any token reads a public listing and its public sponsors; a fine-grained token with no permission is enough endpoint https://api.github.com/graphql (GitHub Enterprise: https://HOST/api/graphql) user_agent sent with every call (GitHub refuses a request without one)

Options

GitHubSponsorsFactory::__construct()

public function __construct(readonly HttpClientInterface $http)

GitHubSponsorsProvider class

final class GitHubSponsorsProvider implements ProfileInterface, SponsorsInterface, TiersInterface GitHubSponsorsProvider.php:25

A GitHub Sponsors listing through GitHub's GraphQL API: the listing (its name, page, goal and tiers), the number of sponsors and the public ones - a private sponsor is counted by GitHub and never listed. GitHub gives no public income: Profile::$income stays null.

const ENDPOINT = 'https://api.github.com/graphql'

GitHubSponsorsProvider::__construct()

public function __construct(readonly HttpClientInterface $http, readonly string $account, readonly string $token, readonly string $endpoint = self::ENDPOINT, readonly string $userAgent = 'omnifund (+https://github.com/glitchr-omnisense/omnifund)')

GitHubSponsorsProvider::getName()

public function getName(): string

GitHubSponsorsProvider::getTitle()

public function getTitle(): string

GitHubSponsorsProvider::capabilities()

public function capabilities(): Capabilities

GitHubSponsorsProvider::profile()

public function profile(?string $account = null): Profile

GitHubSponsorsProvider::sponsors()

public function sponsors(?string $account = null, ?int $limit = null): array

GitHubSponsorsProvider::tiers()

public function tiers(?string $account = null): array