Decide methods for the PHP SDK

An overview of the decide methods for the PHP SDK, which can be used to return a flag decision for a user in Optimizely Feature Experimentation.

Suggest Edits

Use the Decide methods to return flag decisions for a user. The flag decision includes flag enabled/disabled status and flag variation.

This page describes the following Decide methods:

Decide

Version

SDK 3.7 and higher

Description

Returns a decision result for a flag key for a user. The decision result is returned in an OptimizelyDecision object and contains all data required to deliver the flag rule.

Decide is a method of the UserContext object. See OptimizelyUserContext for details.

See the OptimizelyDecision for details of the returned decision object.

Parameters

The following table describes parameters for the Decide method:

Parameter	Type	Description
key	String	The key of the feature flag
decideOptions (optional)	Array	Array of OptimizelyDecideOption enums. See following table.

OptimizelyDecideOption

The following example shows how you can set options individually on any Decide method, or as global defaults when you instantiate the Optimizely client.

use Optimizely\Optimizely;
use Optimizely\Decide\OptimizelyDecideOption;
$optimizely_client = new Optimizely(null, null, null, null, null, null, null, null, "<YOUR_SDK_KEY>", [OptimizelyDecideOption::DISABLE_DECISION_EVENT]);
$user = $optimizely_client->createUserContext("test_user");
$decision_result_map = $user->decideAll([OptimizelyDecideOption::ENABLED_FLAGS_ONLY, OptimizelyDecideOption::IGNORE_USER_PROFILE_SERVICE]);

The following table shows details for the options you can set on Decide methods.

OptimizelyDecideOption enum	If set:
disableDecisionEvent	Prevents the visitor from firing an impression while still being served the variation, which disables displaying results of the Decide method on the Optimizely application's Results page. This setting can be why the Decision Event Dispatched enum is false in the returned `OptimizelyDecision` object or the DECIDE notification listener payload.
enabledFlagsOnly	Return decisions for enabled flags only. This is a valid option only for methods that decide multiple flags, like the Decide All method. This option is ignored if it is invalid. When this option is not set, the SDK returns all decisions regardless of whether the flag is enabled or not.
ignoreUserProfileService	When set, the SDK bypasses user profile service (UPS) (both lookup and save) for the decision. When this option is not set, UPS overrides audience targeting, traffic allocation, and experiment mutual exclusion groups.
includeReasons	Return log messages in the Reasons field of OptimizelyDecision object. Note that unlike info or debug messages, critical error messages are always returned, regardless of this setting.
excludeVariables	Exclude flag variable values from the decision result. Use this option to minimize the returned decision by skipping large JSON variables.

Returns

The Decide method returns an OptimizelyDecision object. For more information, see OptimizelyDecision.

If the method encounters a critical error (SDK not ready, invalid flag key, etc), then it returns a decision with a null Variation Key field and populates the Reasons field with error messages (regardless of the Include Reasons option).

Example Decision

The following is an example of calling the Decide method and accessing the returned OptimizelyDecision object:

// create the user and decide which flag rule & variation they bucket into 
$user = $optimizely->createUserContext('user123', ['logged_in' => true]);
$decision = $user->decide('product_sort');

// variation. if null, decision fail with a critical error
$variationKey = $decision->getVariationKey();

// flag enabled state:
$enabled = $decision->getEnabled();

// String variable value:
$value = (string) $decision->getVariables()['logged_in'];

// all variable values
$allVarValues = $decision->getVariables();

// flag decision reasons
$reasons = $decision->getReasons();

// user for which the decision was made
$userContext = $decision->getUserContext();

Side Effects

Invokes the DECISION notification listener if this listener is enabled.

Decide All

Returns decisions for all active (unarchived) flags for a user.

See OptimizelyDecision for details.

Version

SDK v3.6.1 and higher

Description

Use the Decide All method to return a map of flag decisions for a user.

Parameters

The following table describes parameters for the Decide All method:

Parameter	Type	Description
options (optional)	Array	Array of OptimizelyDecideOption enums. See OptimizelyDecideOption.

Returns

The Decide All method returns a map of OptimizelyDecision objects. For more information, see OptimizelyDecision.

If the method fails for all flags (for example, the SDK is not ready or the user context is invalid), then it returns an empty map. If the method detects an error for a specific flag, it returns error messages in the Reasons field of the decision for that flag.

Examples

The following is an example of getting flags for the user with the Decide All call:

// make decisions for all active (unarchived) flags in the project for a user
$decisions = $user->decideAll();
// or only for enabled flags
$decisions = $user->decideAll(['ENABLED_FLAGS_ONLY']);

$flagKeys = array_keys($decisions);
$flagDecisions = array_map(
        function($decision) { return $decision; },
        $decisions
);
$decisionForFlag1 = $decisions['flag_1'];

Side effects

Invokes the DECISION notification listener for each decision, if this listener is enabled.

Decide For Keys

In the PHP SDK, The Decide For Keys method makes decisions for a user for specified flag keys

Version

SDK v3.6 and higher

Description

Get a map of flag decisions for an array of flag keys.

Parameters

The following table describes parameters for the Decide method:

The following table describes parameters for the Decide For Keys method:

Parameter	Type	Description
keys	Array	Array of string flag keys.
options (optional)	Array	Array of OptimizelyDecideOption enums. See OptimizelyDecideOption.

Returns

Returns a map of OptimizelyDecisions. For more information, see OptimizelyDecision.

Example

The following is an example of getting specified flags for the user:

// make a decisions for specific enabled  flags
$options = ['ENABLED_FLAGS_ONLY'];
$decisions = $user->decideForKeys(['flag_1', 'flag_2'], $options);

$decisionForFlag1 = $decisions['flag_1'];
$decisionForFlag2 = $decisions['flag_2'];

Side effects

Invokes the DECISION notification listener for each decision, if this listener is enabled.

Source files

The language and platform source files containing the implementation for PHP are available on GitHub.

Updated 10 months ago