Installation

Install via Composer with PSR dependencies

Source Repository: convertcom/php-sdk | Wiki | Packagist

Requirements

  • PHP ^8.2 — tested in CI against 8.2, 8.3, and 8.4, on both --prefer-lowest and --prefer-stable dependency resolutions
  • The curl, json, and mbstring extensions
  • A Convert Experiences account with an SDK key

The SDK ships with Guzzle (guzzlehttp/guzzle ^7) as its default PSR-18 HTTP client, auto-discovered at runtime via php-http/discovery. No adapter code is required. To use a different PSR-18 client, see Swapping the PSR-18 Client below.

Install via Composer

composer require convertcom/php-sdk

convertcom/php-sdk is a single package. The repository is a monorepo internally, but everything the SDK needs — every ConvertSdk\* namespace and the generated OpenAPI\Client types — ships inside this one Composer package. There are no convertcom/php-sdk-* sub-packages to install.

Swapping the PSR-18 Client

Guzzle is bundled automatically — most users don't need to change anything. To use a different PSR-18 client (e.g., symfony/http-client, php-http/curl-client), remove Guzzle and install the replacement:

composer remove guzzlehttp/guzzle
composer require symfony/http-client

php-http/discovery will then pick up the new client automatically. Any PSR-18 compliant client works.

PSR Standards

StandardInterface packagePurposeImplementation
PSR-3psr/log ^3.0Logging interfaceYours — pass PSR-3 loggers via logger.customLoggers
PSR-16psr/simple-cache ^3.0Simple cache (config + visitor data)Defaults to the in-memory ArrayCache; pass your own for persistence
PSR-17psr/http-factory ^1.0HTTP message factoriesAuto-discovered (Guzzle by default)
PSR-18psr/http-client ^1.0HTTP clientAuto-discovered (Guzzle by default; swappable)

Dependencies

The following packages are pulled in automatically via Composer:

PackageVersionPurpose
psr/log^3.0PSR-3 logging interface
psr/simple-cache^3.0PSR-16 simple cache interface
psr/http-client^1.0PSR-18 HTTP client interface
psr/http-factory^1.0PSR-17 message factory interfaces
psr/http-message^1.1 || ^2.0PSR-7 HTTP message interfaces
php-http/discovery^1.19Auto-discovers the PSR-18 HTTP client and PSR-17 factories
lastguest/murmurhash^2.1MurmurHash3 — the bucketing hash shared with every other Convert SDK
guzzlehttp/guzzle^7.3Default PSR-18 HTTP client (see Swapping the PSR-18 Client above)
guzzlehttp/psr7^1.7 || ^2.0PSR-7 message implementation used by Guzzle

Plus the ext-curl, ext-json, and ext-mbstring PHP extensions.

Fullstack Project Constraints

This SDK is designed for Fullstack projects (server-side A/B testing, feature flags, and feature rollouts). It supports a/b_fullstack and feature_rollout experience types with fullStackFeature variation changes only.

All entities must have a unique identifier key (a string) when defined in the Convert web interface.

Supported Experience Types

TypeDescription
a/b_fullstackA standard A/B experience
feature_rolloutAn experience with only one non-original variation

Supported Feature Variable Types

TypeDescription
booleanTrue/false
integerWhole number
stringText
jsonJSON object or array

Next Steps


Did this page help you?