This class is in charge of managing your users, including associating them with tracking tokens, adding them to groups and controlling their experiment participation, and handling when they have reached a conversion goal.
| Name | Description |
|---|---|
| getToken | Get the current user's token |
| setToken | Set the current user's tracking token |
| getExperiments | Get all user experiments |
| hasExperiment | Return whether the user has an experiment in the list |
| isParticipant | Return whether the user is a participant of an experiment, and optionally, part of a specific group |
| inControl | RReturn whether the user belongs to the control group of an experiment |
| inVariation | Return whether the user belongs to the variation group of an experiment |
| addExperiment | Add an experiment to the user's list of experiments |
| shouldParticipate | Determine is user should be a participant in an experiment |
| assignGroup | Get a group that the user should be asssiged to |
| hasViewed | Get whether a user has viewed a specific experiment |
| setViewed | Set whether a user has viewed a specific experiment |
| hasConverted | Get whether a user has converted in a specific experiment |
| setConverted | Set whether a user has converted in a specific experiment |
Description
public getToken (void)Get the current users token
Parameters
This function has no parameters.
Return Values
Token|null
Description
public setToken (Token|array|string|null $token)Set the current users tracking token
If an array is passed, it will be used as configuration to create a new instance of Token, and if a string is passed a new Token instance will be created with this value, and all other configuration options set to default
If nothing is passed, the same as above will happen, but the value will be null, and will be read from the users cookie (if one exists)
Parameters
(Token|array|string|null) $token
Return Values
self
Description
public getExperiments (void)Get all user experiments
Parameters
This function has no parameters.
Return Values
array
Description
public hasExperiment (Experiment|int|string $experiment)Return whether the user has an experiment in the list, regardless of whether the user actually is part of it
Parameters
(Experiment|int|string) $experiment: Experiment instance or ID
Return Values
bool
Description
public isParticipant (Experiment|int|string $experiment, int|string|null $group)Return whether the user is a participant of an experiment, and optionally, part of a specific group
Parameters
(Experiment|int|string) $experiment: Experiment instance or ID(int|string|null) $group: Group type (0 or 1)
Return Values
bool
Description
public inControl (Experiment|int|string $experiment)Return whether the user belongs to the control group of an experiment
Parameters
(Experiment|int|string) $experiment: Experiment instance or ID
Return Values
bool
Description
public inVariation (Experiment|int|string $experiment)Return whether the user belongs to the variation group of an experiment
Parameters
(Experiment|int|string) $experiment: Experiment instance or ID
Return Values
bool
Description
public addExperiment (Experiment|int|string $experiment, Group|null $group, bool $viewed, bool $converted)Add an experiment to the users list of experiments
If no group is set, the experiment is added to to list without the user being assigned a group
Parameters
(Experiment|id|string) $experiment: Experiment instance or ID(Group|null) $group(bool) $viewed(bool) $converted
Return Values
self
Description
public shouldParticipate (Experiment $experiment)Determine is user should be a participant in an experiment, based on the experiments configured percentual coverage
Parameters
(Experiment) $experiment
Return Values
bool
Description
public assignGroup (Experiment $experiment)Get a group that the user should be asssiged to, either the control or variation (with a 50/50 chance)
If the experiments coverage is below 100, it's percentage value will be used to determine if the user is assigned an experiment group at all
Parameters
(Experiment) $experiment
Return Values
int|null
Description
public hasViewed (int|string $id)Get whether a user has viewed a specific experiment
Parameters
(int|string) $id: Experiment ID
Return Values
bool
Description
public setViewed (int|string $id, bool $viewed)Set whether a user has viewed a specific experiment
Parameters
(int|string) $id: Experiment ID(bool) $viewed
Return Values
self
Description
public hasConverted (int|string $id)Get whether a user has converted in a specific experiment
Parameters
(int|string) $id: Experiment ID
Return Values
bool
Description
public setConverted (int|string $id, bool $converted)Set whether a user has converted in a specific experiment
Parameters
(int|string) $id: Experiment ID(bool) $converted
Return Values