Download the PHP package alrayyes/forge-dashboard-sdk-php without Composer

On this page you can find all versions of the php package alrayyes/forge-dashboard-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of alrayyes/forge-dashboard-sdk-php

Informations about the package forge-dashboard-sdk-php

forge-dashboard-sdk-php

CI Codecov docs

A PHP client for forge-dashboard's REST API, generated from its OpenAPI spec with openapi-generator's php target and a Guzzle HTTP transport. It saves you from hand-rolling HTTP requests, auth and retries against the API yourself.

Requirements

Installation

This package isn't on Packagist yet — see "Publishing" below. Until it is, require it as a VCS repository pointed at this Git URL, or composer require a specific commit.

Authentication

forge-dashboard accepts either a browser's passkey session cookie or a personal API token — Authorization: Bearer <token> — as an alternative that needs no WebAuthn ceremony. This SDK only speaks the token half, the one a script can actually use. Mint one by signing into the dashboard once and calling POST /api/tokens, then pass it to the constructor or set FORGE_DASHBOARD_API_TOKEN in the environment:

Usage

health and getVersion need no token and are good first calls to prove the client reaches the server at all:

The aggregated dashboard needs a token, and demonstrates error handling:

Every other operation is a direct call on the matching generated Api class — $client->settings, $client->tokens, $client->pullRequests, $client->admin, $client->sharing, $client->auth, $client->webhooks — each named after the spec's own tags. These throw the generated ForgeDashboard\Generated\ApiException on any non-2xx response; convert it to a typed error uniformly with ApiError::fromGeneratedException(), as above.

ApiError carries the HTTP status (statusCode) and the API's own error message (getMessage()).

The client retries a 429 or 5xx response with exponential backoff and jitter (honoring a server-sent Retry-After), and never retries any other 4xx. Tune it via the constructor's $maxRetries/$retryBaseDelaySeconds, or swap the underlying Guzzle handler stack entirely with $handlerStack.

Regenerating the client

See CONTRIBUTING.md — the generated code is pinned to a specific forge-dashboard commit and shouldn't drift from it silently.

Publishing

This package isn't claimed on Packagist yet — that's a manual step (linking a GitHub webhook to a Packagist account) left for a maintainer to do once the SDK is ready for general use, not something done as part of this bootstrap.

Contributing

See CONTRIBUTING.md for building, testing and the release process.

License

MIT — a permissive license for the client, independent of forge-dashboard's own AGPL-3.0.

All versions of forge-dashboard-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-json Version *
guzzlehttp/guzzle Version 8.2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package alrayyes/forge-dashboard-sdk-php contains the following files

Loading the files please wait ...