PHP SDK

Introduction

Welcome to the developer documentation for the Kameleoon PHP SDK! Our SDK gives you the possibility of running experiments and activating feature flags on your back-end PHP server. Integrating our SDK into your web-application is easy, and its footprint (in terms of memory and network usage) is low.

You can refer to the SDK reference to check out all possible features of the SDK. Also make sure you check out our Getting started tutorial which we have prepared to walk you through the installation and implementation.

Latest version of the PHP SDK: 3.1.0 (changelog).

Getting started

This guide is designed to help you integrate our SDK in a few minutes and start running experiments in your PHP applications. This tutorial will explain the setup of a simple A/B test to change the number of recommended products based on different variations.

Creating an experiment

First, you must create an experiment in the Kameleoon back-office so that our platform is aware of the new A/B test you're planning to implement on your side. Make sure that server-side type is chosen as shown below:

Upon successful creation of the experiment, you will need to get its ID to use in the SDK as an argument to the triggerExperiment() method.

Installing the SDK

You should first install our SDK. Once uncompressed, you will see two directories: kameleoon/ and job/.

Installing the PHP client (Composer package)

The kameleoon/ directory corresponds to the PHP package itself, which should be used with the Composer dependency manager. Install this directory in your composer hierarchy (so you should have vendor/kameleoon/client/src). Then edit composer.json and add a Kameleoon entry:

"autoload": {
  "psr-4": {
    "Kameleoon\\": "vendor/kameleoon/client/src"
  }
}

Finally, execute the following command to regenerate the autoloader:

composer dump-autoload -o

Installing the cron job

The job/ directory corresponds to a job that must be executed via a standard job scheduler (like cron). We suggest to install the script itself to /usr/local/opt/kameleoon/kameleoon-client-php-process-queries.sh and to use our default supplied crontab entry. But you can install it in another location and modify the crontab entry accordingly.

Additional configuration

You can customize the behavior of the PHP SDK via a configuration file. We provide a sample configuration file named client-php.json.sample in the SDK archive. We suggest to install this file to the default path of /etc/kameleoon/client-php.json. With the current version of the PHP SDK, 6 keys are available:

• client_id: a client_id is required for authentication to the Kameleoon service.
• client_secret: a client_secret is required for authentication to the Kameleoon service.
• kameleoon_work_dir: this specifies a working directory for the PHP client (who will create files on this directory). It needs to be writable by the PHP user. If not specified, by default the directory will be /tmp/kameleoon/client-php/.
• actions_configuration_refresh_interval: this specifies the refresh interval, in minutes, of the configuration for experiments and personalizations (the active experiments and personalizations are fetched from the Kameleoon servers). It means that once you launch an experiment, pause it, or stop it the changes can take (at most) the duration of this interval to be propagated in production to your servers. If not specified, the default interval is 60 minutes.
• cookie_options: this is a map containing configuration options for the kameleoonVisitorCode cookie set by the getVisitorCode() method. Following keys are available:
  • domain: this controls the domain of the cookie and should be set to your top-level domain (very important). This value can be overriden by an argument of the getVisitorCode() method.
  • secure: this controls the secure cookie attribute. Default value is false.
  • http_only: this controls the httponly cookie attribute. Default value is false.
  • samesite: this controls the samesite cookie attribute. Default value is None.
• debug_mode: this parameter sends additional information to our tracking servers to help analyze difficult issues. It should usually be off (false), but activating it (true) has no impact on the SDK performance.
• environment: an option specifying which feature flag configuration will be used, by default each feature flag is split into production, staging, development. If not specified, will be set to default value of production. More information

note

If you use another path for the configuration file than the default one (/etc/kameleoon/client-php.json), you will need to:

-pass the path of your configuration file as a third argument to the KameleoonClientFactory::create() method;

• modify your crontab entry to add the --conf argument to the job script (so for instance it would be called as bash /usr/local/opt/bin/kameleoon-client-php-process-queries.sh --conf /my/path/kameleoon.json).

note

To learn more about client_id and client_secret, as well as how to obtain them, refer to the API credentials article. Note that the Kameleoon PHP SDK uses the Automation API and follows the OAuth 2.0 client credentials flow.

Initializing the Kameleoon client

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj");

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj", "/etc/kameleoon/client-php.json");

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj");

After installing the SDK into your application, configuring the correct credentials (in /etc/kameleoon/client-php.json) and setting up a server-side experiment on Kameleoon's back-office, the next step is to create the Kameleoon client in your application code.

The code on the right gives a clear example. A KameleoonClient is a singleton object that acts as a bridge between your application and the Kameleoon platform. It includes all the methods and properties you will need to run an experiment. Note that the SDK takes its settings from a configuration file. By default, the path /etc/kameleoon/client-php.json will be used, but you can use a different path for the configuration file by providing an optional third argument to the KameleoonClientFactory::create() method.

note

It's the responsability of the developers to ensure the proper logic of their application code within the context of A/B testing via Kameleoon. A good practice is to always assume that the current visitor can be left out of the experiment because the experiment has not yet been launched. This is actually easy to do, because this corresponds to the implementation of the default / reference variation logic, which should be done in any case. The code samples in the next paragraph show examples of such an approach.

Triggering an experiment

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj", "/etc/kameleoon/client-php.json");

$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$recommendedProductsNumber;

try
{
  $variationId;
  try {
    $variationID = $kameleoonClient->triggerExperiment($visitorCode, 75253);
  }
  catch (Kameleoon\Exception\NotTargeted $e)
  {
    /*
      The user did not trigger the experiment, as the associated targeting segment
      conditions were not fulfilled. He should see the reference variation.
    */
    $variationID = 0;
  }
  catch (Kameleoon\Exception\NotAllocated $e) {
      /*
        The user triggered the experiment, but did not activate it. Usually, this happens
        because the user has been associated with excluded traffic.
      */
      variationID = 0;
  }
  catch (Kameleoon\Exception\ExperimentConfigurationNotFound $e) {
    // The user will not be counted into the experiment, but should see the reference variation
    variationID = 0;
  }

  if ($variationID == 0)
  {
    // We are changing number of recommended products for this variation to 5
    $recommendedProductsNumber = 5;
  }
  else if ($variationID == 148382)
  {
    // We are changing number of recommended products for this variation to 10
    $recommendedProductsNumber = 10;
  }
  else if ($variationID == 187791)
  {
    // We are changing number of recommended products for this variation to 8
    $recommendedProductsNumber = 8;
  }

  /*
    Here you should have code to generate the HTML page back to the client,
    where recommendedProductsNumber will be used.
  */
  echo $recommendedProductsNumber;
}
catch (Exception $e)
{
  echo "Exception: ",  $e->getMessage(), "\n";
}

Running an A/B experiment on your PHP application means bucketing your visitors into several groups (one per variation). The SDK takes care of this bucketing (and the associated reporting) automatically.

Triggering an experiment by calling the triggerExperiment() method will register a random variation for a given visitorCode. If this visitorCode is already associated with a variation (most likely a returning visitor that has already been exposed to the experiment previously), then it will return the previous variation associated with a given experiment.

note

Obtaining a Kameleoon visitorCode for the current HTTP request is an important step of the process. You should use the provided getVisitorCode() helper method for this (details available on the reference documentation).

note

The triggerExperiment() method will quite often throw out exceptions. You should generally treat an exception as if the user was bucketed into the reference. Some possible common exceptions:

• When the experiment has not yet been launched on the Kameleoon platform (but the code implementing the experiment on the PHP application's side is already deployed), this results in a Kameleoon\Exception\ExperimentConfigurationNotFound exception.
• If you used targeting on your experiment, the Kameleoon\Exception\NotTargeted exception will be thrown to indicate that the current visitor is not targeted.

note

The triggerExperiment() method will make an asynchronous call to our servers for tracking purposes, but the association of a variation with the visitorCode for this experiment (this operation is also called the bucketing of the visitors) will be made directly in the SDK code. Thus the method will instantly return the variationID.

note

Every change of the deviation (traffic repartition between variations) for the experiment will trigger a mandatory reallocation.
This will happen even if you did not select the "Reallocation" checkbox in the traffic management interface. A reallocation means that all visitors that had been previously exposed to the experiment will be again bucketed, and thus can be assigned to a new, different variation.

Depending on your particular experiment, this can have some impact on the user experience and on the results of the test. We recommend NOT changing the deviation for server side experiments at all if possible.
Read more about reallocation in this article.

Implementing variation code

$recommendedProductsNumber;
if ($variationID == 0)
{
  // We are changing number of recommended products for this variation to 5
  $recommendedProductsNumber = 5;
}
else if ($variationID == 148382)
{
  // We are changing number of recommended products for this variation to 10
  $recommendedProductsNumber = 10;
}
else if ($variationID == 187791)
{
  // We are changing number of recommended products for this variation to 8
  $recommendedProductsNumber = 8;
}

To execute different code paths depending on the variation assigned to the visitor, you will need the list of all the experiment's variation IDs. You can find these variation IDs (as well as the experiment ID) by opening the experiment in hte back-office interface.

Once you have the IDs of the different variations, you can implement a different action for each variation, and one of the code paths will be executed, based on the associated variationID for the current visitor. Generally, this can be done using a simple if / else or switch mechanism. In our example, we just change the number of recommended products with two different variations.

Tracking conversion

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj", "/etc/kameleoon/client-php.json");
$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$recommendedProductsNumber;

$goalID = 83023;
$kameleoonClient->trackConversion($visitorCode, $goalID);

After you are done with triggering an experiment, the next step is usually to start tracking conversions. This is done to measure performance characteristics according to the goals that make sense for your business.

For this purpose, use the trackConversion() method of the SDK as shown in the example. You need to pass the visitorCode and goalID parameters so we can correctly track conversion for this particular visitor.

Obtaining results

Once your implementation is in place on the server side (experiment triggering, variations handling, and conversion tracking), it is time to launch the experiment on the Kameleoon platform. You do this in the same way as for a front-end test. Basic operations such as starting, pausing and stopping the experiment work exactly the same way.

After the experiment is launched, the first results will be available on our standard results page in the back-office after a duration of 30 minutes. This is because (as is the case with front-end testing) visits are considered over after 30 minutes of inactivity. Inactivity in this context means the absence of calls sent to the Kameleoon back-end servers (such calls are made via triggerExperiment(), trackConversion() or flush() methods).

Reference

This is a full reference documentation of the PHP SDK.

If this is your first time working with the PHP SDK, we strongly recommend you go over our Getting started tutorial to integrate the SDK and start experimenting in a few minutes.

Kameleoon\KameleoonClientFactory

create

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj");

The starting point for using the SDK is the initialization step. All interaction with the SDK is done through an object named KameleoonClient, therefore you need to create this object.

Arguments

Name	Type	Description
siteCode	String	Code of the website you want to run experiments on. This unique code id can be found in our platform's back-office. This field is mandatory.
configurationFilePath	String	Path to the SDK configuration file. This field is optional and set to /etc/kameleoon/client-php.json by default.
clientID	String	This parameter is used for OAUth 2.0 authentication to our service. This field is optional, as it can be provided via the configuration file. However, it must either be supplied by the configuration file or by this method, else a Kameleoon\Exception\CredentialsNotFound exception will be thrown.
clientSecret	String	This parameter is used for OAUth 2.0 authentication to our service. This field is optional, as it can be provided via the configuration file. However, it must either be supplied by the configuration file or by this method, else a Kameleoon\Exception\CredentialsNotFound exception will be thrown.

Return value

Type	Description
Kameleoon\KameleoonClient	An instance of the KameleoonClient class, that will be used to manage your experiments and feature flags.

Exceptions Thrown

Type	Description
Kameleoon\Exception\CredentialsNotFound	Exception indicating that the requested credentials were not provided (either via the configuration file, or via parameters on the method).

Kameleoon\KameleoonClient

getVisitorCode

require "vendor/autoload.php";

$visitorCode = $kameleoonClient->getVisitorCode(); // The cookie's domain must be provided in the configuration file if no argument is given
$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$visitorCode = $kameleoonClient->getVisitorCode("example.co.uk", $userID);

note

Previously named: obtainVisitorCode - deprecated since SDK version 3.0.0 and will be removed in a future releases.

This helper method should be called to obtain the Kameleoon visitorCode for the current visitor. This is especially important when using Kameleoon in a mixed front-end and back-end environment, where user identification consistency must be guaranteed. The implementation logic is described here:

1. First we check if a kameleoonVisitorCode cookie or query parameter associated with the current HTTP request can be found. If so, we will use this as the visitor identifier.

2. If no cookie / parameter is found in the current request, we either randomly generate a new identifier, or use the defaultVisitorCode argument as identifier if it is passed. This allows our customers to use their own identifiers as visitor codes, should they wish to. This can have the added benefit of matching Kameleoon visitors with their own users without any additional look-ups in a matching table.

3. In any case, the server-side (via HTTP header) kameleoonVisitorCode cookie is set with the value. Then this identifier value is finally returned by the method.

For more information, refer to this article.

note

If you provide your own visitorCode, its uniqueness must be guaranteed on your end - the SDK cannot check it. Also note that the length of visitorCode is limited to 255 characters. Any excess characters will throw an exception.

Arguments

Name	Type	Description
topLevelDomain	String	Your current top level domain for the concerned site (this information is needed to set the corresponding cookie accordingly, on the top level domain). This field is optional, as it can be provided via the configuration file. However, it must either be supplied by the configuration file or by this method, else a InvalidArgument exception will be thrown.
defaultVisitorCode	String	This parameter will be used as the visitorCode if no existing kameleoonVisitorCode cookie is found on the request. This field is optional, and by default a random visitorCode will be generated.

Return value

Type	Description
String	A visitorCode that will be associated with this particular user and should be used with most of the methods of the SDK.

Exceptions Thrown

Type	Description
InvalidArgumentException	Exception indicating that the cookie's domain value was not provided (either via the configuration file, or via the topLevelDomain parameter on the method).

triggerExperiment

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj");
$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$experimentID = 75253;
$variationID;

try {
  $variationID = $kameleoonClient->triggerExperiment($visitorCode, $experimentID);
}
catch (Kameleoon\Exception\NotTargeted $e) {
  /*
    The user did not trigger the experiment, as the associated targeting segment
    conditions were not fulfilled. He should see the reference variation.
  */
  variationID = 0;
}
catch (Kameleoon\Exception\NotAllocated $e) {
  /*
    The user triggered the experiment, but did not activate it. Usually, this happens
    because the user has been associated with excluded traffic.
  */
  variationID = 0;
}
catch (Kameleoon\Exception\ExperimentConfigurationNotFound $e) {
  /*
    This experiment was not found in the SDK configuration. The user will not be counted
    into the experiment, but should see the reference variation.
  */
  variationID = 0;
}

To trigger an experiment call the triggerExperiment() method of our SDK.

This method takes visitorCode and experimentID as mandatory arguments to register a variation for a given user.

If such a user has never been associated with any variation, the SDK returns a randomly selected variation. If a user with a given visitorCode is already registered with a variation, it will detect the previously registered variation and return the variationID.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitorCode	String	Unique identifier of the user. This field is mandatory.
experimentID	Integer	ID of the experiment you want to expose to a user. This field is mandatory.

Return value

Name	Type	Description
variationID	Integer	ID of the variation that is registered for a given visitorCode.

Exceptions Thrown

Type	Description
Kameleoon\Exception\NotTargeted	Exception indicating that the current visitor / user did not trigger the required targeting conditions for this experiment. The targeting conditions are defined via Kameleoon's segment builder.
Kameleoon\Exception\NotAllocated	Exception indicating that the current visitor / user triggered the experiment (met the targeting conditions), but got into unallocated traffic. The most common reason for that is that part of the traffic has been excluded from the experiment and should not be tracked.
Kameleoon\Exception\ExperimentConfigurationNotFound	Exception indicating that the requested experiment ID has not been found in the internal configuration of the SDK. This is usually normal and means that the experiment has not yet been started on Kameleoon's side (but code triggering / implementing variations is already deployed on the web-application's side).

isFeatureActive

$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$featureKey = "new_checkout";
$hasNewCheckout = false;

try {
  $hasNewCheckout = $kameleoonClient->isFeatureActive($visitorCode, $featureKey);
}
catch (Kameleoon\Exception\FeatureConfigurationNotFound $e) {
  // Feature toggle not yet activated on Kameleoon's side - we consider the feature inactive
  $hasNewCheckout = false;
}
catch (Kameleoon\Exception\VisitorCodeNotValid $e) {
  // VisitorCode which you passed to a method is invalid and can't be accepte
}
catch (Exception $e) {
  // This is generic Exception handler which will handle all exceptions.
  echo "Exception: ",  $e->getMessage(), "\n";
}
if ($hasNewCheckout)
{
  // Implement new checkout code here
}

note

Previously named: activateFeature - deprecated since SDK version 3.0.0 and will be removed in a future releases.

This method takes a visitorCode and featureKey as mandatory arguments to check if the specified feature will be active for a given user.

If such a user has never been associated with this feature flag, the SDK returns a boolean value randomly (true if the user should have this feature or false if not). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous FeatureFlag value.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.

Return value

Type	Description
bool	Value of the feature that is registered for a given visitorCode.

Exceptions Thrown

Type	Description
Kameleoon\Exception\FeatureConfigurationNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
Kameleoon\Exception\VisitorCodeNotValid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).

getFeatureVariationKey

$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$featureKey = "featureKey";
$variationKey = "";

try {
  $variationKey = $kameleoonClient->getFeatureVariationKey($visitorCode, $featureKey);
  switch ($variationKey) {
    case "on":
      // Main variation key is selected for visitorCode
    case "alternativeVariation":
      // Alternative variation key
    default:
      // Default variation key
  }
}
catch (Kameleoon\Exception\FeatureConfigurationNotFound $e) {
  // Feature toggle not yet activated on Kameleoon's side - we consider the feature inactive
}
catch (Kameleoon\Exception\VisitorCodeNotValid $e) {
  // VisitorCode which you passed to a method is invalid and can't be accepte
}
catch (Exception $e) {
  // This is generic Exception handler which will handle all exceptions.
  echo "Exception: ",  $e->getMessage(), "\n";
}

To get feature variation key, call the getFeatureVariationKey() method of our SDK.

This method takes a visitorCode and featureKey as mandatory arguments to get variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variation key randomly (according to the feature flag rules). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous variation key value. If the user does not match any of the rules, the default value will be returned, which we can define in your customer's account.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.

Return value

Type	Description
string	Variation key of the feature flag that is registered for a given visitorCode.

Exceptions Thrown

Type	Description
Kameleoon\Exception\FeatureConfigurationNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
Kameleoon\Exception\VisitorCodeNotValid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).

getFeatureVariable

$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$featureKey = "featureKey";
$variableName = "variableName"

try {
  $variationValue = $kameleoonClient->getFeatureVariable($visitorCode, $featureKey, $variableName);
  // Your custom code depending of variableValue
}
catch (Kameleoon\Exception\FeatureConfigurationNotFound $e) {
  // Feature toggle not yet activated on Kameleoon's side - we consider the feature inactive
}
catch (Kameleoon\Exception\VisitorCodeNotValid $e) {
  // VisitorCode which you passed to a method is invalid and can't be accepte
}
catch (Kameleoon\Exception\FeatureVariableNotFound $e) {
  // Requested variable not defined on Kameleoon's side
}
catch (Exception $e) {
  // This is generic Exception handler which will handle all exceptions.
  echo "Exception: ",  $e->getMessage(), "\n";
}

note

Previously named: obtainFeatureVariable. Deprecated since SDK version 3.0.0 and will be removed in a future releases.

To get variable of variation key associated with a user, call the getFeatureVariable() method of our SDK.

This method takes a visitorCode, featureKey and variableName as mandatory arguments to get a variable of variation key for a given user.

If such a user has never been associated with this feature flag, the SDK returns a variable value of variation key randomly (according to the feature flag rules). If a user with a given visitorCode is already registered with this feature flag, it will detect the variable value for previous associated variation. If the user does not match any of the rules, the variable of default value will be returned.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential exceptions.

Arguments

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
featureKey	string	Key of the feature you want to expose to a user. This field is mandatory.
variableName	string	Name of the variable you want to get a value. This field is mandatory.

Return value

Type	Description
Any	Value of variable of variation that is registered for a given visitorCode for this feature flag. Possible types: bool, int, float, string, object, array

Exceptions Thrown

Type	Description
Kameleoon\Exception\FeatureConfigurationNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
Kameleoon\Exception\VisitorCodeNotValid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).
Kameleoon\Exception\FeatureVariableNotFound	Exception indicating that the requested variable has not been found. Check that the variable's ID (or key) matches the one in your code.

getVariationAssociatedData

$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$experimentID = 75253;

try {
  $variationID = $kameleoonClient->triggerExperiment(visitorCode, experimentID);
  $jsonObject = $kameleoonClient->getVariationAssociatedData(variationID);
  $firstName = $jsonObject->firstName;
}
catch (Kameleoon\Exception\VariationConfigurationNotFound $e) {
  // The variation is not yet activated on Kameleoon's side, ie the associated experiment is not online
}
catch (Exception $e) {
  // This is generic Exception handler which will handle all exceptions.
  echo "Exception: ",  $e->getMessage(), "\n";
}

note

Previously named: obtainVariationAssociatedData - deprecated since SDK version 3.0.0 and will be removed in a future releases.

To retrieve JSON data associated with a variation, call the getVariationAssociatedData() method of our SDK. The JSON data usually represents some metadata of the variation, and can be configured on our web application interface or via our Automation API.

This method takes the variationID as a parameter and will return the data as a Object instance. It will throw an exception (Kameleoon\Exception\VariationConfigurationNotFound) if the variation ID is wrong or corresponds to an experiment that is not yet online.

Arguments

Name	Type	Description
variationID	Integer	ID of the variation you want to obtain associated data for. This field is mandatory.

Return value

Type	Description
Object	Data associated with this variationID.

Exceptions Thrown

Type	Description
Kameleoon\Exception\VariationConfigurationNotFound	Exception indicating that the requested variation ID has not been found in the internal configuration of the SDK. This is usually normal and means that the variation's corresponding experiment has not yet been activated on Kameleoon's side.

getFeatureAllVariables

$featureKey = "test_feature_variables";
$variationKey = "on";

try {
  $variables = $kameleoonClient->getFeatureAllVariables(visitorCode, experimentID);
  $firstName = $variables["firstName"];
}
catch (Kameleoon\Exception\FeatureConfigurationNotFound $e) {
  // The feature is not yet activated on Kameleoon's side
}
catch (Kameleoon\Exception\VariationConfigurationNotFound $e) {
  // The variation is not yet activated on Kameleoon's side, ie the associated experiment is not online
}
catch (Exception $e) {
  // This is generic Exception handler which will handle all exceptions.
  echo "Exception: ",  $e->getMessage(), "\n";
}

To retrieve the all feature variables, call the getFeatureAllVariables() method of our SDK. A feature variable can be changed easily via our web application.

This method takes featureKey and variationKey as mandatory arguments. It will return the data with the object type, as defined on the web interface. Throws an error (Kameleoon\Exception\FeatureConfigurationNotFound) if the requested feature flag has not been found in the client configuration of the SDK. If variation key isn't found the method throws (Kameleoon\Exception\VariationConfigurationNotFound) error.

Arguments

Name	Type	Description
featureKey	string	Key of the feature flag you want to obtain. This field is mandatory.
variationKey	string	Key of the variation you want to obtain. This field is mandatory.

Return value

Type	Description
Any	Value of variable of variation that is registered for a given visitorCode for this feature flag. Possible types: bool, int, float, string, object, array

Exceptions Thrown

Type	Description
Kameleoon\Exception\FeatureConfigurationNotFound	Exception indicating that the requested feature ID has not been found in the internal configuration of the SDK. This is usually normal and means that the feature flag has not yet been activated on Kameleoon's side (but code implementing the feature is already deployed on the web-application's side).
Kameleoon\Exception\VariationConfigurationNotFound	Exception indicating that the requested variation ID has not been found in the internal configuration of the SDK. This is usually normal and means that the variation's corresponding experiment has not yet been activated on Kameleoon's side.

trackConversion

require "vendor/autoload.php";

$kameleoonClient = Kameleoon\KameleoonClientFactory::create("a8st4f59bj", false, "/etc/kameleoon/client-php.json");
$visitorCode = $kameleoonClient->getVisitorCode("example.com");
$goalID = 83023;

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Browser(Kameleoon\Data\Browser::$browsers["CHROME"]));
$kameleoonClient->addData(
  $visitorCode,
  new Kameleoon\Data\PageView("https://url.com", "title", array(3)),
  new Kameleoon\Data\Interest(2)
);
$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Conversion(32, 10, false));

$kameleoonClient->trackConversion($visitorCode, $goalID);

To track conversion, use the trackConversion() method. This method requires visitorCode and goalID to track conversion on this particular goal. In addition, this method also accepts revenue as a third optional argument to track revenue. The visitorCode usually is identical to the one that was used when triggering the experiment.

The trackConversion() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments

Name	Type	Description
visitorCode	String	Unique identifier of the user. This field is mandatory.
goalID	Integer	ID of the goal. This field is mandatory.
revenue	Float	Revenue of the conversion. This field is optional.

addData

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Browser(Kameleoon\Data\Browser::$browsers["CHROME"]));
$kameleoonClient->addData(
  $visitorCode,
  new Kameleoon\Data\PageView("https://url.com", "title", array(3)),
  new Kameleoon\Data\Interest(0)
);
$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Conversion(32, 10, false));

To associate various data with the current user, we can use the addData() method. This method requires the visitorCode as a first parameter, and then accepts several additional parameters. Those additional parameters represent the various Data Types allowed in Kameleoon.

Note that the addData() method doesn't return any value and doesn't interact with the Kameleoon back-end servers by itself. Instead, the declared data is saved for future sending via the flush() method described in the next paragraph. This reduces the number of server calls made, as data is usually grouped into a single server call triggered by the execution of flush().

note

The triggerExperiment() and trackConversion() methods also send out previously associated data, just like the flush() method.

Arguments

Name	Type	Description
visitorCode	String	Unique identifier of the user. This field is mandatory.
dataTypes	Data	Custom data types which may be passed separated by a comma.

flush

$visitorCode = $kameleoonClient->getVisitorCode("example.com");

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Browser(Kameleoon\Data\Browser::$browsers["CHROME"]));
$kameleoonClient->addData(
  $visitorCode,
  new Kameleoon\Data\PageView("https://url.com", "title", array(3)),
  new Kameleoon\Data\Interest(0)
);
$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Conversion(32, 10, false));

$kameleoonClient->flush($visitorCode);

Data associated with the current user via addData() method is not sent immediately to the server. It is stored and accumulated until it is sent automatically by the triggerExperiment() or trackConversion() methods, or manually by the flush() method. This allows the developer to control exactly when the data is flushed to our servers. For instance, if you call the addData() method a dozen times, it would be a waste of ressources to send data to the server after each addData() invocation. Just call flush() once at the end.

The flush() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments

Name	Type	Description
visitorCode	String	Unique identifier of the user. This field is mandatory.

getExperimentList

$arrayExperimentIds = $kameleoonClient->getExperimentList();

Returns a list of experiment IDs currently available for the SDK

Return value

Type	Description
array	List of experiment's IDs

getExperimentListForVisitor

// returns ids of all targeted for a visitor experiments
$arrayExperimentIds = $kameleoonClient->getExperimentList($visitorCode, false);

// returns ids of all targeted and simultaneously active for a visitor experiments
$arrayExperimentIds = $kameleoonClient->getExperimentList($visitorCode);
$arrayExperimentIds = $kameleoonClient->getExperimentList($visitorCode, true);

This method takes two input parameters: visitorCode and onlyAllocated. If onlyAllocated parameter is true result contains only active experiments, otherwise it contains all targeted experiments to specific visitorCode. Returns a list of experiment IDs currently available for specific visitorCode according to the onlyAllocated option

Arguments

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.
onlyActive	bool	If true result contains only active for a visitor experiments. Set false for fetching all targeted experiment IDs. This field is mandatory.

Return value

Type	Description
array	List of experiment IDs available for specific visitorCode according to the onlyAllocated option

Exceptions Thrown

Type	Description
Kameleoon\Exception\VisitorCodeNotValid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).

getFeatureList

$arrayFeatureKeys = $kameleoonClient->getFeatureList();

Returns a list of feature flag keys currently available for the SDK

Return value

Type	Description
array	List of feature flag keys

getActiveFeatureListForVisitor

$visitorCode = "visitor"
$arrayFeatureFlagKeys = $kameleoonClient->getActiveFeatureListForVisitor($visitorCode)

This method takes only input parameters: visitorCode. Result contains only active feature flags for a given visitor.

Arguments

Name	Type	Description
visitorCode	string	Unique identifier of the user. This field is mandatory.

Return value

Type	Description
any	List of feature flag keys which are active for a given visitorCode

Exceptions Thrown

Type	Description
Kameleoon\Exception\VisitorCodeNotValid	Exception indicating that the provided visitor code is not valid (empty, or longer than 255 characters).

getRemoteData

$test_value = $kameleoonClient->getRemoteData("test") // 2000 milliseconds default timeout
$test_value = $kameleoonClient->getRemoteData("test", 1000)
try {
  $test_value = $kameleoonClient->getRemoteData("test");
} catch (Exception $e) {
  // Timeout or Json Decoding Exception
}

The getRemoteData() method allows you to retrieve data (according to a key passed as argument) for specified siteCode (specified in KameleoonClientFactory.create()) stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.

Arguments

Name	Type	Description
key	string	The key that the data you try to get is associated with. This field is mandatory.
timeout	int	Timeout (in milliseconds). This parameter specifies the maximum amount of time the method can block to wait for a result. This field is optional, if not provided, it will use the default value of 2000 milliseconds.

Return value

Type	Description
Object	Object associated with retrieving data for specific key.

Exceptions Thrown

Type	Description
Exception	Exception indicating that the request timed out or retrieved data can't be decoded with json_decode method

getEngineTrackingCode

engineTrackingCode := $kameleoonClient->getEngineTrackingCode($visitorCode)
// Example of JS code that can be returned:
//
// window.kameleoonQueue = window.kameleoonQueue || [];
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment1ID, variation1ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment1ID, true]);
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment2ID, variation2ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment2ID, true]);
//
// Here, experiment1ID, experiment2ID and variation1ID, variation2ID represent
// the specific experiments and variations that the specified user has been assigned to

Kameleoon offers built-in integrations with various analytics and CDP solutions, such as Mixpanel, GA4, Segment.... To ensure that you can track and analyze your server-side experiments, Kameleoon provides a method GetEngineTrackingCode() that returns the JavasScript code to be inserted in your page to send automatically the exposure events to the analytics solution you are using. For more information about hybrid experimentation, please refer to this documentation.

note

To benefit from this feature, you will need to implement both the PHP SDK and our Kameleoon JavaScript tag. We recommend you implement the Kameleoon Asynchronous tag, which you can install before your closing <body> tag in your HTML page, as it will be only used for tracking purposes.

Arguments

Name	Type	Description
visitorCode	string	The user's unique identifier. This field is mandatory.

Return value

Type	Description
string	JavasScript code to be inserted in your page

Kameleoon\Data

Browser

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Browser(Kameleoon\Data\Browser::$browsers["CHROME"]));

Name	Type	Description
browser	Associative Array	List of browsers: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER. This field is mandatory.

PageView

$kameleoonClient->addData(
  $visitorCode,
  new Kameleoon\Data\PageView("https://url.com", "title", array(3))
);

Name	Type	Description
url	String	URL of the page viewed. This field is mandatory.
title	String	Title of the page viewed. This field is mandatory.
referrers	array	Referrers of viewed pages. This field is optional.

note

The index (ID) of the referrer is available on our Back-Office, in the Acquisition channel configuration page. Be careful: this index starts at 0, so the first acquisition channel you create for a given site would have the ID 0, not 1.
https://help.kameleoon.com/create-acquisition-channel

Conversion Data Type

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Conversion(32, 10, false));

Name	Type	Description
goalID	Integer	ID of the goal. This field is mandatory.
revenue	Float	Conversion revenue. This field is optional.
negative	Boolean	Defines if the revenue is positive or negative. This field is optional.

CustomData

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\CustomData(1, "some custom value"));

Name	Type	Description
index	Integer	Index / ID of the custom data to be stored. This field is mandatory.
value	String	Value of the custom data to be stored. This field is mandatory.

note

The index (ID) of the custom data is available on our Back-Office, in the Custom data configuration page. Be careful: this index starts at 0, so the first custom data you create for a given site would have the ID 0, not 1.

Device

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\Device(Kameleoon\Data\Device::PHONE));

Name	Type	Description
type	int	List of devices: PHONE, TABLET, DESKTOP. This field is mandatory.

UserAgent

$kameleoonClient->addData($visitorCode, new Kameleoon\Data\UserAgent("TestUserAgent"));

Name	Type	Description
value	string	The User-Agent value that will be sent with tracking requests. This field is mandatory.