Faker\Provider\Base Class Reference

Inheritance diagram for Faker\Provider\Base:

Public Member Functions
	__construct (Generator $generator)
	optional ($weight=0.5, $default=null)
	unique ($reset=false, $maxRetries=10000)
	valid ($validator=null, $maxRetries=10000)

Static Public Member Functions
static	randomDigit ()
static	randomDigitNotNull ()
static	randomDigitNot ($except)
static	randomNumber ($nbDigits=null, $strict=false)
static	randomFloat ($nbMaxDecimals=null, $min=0, $max=null)
static	numberBetween ($int1=0, $int2=2147483647)
static	passthrough ($value)
static	randomLetter ()
static	randomAscii ()
static	randomElements ($array=array('a', 'b', 'c'), $count=1, $allowDuplicates=false)
static	randomElement ($array=array('a', 'b', 'c'))
static	randomKey ($array=array())
static	shuffle ($arg='')
static	shuffleArray ($array=array())
static	shuffleString ($string='', $encoding='UTF-8')
static	numerify ($string='###')
static	lexify ($string='????')
static	bothify ($string='## ??')
static	asciify ($string=' ****')
static	regexify ($regex='')
static	toLower ($string='')
static	toUpper ($string='')

Protected Attributes
	$generator
	$unique

Constructor & Destructor Documentation

__construct()

Faker\Provider\Base::__construct

(

Generator

$generator

)

Parameters

\Faker\Generator

$generator

Reimplemented in Faker\Provider\HtmlLorem.

Member Function Documentation

bothify()

static Faker\Provider\Base::bothify (   $string = '## ??' )

static

Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter

Parameters

string

$string

String that needs to bet parsed

Returns

string

lexify()

static Faker\Provider\Base::lexify (   $string = '????' )

static

Replaces all question mark ('?') occurrences with a random letter

Parameters

string

$string

String that needs to bet parsed

Returns

string

numerify()

static Faker\Provider\Base::numerify (   $string = '###' )

static

Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('') occurrences with a not null number

Parameters

string

$string

String that needs to bet parsed

Returns

string

optional()

Faker\Provider\Base::optional	(		$weight = 0.5,
			$default = null
	)

Chainable method for making any formatter optional.

Parameters

float | integer

$weight

Set the probability of receiving a null value. "0" will always return null, "1" will always return the generator. If $weight is an integer value, then the same system works between 0 (always get false) and 100 (always get true).

Returns

mixed|null

passthrough()

static Faker\Provider\Base::passthrough (   $value )

static

Returns the passed value

Parameters

mixed

$value

Returns

mixed

randomAscii()

static Faker\Provider\Base::randomAscii ( )

static

Returns a random ASCII character (excluding accents and special chars)

randomDigit()

static Faker\Provider\Base::randomDigit ( )

static

Returns a random number between 0 and 9

Returns

integer

randomDigitNot()

static Faker\Provider\Base::randomDigitNot (   $except )

static

Generates a random digit, which cannot be $except

Parameters

int

$except

Returns

int

randomDigitNotNull()

static Faker\Provider\Base::randomDigitNotNull ( )

static

Returns a random number between 1 and 9

Returns

integer

randomElement()

static Faker\Provider\Base::randomElement (   $array = array('a', 'b', 'c') )

static

Returns a random element from a passed array

Parameters

array

$array

Returns

mixed

randomElements()

static Faker\Provider\Base::randomElements (   $array = array('a', 'b', 'c'),   $count = 1,   $allowDuplicates = false  )

static

Returns randomly ordered subsequence of $count elements from a provided array

Parameters

array	$array	Array to take elements from. Defaults to a-c
integer	$count	Number of elements to take.
boolean	$allowDuplicates	Allow elements to be picked several times. Defaults to false

Exceptions

randomKey()

static Faker\Provider\Base::randomKey (   $array = array() )

static

Returns a random key from a passed associative array

Parameters

array

$array

Returns

int|string|null

randomLetter()

static Faker\Provider\Base::randomLetter ( )

static

Returns a random letter from a to z

Returns

string

toLower()

static Faker\Provider\Base::toLower (   $string = '' )

static

Converts string to lowercase. Uses mb_string extension if available.

Parameters

string

$string

String that should be converted to lowercase

Returns

string

toUpper()

static Faker\Provider\Base::toUpper (   $string = '' )

static

Converts string to uppercase. Uses mb_string extension if available.

Parameters

string

$string

String that should be converted to uppercase

Returns

string

unique()

Faker\Provider\Base::unique	(		$reset = false,
			$maxRetries = 10000
	)

Chainable method for making any formatter unique.

// will never return twice the same value $faker->unique()->randomElement(array(1, 2, 3));

Parameters

boolean	$reset	If set to true, resets the list of existing values
integer	$maxRetries	Maximum number of retries to find a unique value, After which an OverflowException is thrown.

Exceptions

valid()

Faker\Provider\Base::valid	(		$validator = null,
			$maxRetries = 10000
	)

Chainable method for forcing any formatter to return only valid values.

The value validity is determined by a function passed as first argument.

$values = array(); $evenValidator = function ($digit) { return $digit % 2 === 0; }; for ($i=0; $i < 10; $i++) { $values []= $faker->valid($evenValidator)->randomDigit; } print_r($values); // [0, 4, 8, 4, 2, 6, 0, 8, 8, 6]

Parameters

Closure	$validator	A function returning true for valid values
integer	$maxRetries	Maximum number of retries to find a unique value, After which an OverflowException is thrown.

Exceptions

---

The documentation for this class was generated from the following file:

• vendor/fzaninotto/faker/src/Faker/Provider/Base.php