Experiment.php
56 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WPStaging\Framework\Experiments; |
| 4 | |
| 5 | /** |
| 6 | * Immutable definition of a single A/B experiment. Which variant an installation |
| 7 | * belongs to is stored by {@see ExperimentManager}. |
| 8 | * |
| 9 | * Every variant must offer the same feature set: experiments compare user |
| 10 | * experience, never entitlement. |
| 11 | */ |
| 12 | class Experiment |
| 13 | { |
| 14 | /** @var string */ |
| 15 | private $id; |
| 16 | |
| 17 | /** @var string[] */ |
| 18 | private $variants; |
| 19 | |
| 20 | /** @var bool */ |
| 21 | private $isRunning; |
| 22 | |
| 23 | /** |
| 24 | * @param string $id Snake case identifier, also used as the analytics `experiment` value. |
| 25 | * @param string[] $variants Variant names, control first. At least two. |
| 26 | * @param bool $isRunning False retires the experiment: no new assignments are made, |
| 27 | * existing ones keep reporting so past cohorts stay analysable. |
| 28 | */ |
| 29 | public function __construct(string $id, array $variants, bool $isRunning = true) |
| 30 | { |
| 31 | $this->id = $id; |
| 32 | $this->variants = array_values($variants); |
| 33 | $this->isRunning = $isRunning; |
| 34 | } |
| 35 | |
| 36 | public function getId(): string |
| 37 | { |
| 38 | return $this->id; |
| 39 | } |
| 40 | |
| 41 | public function getVariants(): array |
| 42 | { |
| 43 | return $this->variants; |
| 44 | } |
| 45 | |
| 46 | public function isRunning(): bool |
| 47 | { |
| 48 | return $this->isRunning; |
| 49 | } |
| 50 | |
| 51 | public function hasVariant(string $variant): bool |
| 52 | { |
| 53 | return in_array($variant, $this->variants, true); |
| 54 | } |
| 55 | } |
| 56 |