php-github-api

The php-github-api library provides a comprehensive PHP interface for interacting with both GitHub REST API v3 and GraphQL API v4. It supports a wide range of GitHub features including:

• Core GitHub Data: Repositories, Issues, Pull Requests, Commits, Gists, and Users.
• Git Data: Low-level Git objects like Blobs, Trees, Commits, References, and Tags.
• Organization & Enterprise Management: Managing members, teams, organization roles, and enterprise-level secret scanning alerts.
• GitHub Actions & Workflows: Interacting with workflows, workflow runs, jobs, artifacts, secrets, and variables.
• CI/CD & Deployment: Managing deployments, environments, and check runs/suites.
• Search & Discovery: Searching across GitHub resources.
• Advanced Features: Pagination support, response caching, and the ability to request any arbitrary route.

The 3.x major version introduced several significant architectural changes:

• Minimum PHP Version: Requires PHP 7.2.5 or higher (supports PHP 8).
• HTTP Client Standard: Uses PSR-18 client implementation and PSR-17 for request/response factories.
• HTTP Plug: Requires httplug/httplug version ^2.0.
• Pagination: The pagination logic was re-worked to ensure that API classes are no longer mutated during the pagination process.

The Cards API is currently in Early Access. To use it, you must provide a custom media type in the Accept header of your requests.

This API is available for both repositories and organizations. For repositories, use the repo API identifier. For organizations, use the org_projects API identifier. The syntax for accessing columns and cards is identical for both: $client->api('repo')->projects()->columns()->cards() or $client->api('org_projects')->columns()->cards().

$client->api('repo')->projects()->columns()->cards()->configure();

The organizations API wraps the GitHub Organization API and provides access to organization-specific resources. In addition to standard organization endpoints, it provides access to:

• Members API: For managing and viewing organization members.
• Teams API: For managing and viewing organization teams.

Review Comments are specific to a portion of the unified diff within a Pull Request. They are distinct from:

• Commit Comments: Applied directly to a commit, outside of the Pull Request view.
• Issue Comments: General comments that do not reference a specific portion of the unified diff.

This API wraps the GitHub PR Review Comments API. Note that new comments are automatically assigned to the authenticated user.

The Protection API is currently in preview. To use it, you must configure the client to provide a custom media type in the Accept header by calling configure() on the protection resource.

$client->api('repo')->protection()->configure();

The library is decoupled from specific HTTP clients using HTTPlug. If you want to use a different client, such as symfony/http-client with nyholm/psr7, install them via Composer and then initialize the client using Client::createWithHttpClient().

use Github\Client;
use Symfony\Component\HttpClient\HttplugClient;

$client = Client::createWithHttpClient(new HttplugClient());