Forced Decision methods for the PHP SDK
These methods help test and debug various flows of your client applications by forcing users into a specific variation.
The PHP SDK checks forced decisions before making any decisions. If a matching item is found for the requested flag, the PHP SDK returns the forced decision immediately (audience conditionsaudience conditions and traffic allocations are ignored) before making normal decisions.
The PHP SDK checks for forced decisions at the start of each decision process. If a matching forced decision is found, it returns the decision immediately.
- Flag-to-Decision – The SDK checks at the start of any decide call for the given flag.
- Experiment-Rule-to-Decision – The SDK checks at the start of the decision for the given experiment rule of the flag key.
- Delivery-Rule-to-Decision – The SDK checks at the start of the decision for the given delivery rule of the flag key.
Warning You must associate your variations to a flag ruleflag rule before calling any Forced Decision methods.
On forced decisions, the PHP SDK fires impression events and notifications just like other normal decisions (unless disabled by the disableDecisionEventdisableDecisionEvent option).
Note These forced decisions are not persistent and are cleared when the OptimizelyUserContextOptimizelyUserContext is re-initialized.
For information, click the method name.
- setForcedDecisionsetForcedDecision
- getForcedDecisiongetForcedDecision
- removeForcedDecisionremoveForcedDecision
- removeAllForcedDecisionsremoveAllForcedDecisions
OptimizelyDecisionContext
class OptimizelyDecisionContext
{
private $flagKey;
private $ruleKey;
public function __construct($flagKey, $ruleKey);
// get flag key
public function getFlagKey();
// get rule key
public function getRuleKey();
}OptimizelyForcedDecision
class OptimizelyForcedDecision
{
private $variationKey;
public function __construct($variationKey);
// get variation key
public function getVariationKey();
}Set forced decision method - setForcedDecision()
Version
3.9.0
Description
Sets a forced decision (variationKey) for a given OptimizelyDecisionContext.
Parameters
This table lists the required and optional parameters for the PHP SDK.
Parameter | Type | Description |
|---|---|---|
context *required* | Class | An instance of `OptimizelyDecisionContext` with the required `flagKey` and optional `ruleKey` for the forced decision you want to set. |
decision\ *required* | Class | An instance of `OptimizelyForcedDecision` with the required `variationKey` for the forced decision you want to set. |
Returns
A boolean value that indicates if setting the forced decision (variationKey) was completed.
Example
See the complete PHP SDK examplePHP SDK example.
Get forced decision method - getForcedDecision()
Version
3.9.0
Description
Returns the forced decision (variationKey) for a given OptimizelyDecisionContext. Returns the OptimizelyForcedDecision instance or null if there is no matching item.
Parameters
This table lists the required and optional parameters for the PHP SDK.
Parameter | Type | Description |
|---|---|---|
context *required* | Class | An instance of `OptimizelyDecisionContext` with the required `flagKey` and optional `ruleKey` for the forced decision you want to get. |
Returns
A forced decision OptimizelyForcedDecision instance for the context or null if there is no matching item.
Example
See the complete PHP SDK examplePHP SDK example.
Remove forced decision method - removeForcedDecision()
Version
3.9.0
Description
Removes the forced decision (variationKey) for a given OptimizelyDecisionContext.
Parameters
This table lists the required and optional parameters for the PHP SDK.
Parameters | Type | Description |
|---|---|---|
context *required* | Class | An instance of `OptimizelyDecisionContext` with the required `flagKey` and optional `ruleKey` for the forced decision you want to remove. |
Returns
A success/failure boolean status if the forced decision (variationKey) was removed.
Example
See the complete PHP SDK examplePHP SDK example.
Remove all forced decisions method - removeAllForcedDecisions()
Version
3.9.0
Description
Removes all forced decisions (variationKey) for the user context.
Parameters
This table lists the required and optional parameters for the PHP SDK.
Parameters | Type | Description |
|---|---|---|
None | N/A | N/A |
Returns
A success/failure boolean status.
Example
See the complete PHP SDK examplePHP SDK example.
Full Code Example
$optimizelyClient = OptimizelyFactory::createDefaultInstance($sdkKey);
$user = $optimizelyClient->createUserContext('test_user', $attributes);
$flagContext = new OptimizelyDecisionContext('flag-1', null);
$flagAndABTestContext = new OptimizelyDecisionContext('flag-1', 'ab-test-1');
$flagAndDeliveryRuleContext = new OptimizelyDecisionContext('flag-1', 'delivery-1');
$variationAForcedDecision = new OptimizelyForcedDecision('variation-a');
$variationBForcedDecision = new OptimizelyForcedDecision('variation-b');
$variationOnForcedDecision = new OptimizelyForcedDecision('on');
// set a forced decision for a flag
$success = $user->setForcedDecision($flagContext, $variationAForcedDecision);
$decision = $user->decide('flag-1');
// set a forced decision for an ab-test rule
$success = $user->setForcedDecision($flagAndABTestContext, $variationBForcedDecision);
$decision = $user->decide('flag-1');
// set a forced variation for a delivery rule
$success = $user->setForcedDecision($flagAndDeliveryRuleContext, $variationOnForcedDecision);
$decision = $user->decide('flag-1');
// get forced variations
$forcedDecision = $user->getForcedDecision($flagContext);
echo "[ForcedDecision] variationKey = {$forcedDecision}";
// remove forced variations
$success = $user->removeForcedDecision($flagAndABTestContext);
$success = $user->removeAllForcedDecisions();See Also
OptimizelyUserContextOptimizelyUserContext