-
Notifications
You must be signed in to change notification settings - Fork 10.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[9.x] Lottery #44894
Merged
Merged
[9.x] Lottery #44894
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,258 @@ | ||
<?php | ||
|
||
namespace Illuminate\Support; | ||
|
||
use RuntimeException; | ||
|
||
class Lottery | ||
{ | ||
/** | ||
* The number of expected wins. | ||
* | ||
* @var int|float | ||
*/ | ||
protected $chances; | ||
|
||
/** | ||
* The number of potential opportunities to win. | ||
* | ||
* @var int|null | ||
*/ | ||
protected $outOf; | ||
|
||
/** | ||
* The winning callback. | ||
* | ||
* @var null|callable | ||
*/ | ||
protected $winner; | ||
|
||
/** | ||
* The losing callback. | ||
* | ||
* @var null|callable | ||
*/ | ||
protected $loser; | ||
|
||
/** | ||
* The factory that should be used to generate results. | ||
* | ||
* @var callable|null | ||
*/ | ||
protected static $resultFactory; | ||
|
||
/** | ||
* Create a new Lottery instance. | ||
* | ||
* @param int|float $chances | ||
* @param ?int $outOf | ||
*/ | ||
public function __construct($chances, $outOf = null) | ||
{ | ||
if ($outOf === null && is_float($chances) && $chances > 1) { | ||
throw new RuntimeException('Float must not be greater than 1.'); | ||
} | ||
|
||
$this->chances = $chances; | ||
|
||
$this->outOf = $outOf; | ||
} | ||
|
||
/** | ||
* Create a new Lottery instance. | ||
* | ||
* @param int|float $chances | ||
* @param ?int $outOf | ||
* @return static | ||
*/ | ||
public static function odds($chances, $outOf = null) | ||
{ | ||
return new static($chances, $outOf); | ||
} | ||
|
||
/** | ||
* Set the winner callback. | ||
* | ||
* @param callable $callback | ||
* @return $this | ||
*/ | ||
public function winner($callback) | ||
{ | ||
$this->winner = $callback; | ||
|
||
return $this; | ||
} | ||
|
||
/** | ||
* Set the loser callback. | ||
* | ||
* @param callable $callback | ||
* @return $this | ||
*/ | ||
public function loser($callback) | ||
{ | ||
$this->loser = $callback; | ||
|
||
return $this; | ||
} | ||
|
||
/** | ||
* Run the lottery. | ||
* | ||
* @param mixed ...$args | ||
* @return mixed | ||
*/ | ||
public function __invoke(...$args) | ||
{ | ||
return $this->runCallback(...$args); | ||
} | ||
|
||
/** | ||
* Run the lottery. | ||
* | ||
* @param null|int $times | ||
* @return mixed | ||
*/ | ||
public function choose($times = null) | ||
{ | ||
if ($times === null) { | ||
return $this->runCallback(); | ||
} | ||
|
||
$results = []; | ||
|
||
for ($i = 0; $i < $times; $i++) { | ||
$results[] = $this->runCallback(); | ||
} | ||
|
||
return $results; | ||
} | ||
|
||
/** | ||
* Run the winner or loser callback, randomly. | ||
* | ||
* @param mixed ...$args | ||
* @return callable | ||
*/ | ||
protected function runCallback(...$args) | ||
{ | ||
return $this->wins() | ||
? ($this->winner ?? fn () => true)(...$args) | ||
: ($this->loser ?? fn () => false)(...$args); | ||
} | ||
|
||
/** | ||
* Determine if the lottery "wins" or "loses". | ||
* | ||
* @return bool | ||
*/ | ||
protected function wins() | ||
{ | ||
return static::resultFactory()($this->chances, $this->outOf); | ||
} | ||
|
||
/** | ||
* The factory that determines the lottery result. | ||
* | ||
* @return callable | ||
*/ | ||
protected static function resultFactory() | ||
{ | ||
return static::$resultFactory ?? fn ($chances, $outOf) => $outOf === null | ||
? random_int(0, PHP_INT_MAX) / PHP_INT_MAX <= $chances | ||
: random_int(1, $outOf) <= $chances; | ||
} | ||
|
||
/** | ||
* Force the lottery to always result in a win. | ||
* | ||
* @param callable|null $callback | ||
* @return void | ||
*/ | ||
public static function alwaysWin($callback = null) | ||
{ | ||
self::setResultFactory(fn () => true); | ||
|
||
if ($callback === null) { | ||
return; | ||
} | ||
|
||
$callback(); | ||
|
||
static::determineResultNormally(); | ||
} | ||
|
||
/** | ||
* Force the lottery to always result in a lose. | ||
* | ||
* @param callable|null $callback | ||
* @return void | ||
*/ | ||
public static function alwaysLose($callback = null) | ||
{ | ||
self::setResultFactory(fn () => false); | ||
|
||
if ($callback === null) { | ||
return; | ||
} | ||
|
||
$callback(); | ||
|
||
static::determineResultNormally(); | ||
} | ||
|
||
/** | ||
* Set the sequence that will be used to determine lottery results. | ||
* | ||
* @param array $sequence | ||
* @param callable|null $whenMissing | ||
* @return void | ||
*/ | ||
public static function forceResultWithSequence($sequence, $whenMissing = null) | ||
{ | ||
$next = 0; | ||
|
||
$whenMissing ??= function ($chances, $outOf) use (&$next) { | ||
$factoryCache = static::$resultFactory; | ||
|
||
static::$resultFactory = null; | ||
|
||
$result = static::resultFactory()($chances, $outOf); | ||
|
||
static::$resultFactory = $factoryCache; | ||
|
||
$next++; | ||
|
||
return $result; | ||
}; | ||
|
||
static::setResultFactory(function ($chances, $outOf) use (&$next, $sequence, $whenMissing) { | ||
if (array_key_exists($next, $sequence)) { | ||
return $sequence[$next++]; | ||
} | ||
|
||
return $whenMissing($chances, $outOf); | ||
}); | ||
} | ||
|
||
/** | ||
* Indicate that the lottery results should be determined normally. | ||
* | ||
* @return void | ||
*/ | ||
public static function determineResultNormally() | ||
{ | ||
static::$resultFactory = null; | ||
} | ||
|
||
/** | ||
* Set the factory that should be used to deterine the lottery results. | ||
* | ||
* @param callable $factory | ||
* @return void | ||
*/ | ||
public static function setResultFactory($factory) | ||
{ | ||
self::$resultFactory = $factory; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to annotate the callable here and for the looser so that phpstan knows what it accepts and returns? We might have to update the
choose
docblock then also to mind this.