DevCycle PHP Server SDK

Welcome to the the DevCycle PHP SDK, initially generated via the DevCycle Bucketing API.

The SDK is available as a package on Packagist. It is also open source and can be viewed on Github.

Requirements

PHP 7.3 and later.

Installation

Composer Installation

To install the bindings via Composer, add the following to composer.json:

{
  "require": {
    "devcycle/php-server-sdk": "*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/DevCycle/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = DevCycle\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');

$apiInstance = new DevCycle\Api\DVCClient(
    $config,
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
);
$user_data = new \DevCycle\Model\UserData(array(
  "user_id"=>"my-user"
)); // \DevCycle\Model\UserData

try {
    $result = $apiInstance->allFeatures($user_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DVCClient->allFeatures: ', $e->getMessage(), PHP_EOL;
}

Usage

User Object

The full user data must be passed into every method. The only required field is user_id. The rest are optional and are used by the system for user segmentation into variables and features.

See the User model in the PHP user model doc for all accepted fields including custom fields.

    $user_data = new \DevCycle\Model\UserData(array(
    "user_id"=>"my-user"
    )); // \DevCycle\Model\UserData

Get and use Variable by key

try {
    $result = $apiInstance->variable($user_data, "my-key", "default");
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DVCClient->variable: ', $e->getMessage(), PHP_EOL;
}

See getVariableByKey on the Bucketing API for the variable response format.

Get all Variables

try {
    $result = $apiInstance->allVariables($user_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DVCClient->allVariables: ', $e->getMessage(), PHP_EOL;
}

See getVariables on the Bucketing API for the variable response format.

Getting all Features

try {
    $result = $apiInstance->allFeatures($user_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DVCClient->allFeatures: ', $e->getMessage(), PHP_EOL;
}

See getFeatures on the Bucketing API for the feature response format.

Track Event

$event_data = new \DevCycle\Model\Event(array(
  "type"=>"my-event"
));

try {
    $result = $apiInstance->track($user_data, $event_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DVCClient->track: ', $e->getMessage(), PHP_EOL;
}

EdgeDB

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about EdgeDB.

To get started, contact us at [email protected] to enable EdgeDB for your project.

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

$config = DevCycle\Configuration::getDefaultConfiguration()->setApiKey('Authorization', '<INSERT SDK KEY>');
$options = new DevCycle\DVCOptions(true);
$apiInstance = new DevCycle\Api\DVCClient(
    $config,
    dvcOptions:$options
);

Async Methods

Each method in the Usage section has a corresponding asynchronous method:

    $result = $apiInstance->allVariables($user_data);
    $apiInstance->allVariablesAsync($user_data)->then(function($result) {
      print_r($result);
    });

Models

UserData

User data is provided to most SDK requests to identify the user / context of the feature evaluation

Name	Type	Description	Notes
user_id	String	Unique id to identify the user
email	String	User's email used to identify the user on the dashboard / target audiences	[optional]
name	String	User's name used to identify the user on the dashboard / target audiences	[optional]
language	String	User's language in ISO 639-1 format	[optional]
country	String	User's country in ISO 3166 alpha-2 format	[optional]
app_version	String	App Version of the running application	[optional]
app_build	String	App Build number of the running application	[optional]
custom_data	Object	User's custom data to target the user with, data will be logged to DevCycle for use in dashboard.	[optional]
private_custom_data	Object	User's custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing.	[optional]
created_date	Float	Date the user was created, Unix epoch timestamp format	[optional]
last_seen_date	Float	Date the user was created, Unix epoch timestamp format	[optional]
platform	String	Platform the Client SDK is running on	[optional]
platform_version	String	Version of the platform the Client SDK is running on	[optional]
device_model	String	User's device model	[optional]
sdk_type	String	DevCycle SDK type	[optional]
sdk_version	String	DevCycle SDK Version	[optional]

Event

Event data is provided to track calls to log events to DevCycle

Name	Type	Description	Notes
type	String	Custom event type
target	String	Custom event target / subject of event. Contextual to event type	[optional]
date	Float	Unix epoch time the event occurred according to client	[optional]
value	Float	Value for numerical events. Contextual to event type	[optional]
meta_data	Object	Extra JSON metadata for event. Contextual to event type	[optional]

Variable

Variable objects are returned by the SDK when calling variable or allVariables.

Name	Type	Description	Notes
_id	String	unique database id
key	String	Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id.
type	String	Variable type
value	Object	Variable value can be a string, number, boolean, or JSON

Feature

Feature objects are returned by the SDK when calling allFeatures

Name	Type	Description	Notes
_id	String	unique database id
key	String	Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id.
type	String	Feature type
_variation	String	Bucketed feature variation
eval_reason	String	Evaluation reasoning	[optional]

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.3
• Build package: org.openapitools.codegen.languages.PhpClientCodegen