Decide methods for the PHP SDK

Use the decide methods to return feature flag decisions for a user. Each decision includes whether the flag is enabled and which variation the user receives.

Decide

Returns a decision for a specific feature flag and user.

Minimum SDK version – v3.7+

Description

The decide method handles the variation decision for an individual experiment. It returns a decision result for a flag key for a user in an OptimizelyDecision object and contains the data required to deliver the flag rule.

This method ensures that Feature Experimentation properly buckets the user in experiment analytics, and you should use it if there is no need for pre-rendering decisions.

📘

Note

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

See the OptimizelyDecision documentation for details of the returned decision object.

Parameters

The following table describes parameters for the decide method:

Returns

The decide method returns an OptimizelyDecision object.

If the method encounters a critical error (SDK not ready, invalid flag key, and so on), then it returns a decision with a null variationKey field and populates the reasons field with error messages (regardless of the OptimizelyDecideOption.INCLUDE_REASONS option).

Example decide

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

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

// The 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 effect

Invokes the decision notification listener if this listener is enabled.

Decide all

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

Minimum SDK version – v3.6.1+

Description

Use the decide all method to retrieve decisions for all active flags before rendering content. This is particularly useful when you need to serve the correct cached version of your page or component based on the user's variation. For example when using an edge worker or cloud function.

Key features

• Pre-rendering decision – Lets you know all variation assignments ahead of time.
• Cache control – Lets you serve the correct cached content based on the user's pre-determined variations.
• Delay experiment tracking – Use DISABLE_DECISION_EVENT to prevent the SDK from recording a decision before the user sees the feature. This ensures that participation is only tracked when the experience is delivered.

Parameters

The following table describes parameters for the decide all method:

Returns

The decide all method returns a map of OptimizelyDecision objects.

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.

Example decideAll

// 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 effect

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

Decide for keys

Returns a map of flag decisions for specified flag keys.

Minimum SDK version – v3.6+

Description

Returns a map of decisions for the specified flag keys.

Parameters

The following table describes parameters for the decide for keys method:

Returns

Returns a map of OptimizelyDecisions. 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.

Example decideForKeys

// 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 effect

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

OptimizelyDecideOption

The following table lists the OptimizelyDecideOption enum with an explanation what happens if you set them. In addition to setting these options individually for a decide method, you can also set them as global defaults when you instantiate the Optimizely client. See Initialize the PHP SDK.

The following code sample shows how to implement the OptimizelyDecideOption as a global default and locally in a decide method call.

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]); // replace with your SDK key
$user = $optimizely_client->createUserContext("test_user");
$decision_result_map = $user->decideAll([OptimizelyDecideOption::ENABLED_FLAGS_ONLY, OptimizelyDecideOption::IGNORE_USER_PROFILE_SERVICE]);

Best practices

• Early and late invocation
  • Use the decide all method early in your application's rendering process to load the correct cached content. For example, on the CDN with an Edge SDK.
  • Use the decide method at the point of user interaction or when you must ensure Feature Experimentation records the decision in your experiment analytics.
• Combining methods – When using the decide and decide all methods, always pair the decide all method with the decide method for each experiment the user encounters. This prevents discrepancies between served content and analytics data.
• Parameter management – Ensure you use the DISABLE_DECISION_EVENT option with the decide all method to avoid premature bucketing, then use the decide method to handle the decision event when the user experiences the content.

Source files

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