Number
in package
implements
NumberExtension
FinalYes
Tags
Table of Contents
Interfaces
- NumberExtension
- An extension is the only way to add new functionality to Faker.
Methods
- numberBetween() : int
- Returns a random number between $int1 and $int2 (any order)
- randomDigit() : int
- Returns a random number between 0 and 9
- randomDigitNot() : int
- Generates a random digit, which cannot be $except
- randomDigitNotZero() : int
- Returns a random number between 1 and 9
- randomFloat() : float
- Return a random float number
- randomNumber() : int
- Returns a random integer with 0 to $nbDigits digits.
Methods
numberBetween()
Returns a random number between $int1 and $int2 (any order)
public
numberBetween([int $min = 0 ][, int $max = 2147483647 ]) : int
Parameters
- $min : int = 0
-
default to 0
- $max : int = 2147483647
-
defaults to 32 bit max integer, ie 2147483647
Return values
intrandomDigit()
Returns a random number between 0 and 9
public
randomDigit() : int
Return values
intrandomDigitNot()
Generates a random digit, which cannot be $except
public
randomDigitNot(int $except) : int
Parameters
- $except : int
Return values
intrandomDigitNotZero()
Returns a random number between 1 and 9
public
randomDigitNotZero() : int
Return values
intrandomFloat()
Return a random float number
public
randomFloat([int|null $nbMaxDecimals = null ][, float $min = 0 ][, float|null $max = null ]) : float
Parameters
- $nbMaxDecimals : int|null = null
- $min : float = 0
- $max : float|null = null
Return values
floatrandomNumber()
Returns a random integer with 0 to $nbDigits digits.
public
randomNumber([int $nbDigits = null ][, bool $strict = false ]) : int
The maximum value returned is mt_getrandmax()
Parameters
- $nbDigits : int = null
-
Defaults to a random number between 1 and 9
- $strict : bool = false
-
Whether the returned number should have exactly $nbDigits