LaunchDarkly PHP SDK 6.3.0

EvaluationReason

in package

• LaunchDarkly

implements JsonSerializable

Describes the reason that a flag evaluation produced a particular value.

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

CLIENT_NOT_READY_ERROR  = 'CLIENT_NOT_READY'

A possible value for getErrorKind(): indicates that the caller tried to evaluate a flag before the client had successfully initialized.

ERROR  = 'ERROR'

A possible value for getKind(): indicates that the flag could not be evaluated, e.g.

EXCEPTION_ERROR  = 'EXCEPTION'

A possible value for getErrorKind(): indicates that an unexpected exception stopped flag evaluation.

FALLTHROUGH  = 'FALLTHROUGH'

A possible value for getKind(): indicates that the flag was on but the user did not match any targets or rules.

FLAG_NOT_FOUND_ERROR  = 'FLAG_NOT_FOUND'

A possible value for getErrorKind(): indicates that the caller provided a flag key that did not match any known flag.

MALFORMED_FLAG_ERROR  = 'MALFORMED_FLAG'

A possible value for getErrorKind(): indicates that there was an internal inconsistency in the flag data, e.g. a rule specified a nonexistent variation. An error message will always be logged in this case.

OFF  = 'OFF'

A possible value for getKind(): indicates that the flag was off and therefore returned its configured off value.

PREREQUISITE_FAILED  = 'PREREQUISITE_FAILED'

A possible value for getKind(): indicates that the flag was considered off because it had at least one prerequisite flag that either was off or did not return the desired variation.

RULE_MATCH  = 'RULE_MATCH'

A possible value for getKind(): indicates that the user matched one of the flag's rules.

TARGET_MATCH  = 'TARGET_MATCH'

A possible value for getKind(): indicates that the user key was specifically targeted for this flag.

USER_NOT_SPECIFIED_ERROR  = 'USER_NOT_SPECIFIED'

A possible value for getErrorKind(): indicates that the caller passed null for the user parameter, or the user lacked a key.

WRONG_TYPE_ERROR  = 'WRONG_TYPE'

A possible value for getErrorKind(): indicates the value of the evaluation did not match the PHP type expected.

__toString()  : string

Returns a simple string representation of this object.

error()  : EvaluationReason

Creates a new instance of the ERROR reason.

fallthrough()  : EvaluationReason

Creates a new instance of the FALLTHROUGH reason.

getErrorKind()  : string|null

Returns a constant indicating the nature of the error, if getKind() is OFF. Otherwise returns null.

getKind()  : string

Returns a constant indicating the general category of the reason, such as OFF.

getPrerequisiteKey()  : string|null

Returns the key of the prerequisite feature flag that failed, if getKind() is PREREQUISITE_FAILED. Otherwise returns null.

getRuleId()  : string|null

Returns the unique identifier of the rule that was matched, if getKind() is RULE_MATCH.

getRuleIndex()  : int|null

Returns the positional index of the rule that was matched (0 for the first), if getKind() is RULE_MATCH. Otherwise returns null.

isInExperiment()  : bool

Returns true if the evaluation resulted in an experiment rollout *and* served one of the variations in the experiment. Otherwise it returns false.

jsonSerialize()  : array<string|int, mixed>

Returns a JSON representation of this object. This method is used automatically if you call json_encode().

off()  : EvaluationReason

Creates a new instance of the OFF reason.

prerequisiteFailed()  : EvaluationReason

Creates a new instance of the PREREQUISITE_FAILED reason.

ruleMatch()  : EvaluationReason

Creates a new instance of the RULE_MATCH reason.

targetMatch()  : EvaluationReason

Creates a new instance of the TARGET_MATCH reason.