kameleoon/openfeature-php

Kameleoon OpenFeature PHP

0.0.1 2024-10-14 15:30 UTC

Requires

• kameleoon/kameleoon-client-php: >=4.4.0
• open-feature/sdk: >=2.0.8

AGPL-3.0-or-later

• Kameleoon

• sdk
• kameleoon
• openfeeature

README

The Kameleoon OpenFeature provider for PHP allows you to connect your OpenFeature PHP implementation to Kameleoon without installing the PHP Kameleoon SDK.

Warning

This is a beta version. Breaking changes may be introduced before general release.

Supported PHP versions

This version of the SDK is built for the following targets:

• PHP 8.0 and above.

Get started

This section explains how to install, configure, and customize the Kameleoon OpenFeature provider.

Install dependencies

First, install the required dependencies in your application.

add in composer.json

{
  "require": {
    "kameleoon/openfeature-php": ">=0.0.1"
  }
}

composer install

Usage

The following example shows how to use the Kameleoon provider with the OpenFeature SDK.

use OpenFeature\implementation\flags\Attributes;
use OpenFeature\implementation\flags\EvaluationContext;
use OpenFeature\OpenFeatureAPI;
use Kameleoon\KameleoonProvider;
use Kameleoon\KameleoonClientConfig;

$clientConfig = new KameleoonClientConfig(
    "clientId",
    "clientSecret",
);

$provider = new KameleoonProvider('siteCode', $clientConfig);
$api = OpenFeatureAPI::getInstance();
$api->setProvider($provider);
$client = $api->getClient();

$dataDictionary = [
    'variableKey' => 'stringKey'
];
$evalContext = new EvaluationContext("visitorCode", new Attributes($dataDictionary));

$evaluationDetails = $client->getStringDetails("featureKey", 5, $evalContext);

$numberOfRecommendedProducts = $evaluationDetails->getValue();
print_r("Number of recommended products: " . $numberOfRecommendedProducts);

Customize the Kameleoon provider

You can customize the Kameleoon provider by changing the KameleoonClientConfig object that you passed to the constructor above. For example:

$clientConfig = new KameleoonClientConfig(
    clientId: "clientId",
    clientSecret: "clientSecret",
    kameleoonWorkDir: "/tmp/kameleoon/php-client/", // kameleoonWorkDir: optional / ("/tmp/kameleoon/php-client/" by default)
    refreshIntervalMinute: 60, // refreshIntervalMinute: in minutes, optional (60 minutes by default)
    defaultTimeoutMillisecond: 10_000, // defaultTimeoutMillisecond: in milliseconds, optional (10_000 ms by default)
    debugMode: false, // debugMode: optional (false by default)
    cookieOptions: $cookieOptions, // cookieOptions: optional
    environment: "development" // environment: optional ("production" by default)
);

$provider = new KameleoonProvider('siteCode', $clientConfig);

Note

For additional configuration options, see the Kameleoon documentation.

EvaluationContext and Kameleoon Data

Kameleoon uses the concept of associating Data to users, while the OpenFeature SDK uses the concept of an EvaluationContext, which is a dictionary of string keys and values. The Kameleoon provider maps the EvaluationContext to the Kameleoon Data.

Note

To get the evaluation for a specific visitor, set the targeting_key value for the EvaluationContext to the visitor code (user ID). If the value is not provided, then the defaultValue parameter will be returned.

$values = [
  'variableKey' => 'stringKey'
];

$evalContext = new EvaluationContext("userId", new Attributes($values));

The Kameleoon provider provides a few predefined parameters that you can use to target a visitor from a specific audience and track each conversion. These are:

DataType::CUSTOM_DATA

Use DataType::CUSTOM_DATA to set CustomData for a visitor. The DataType::CUSTOM_DATA field has the following parameters:

Example

$customeDataDictionary = [
    DataType::CUSTOM_DATA => [
        CustomDataType::INDEX => 1,
        CustomDataType::VALUES => '10'
    ]
];

$evalContext = new EvaluationContext("userId", new Attributes($customeDataDictionary));

DataType::CONVERSION

Use DataType::CONVERSION to track a Conversion for a visitor. The DataType::CONVERSION field has the following parameters:

Example

$conversionDictionary = [
    DataType::CONVERSION => [
        ConversionType::GOAL_ID => 1,
        ConversionType::REVENUE => 200
    ]
];

$evalContext = new EvaluationContext("userId", new Attributes($conversionDictionary));

Use multiple Kameleoon Data types

You can provide many different kinds of Kameleoon data within a single EvaluationContext instance.

For example, the following code provides one DataType::CONVERSION instance and two DataType::CUSTOM_DATA instances.

$dataDictionary = [
    DataType::CONVERSION => [
        ConversionType::GOAL_ID => 1,
        ConversionType::REVENUE => 200
    ],
    DataType::CUSTOM_DATA => [
        [
            CustomDataType::INDEX => 1,
            CustomDataType::VALUES => ['10', '30']
        ],
        [
            CustomDataType::INDEX => 2,
            CustomDataType::VALUES => '20'
        ]
    ]
];

$evalContext = new EvaluationContext("userId", $dataDictionary);