1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Lottery

Lottery

class Lottery (View source)

Properties

protected int|float $chances

The number of expected wins.
protected int|null $outOf

The number of potential opportunities to win.
protected null|callable $winner

The winning callback.
protected null|callable $loser

The losing callback.
static protected callable|null $resultFactory

The factory that should be used to generate results.

Methods

__construct(int|float $chances, int|null $outOf = null)

Create a new Lottery instance.

static Lottery
odds(int|float $chances, int|null $outOf = null)

Create a new Lottery instance.

$this
winner(callable $callback)

Set the winner callback.

$this
loser(callable $callback)

Set the loser callback.

mixed
__invoke(mixed ...$args)

Run the lottery.

mixed
choose(null|int $times = null)

Run the lottery.

callable
runCallback(mixed ...$args)

Run the winner or loser callback, randomly.

bool
wins()

Determine if the lottery "wins" or "loses".

static callable
resultFactory()

The factory that determines the lottery result.

static void
alwaysWin(callable|null $callback = null)

Force the lottery to always result in a win.

static void
alwaysLose(callable|null $callback = null)

Force the lottery to always result in a lose.

static void
fix(array $sequence, callable|null $whenMissing = null)

Set the sequence that will be used to determine lottery results.

static void
forceResultWithSequence(array $sequence, callable|null $whenMissing = null)

Set the sequence that will be used to determine lottery results.

static void
determineResultsNormally()

Indicate that the lottery results should be determined normally.

static void
determineResultNormally()

Indicate that the lottery results should be determined normally.

static void
setResultFactory(callable $factory)

Set the factory that should be used to determine the lottery results.

Details

at line 50
__construct(int|float $chances, int|null $outOf = null)

Create a new Lottery instance.

Parameters

int|float $chances
int|null $outOf

at line 68
static Lottery odds(int|float $chances, int|null $outOf = null)

Create a new Lottery instance.

Parameters

int|float $chances
int|null $outOf

Return Value

Lottery

at line 79
$this winner(callable $callback)

Set the winner callback.

Parameters

callable $callback

Return Value

$this

at line 92
$this loser(callable $callback)

Set the loser callback.

Parameters

callable $callback

Return Value

$this

at line 105
mixed __invoke(mixed ...$args)

Run the lottery.

Parameters

mixed ...$args

Return Value

mixed

at line 116
mixed choose(null|int $times = null)

Run the lottery.

Parameters

null|int $times

Return Value

mixed

at line 137
protected callable runCallback(mixed ...$args)

Run the winner or loser callback, randomly.

Parameters

mixed ...$args

Return Value

callable

at line 149
protected bool wins()

Determine if the lottery "wins" or "loses".

Return Value

bool

at line 159
static protected callable resultFactory()

The factory that determines the lottery result.

Return Value

callable

at line 172
static void alwaysWin(callable|null $callback = null)

Force the lottery to always result in a win.

Parameters

callable|null $callback

Return Value

void

at line 191
static void alwaysLose(callable|null $callback = null)

Force the lottery to always result in a lose.

Parameters

callable|null $callback

Return Value

void

at line 211
static void fix(array $sequence, callable|null $whenMissing = null)

Set the sequence that will be used to determine lottery results.

Parameters

array $sequence
callable|null $whenMissing

Return Value

void

at line 223
static void forceResultWithSequence(array $sequence, callable|null $whenMissing = null)

Set the sequence that will be used to determine lottery results.

Parameters

array $sequence
callable|null $whenMissing

Return Value

void

at line 255
static void determineResultsNormally()

Indicate that the lottery results should be determined normally.

Return Value

void

at line 265
static void determineResultNormally()

Indicate that the lottery results should be determined normally.

Return Value

void

at line 276
static void setResultFactory(callable $factory)

Set the factory that should be used to determine the lottery results.

Parameters

callable $factory

Return Value

void