Download the PHP package supashiphq/php-sdk without Composer

Supaship PHP SDK

Lightweight, zero-dependency (runtime) client for Supaship feature flags.

Requirements

• PHP 7.4+
• Extensions: json, openssl (for https:// to Edge)

The repo’s composer.json sets config.platform.php to 7.4.33 so composer.lock stays installable on PHP 7.4 (transitive dev tools). That does not affect apps that composer require this library; only this package’s root install uses it.

Install

Quick start

Configuration

networkConfig

Methods

• getFeature(string $name, array $options = []): mixed — single flag; on failure returns the configured fallback (never throws for network errors).
• getFeatures(array $names, array $options = []): array — batch evaluation; on failure returns fallbacks for all requested names. If $names is empty and the request fails, throws.
• updateContext(array $context, bool $mergeWithExisting = true): void
• getContext(): ?array
• getFeatureFallback(string $name): mixed

Optional per-request context:

Framework integrations

SupashipClient has no framework-specific code paths: register it once in the container (or a bootstrap file), inject it where you need flags, and call getFeature / getFeatures. All three examples assume composer require supaship/php-sdk is already done.

The SDK supports PHP 7.4+. Laravel examples below use PHP 8.1+ syntax (e.g. readonly constructor promotion). For Symfony, adjust to your version’s PHP requirement.

Evaluations are synchronous (each call waits for the HTTP response unless you wrap them yourself, e.g. queue or async jobs).

Laravel

1. Environment

In .env:

2. Config file (e.g. config/supaship.php)

3. Register the client in app/Providers/AppServiceProvider.php (method register()):

4. Per-request context (e.g. after auth)

In AppServiceProvider::boot() or a middleware:

5. Use in a controller

Optional middleware that only refreshes context is often cleaner than afterResolving when you need Auth::user() on every request.

Symfony

1. Environment

In .env.local (do not commit secrets):

2. Parameters in config/services.yaml (Symfony 6/7 style):

For larger features maps, you can load a dedicated file with imports: or define the array in PHP via a small config class; the important part is passing the same structure into SupashipClient.

3. Service definition in config/services.yaml:

4. Subscriber to attach the current user to the client (example using Symfony security):

Register the subscriber (Symfony auto-wires if App\ is configured; otherwise add explicit service tags for kernel.event_subscriber).

5. Controller

CodeIgniter 4

1. Environment

In .env:

2. Central feature map

Create app/Config/SupashipFeatures.php (or keep the array inside Services if you prefer):

3. Service registration in app/Config/Services.php:

4. Per-request context — e.g. in a filter app/Filters/SupashipContext.php:

Register the filter in app/Config/Filters.php for the routes or groups that need targeting.

5. Controller

Shared tips (all frameworks)

• Keep features (fallback map) in one file so it stays aligned with names in the Supaship dashboard.
• Use sensitiveContextProperties in the client config when passing emails or IDs you want hashed before they leave your server (same as the JavaScript SDK).
• Prefer getFeatures(['a','b','c']) for a single HTTP round-trip instead of many getFeature calls when loading a page.

Testing

Unit tests should not call Supaship Edge. Pass an httpHandler under networkConfig (same hook as in Advanced: httpHandler) so SupashipClient never opens a socket.

Supaship\Testing\HttpStub

The package includes a tiny helper so you do not hand-build JSON for every test:

Simulate API or transport failures (client falls back to your configured defaults):

Laravel: testing a route that injects SupashipClient

Your app resolves SupashipClient from the container (e.g. AppServiceProvider registers a singleton). In a feature test you swap that binding for a client wired with HttpStub, then call the route. Laravel will inject your test double instead of the real client.

Assume this route (simplified):

Use the same features fallback map shape as in production (at least the keys you request). Register a client whose httpHandler returns the flag value you want for that test:

Why this works:

• $this->app->instance(SupashipClient::class, …) tells Laravel: “when anything needs SupashipClient, use this instance.” It runs before $this->get('/'), so the closure receives your stubbed client.
• HttpStub::success([...]) simulates Edge returning that variation, so getFeature never performs a real HTTP request.
• To test fallback behavior (e.g. Edge down), use HttpStub::failure() and assert welcome if your fallback for cool-new-feature is false.

Asserting what would be sent to Edge

The handler receives the POST URL and the request body string (JSON). Capture it in a closure when you care about environment, features, or context:

json_decode’s third parameter is the maximum nesting depth; 512 is PHP’s default. On PHP 7.4 you cannot use named arguments, so you pass that default explicitly whenever you need the fourth parameter (JSON_THROW_ON_ERROR). e.g. json_decode($jsonBody, true, 512, JSON_THROW_ON_ERROR).

PHPUnit in your app

Add a dev dependency and point to your tests directory (typical phpunit.xml.dist):

Then run:

The SDK’s own test suite is composer test from a clone of this repository (vendor/bin/phpunit after composer install).

Constants

Supaship\Constants::DEFAULT_FEATURES_URL and DEFAULT_EVENTS_URL match the JavaScript SDK defaults.

Advanced: httpHandler

For production custom HTTP (proxy, corporate CA, tracing), or ad-hoc test doubles, inject a handler (same idea as fetchFn in the JavaScript SDK). For most unit tests, prefer HttpStub in the Testing section.

The handler must return ['statusCode' => int, 'body' => string] where body is the raw JSON response.

Developing & tests (this repository)

This runs PHPUnit on tests/, including stub coverage for Supaship\Testing\HttpStub.

Maintainers: To ship a version from GitHub, use Actions → Publish Supaship PHP SDK (publish.yml): it validates, runs tests, and opens a GitHub Release with auto-generated notes from commits since the last release.

License

MIT — see LICENSE.