PHP Server SDK 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.

use DevCycle\Model\DevCycleUser;

$user_data = new DevCycleUser(array("user_id"=>"my-user"));

Get and use Variable by key

To get values from your Variables, variableValue() is used to fetch variable values using the user data, variable key, coupled with a default value for the variable. The default variable will be used in cases where the user is not segmented into a feature using that variable, or the project configuration is unavailable to be fetched from DevCycle's CDN.

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

The default value can be of type string, boolean, number, or object.

If you would like to get the full Variable object defined by getVariableByKey you can use variable() instead of variableValue(). This contains fields such as: key, value, type, defaultValue, isDefaulted, eval: evaluation object containing reason, details, and targetId for why the Variable was bucketed into its value (see Evaluation Reasons).

Get all Variables

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

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

caution

This method is intended to be used for debugging and analytics purposes, not as a method for retrieving the value of Variables to change code behaviour. For that purpose, we strongly recommend using the individual variable access method described in Get and use Variable by key Using this method instead will result in no evaluation events being tracked for individual variables, and will not allow the use of other DevCycle features such as Code Usage detection

Getting all Features

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

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

Track Event

use DevCycle\Model\DevCycleEvent;

$event_data = new DevCycleEvent(array("type"=>"my-event"));

try {
    $result = $devcycleClient->track($user_data, $event_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevCycleClient->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:

use DevCycle\Api\DevCycleClient;
use DevCycle\Model\DevCycleOptions;
use DevCycle\Model\DevCycleUser;

$options = new DevCycleOptions(true);
$devCycleClient = new DevCycleClient(
    sdkKey: getenv("DEVCYCLE_SERVER_SDK_KEY"),
    dvcOptions: $options);

Async Methods

Each method in this Usage document has a corresponding asynchronous method:

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

Evaluation Hooks

Using evaluation hooks, you can hook into the lifecycle of a variable evaluation to execute code before and after execution of the evaluation.

Note: Each evaluation will wait for all hooks before returning the variable evaluation, which depending on the complexity of the hooks will cause slower function call times. This also may lead to blocking variable evaluations in the future until all hooks return depending on the volume of calls to .variable.

[!WARNING] Do not call any variable evaluation functions (.variable/variableValue) in any of the hooks, as it may cause infinite recursion.

To add a hook:

$hook = new EvalHook(
    before: function (HookContext $context) use (&$beforeCalled) {
        // before hook
    },
    after: function (HookContext $context) use (&$afterCalled) {
        // after hook
    },
    onFinally: function (HookContext $context) use (&$onFinallyCalled) {
        // onFinally hook
    },
    error: function (HookContext $context, \Exception $error) use (&$errorCalled) {
        // error hook
    }
);
$this->client->addHook($hook);

You can also clear the hooks:

$this->client->clearHooks();

Models

User

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