Documentation

Address extends Address
in package

Application

$addressFormats : mixed
$buildingNumber : mixed
$canton : mixed
$cityFormats : mixed
$cityNames : mixed
$cityPrefix : mixed
$citySuffix : mixed
$country : mixed
$generator : Generator
$postcode : mixed
$secondaryAddressFormats : mixed
$state : mixed
$stateAbbr : mixed
$streetAddressFormats : mixed
$streetNameFormats : mixed
$streetPrefix : mixed
$streetSuffix : mixed
$unique : UniqueGenerator
__construct() : mixed
address() : string
asciify() : string: Replaces * signs with random numbers and letters and special characters
bothify() : string: Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter
buildingNumber() : string
canton() : array<string|int, mixed>: Returns a canton
cantonName() : string: Returns the name of canton.
cantonShort() : string: Returns the abbreviation of a canton.
city() : string
cityName() : string: Returns a random city name.
cityPrefix() : mixed
citySuffix() : string
country() : string
latitude() : float: Uses signed degrees format (returns a float number between -90 and 90)
lexify() : string: Replaces all question mark ('?') occurrences with a random letter
localCoordinates() : array<string|int, float>
longitude() : float: Uses signed degrees format (returns a float number between -180 and 180)
numberBetween() : int: Returns a random number between $int1 and $int2 (any order)
numerify() : string: Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('%') occurrences with a not null number
optional() : mixed|null: Chainable method for making any formatter optional.
passthrough() : mixed: Returns the passed value
postcode() : string
randomAscii() : string: Returns a random ASCII character (excluding accents and special chars)
randomDigit() : int: Returns a random number between 0 and 9
randomDigitNot() : int: Generates a random digit, which cannot be $except
randomDigitNotNull() : int: Returns a random number between 1 and 9
randomElement() : mixed: Returns a random element from a passed array
randomElements() : array<string|int, mixed>: Returns randomly ordered subsequence of $count elements from a provided array
randomFloat() : float: Return a random float number
randomKey() : int|string|null: Returns a random key from a passed associative array
randomLetter() : string: Returns a random letter from a to z
randomNumber() : int: Returns a random integer with 0 to $nbDigits digits.
regexify() : string: Transforms a basic regular expression into a random string satisfying the expression.
secondaryAddress() : mixed
shuffle() : array<string|int, mixed>|string: Returns a shuffled version of the argument.
shuffleArray() : array<string|int, mixed>: Returns a shuffled version of the array.
shuffleString() : string: Returns a shuffled version of the string.
state() : mixed
stateAbbr() : mixed
streetAddress() : string
streetName() : string
streetPrefix() : string: Returns a random street prefix
streetSuffix() : string
toLower() : string: Converts string to lowercase.
toUpper() : string: Converts string to uppercase.
unique() : UniqueGenerator: Chainable method for making any formatter unique.
valid() : ValidGenerator: Chainable method for forcing any formatter to return only valid values.
replaceWildcard() : mixed

$addressFormats


    protected
    static    mixed
    $addressFormats
     = ["{{streetAddress}}
{{postcode}} {{city}}"]

$buildingNumber


    protected
    static    mixed
    $buildingNumber
     = ['%##', '%#', '%', '#a', '#b', '#c']

$canton


    protected
    static    mixed
    $canton
     = [['AG' => 'Argovia'], ['AI' => 'Appenzello Interno'], ['AR' => 'Appenzello Esterno'], ['BE' => 'Berna'], ['BL' => 'Basilea Campagna'], ['BS' => 'Basilea Città'], ['FR' => 'Friburgo'], ['GE' => 'Ginevra'], ['GL' => 'Glarona'], ['GR' => 'Grigioni'], ['JU' => 'Giura'], ['LU' => 'Lucerna'], ['NE' => 'Neuchâtel'], ['NW' => 'Nidvaldo'], ['OW' => 'Obvaldo'], ['SG' => 'San Gallo'], ['SH' => 'Sciaffusa'], ['SO' => 'Soletta'], ['SZ' => 'Svitto'], ['TG' => 'Turgovia'], ['TI' => 'Ticino'], ['UR' => 'Uri'], ['VD' => 'Vaud'], ['VS' => 'Vallese'], ['ZG' => 'Zugo'], ['ZH' => 'Zurigo']]

$cityFormats


    protected
    static    mixed
    $cityFormats
     = ['{{cityName}}']

$cityNames


    protected
    static    mixed
    $cityNames
     = ['Aarau', 'Adliswil', 'Aesch', 'Affoltern am Albis', 'Allschwil', 'Altstätten', 'Amriswil', 'Arbon', 'Arth', 'Baar', 'Baden', 'Basilea', 'Bassersdorf', 'Bellinzona', 'Belp', 'Berna', 'Bienne', 'Binningen', 'Birsfelden', 'Briga-Glis', 'Brugg', 'Buchs', 'Bulle', 'Burgdorf', 'Bülach', 'Carouge', 'Cham', 'Chêne-Bougeries', 'Coira', 'Davos', 'Delémont', 'Dietikon', 'Dübendorf', 'Ebikon', 'Ecublens', 'Einsiedeln', 'Emmen', 'Frauenfeld', 'Freienbach', 'Friburgo', 'Ginevra', 'Gland', 'Gossau', 'Grenchen', 'Herisau', 'Hinwil', 'Horgen', 'Horw', 'Illnau-Effretikon', 'Ittigen', 'Kloten', 'Kreuzlingen', 'Kriens', 'Köniz', 'Küsnacht', 'Küssnacht', 'La Chaux-de-Fonds', 'La Tour-de-Peilz', 'Lancy', 'Langenthal', 'Le Grand-Saconnex', 'Le Locle', 'Liestal', 'Locarno', 'Losanna', 'Lucerna', 'Lugano', 'Lyss', 'Martigny', 'Meilen', 'Mendrisio', 'Meyrin', 'Monthey', 'Montreux', 'Morges', 'Muri bei Bern', 'Muttenz', 'Männedorf', 'Möhlin', 'Münchenstein', 'Münsingen', 'Neuchâtel', 'Neuhausen am Rheinfall', 'Nyon', 'Oberwil', 'Oftringen', 'Olten', 'Onex', 'Opfikon', 'Ostermundigen', 'Pfäffikon', 'Pratteln', 'Prilly', 'Pully', 'Rapperswil-Jona', 'Regensdorf', 'Reinach', 'Renens', 'Rheinfelden', 'Richterswil', 'Riehen', 'Rüti', 'San Gallo', 'Schlieren', 'Sciaffusa', 'Sierre', 'Sion', 'Soletta', 'Spiez', 'Spreitenbach', 'Steffisburg', 'Stäfa', 'Svitto', 'Thalwil', 'Thun', 'Thônex', 'Uster', 'Uzwil', 'Val-de-Travers', 'Vernier', 'Versoix', 'Vevey', 'Veyrier', 'Villars-sur-Glâne', 'Volketswil', 'Wallisellen', 'Weinfelden', 'Wettingen', 'Wetzikon', 'Wil', 'Winterthur', 'Wohlen', 'Worb', 'Wädenswil', 'Yverdon-les-Bains', 'Zofingen', 'Zollikon', 'Zugo', 'Zurigo']

$cityPrefix


    protected
    static    mixed
    $cityPrefix
     = ['San', 'Borgo', 'Sesto', 'Quarto', 'Settimo']

$citySuffix


    protected
    static    mixed
    $citySuffix
     = ['Ville']

$country


    protected
    static    mixed
    $country
     = []

$generator


    protected
        Generator
    $generator

$postcode


    protected
    static    mixed
    $postcode
     = ['####']

$secondaryAddressFormats


    protected
    static    mixed
    $secondaryAddressFormats
     = ['Appartamento ##', 'Piano #']

$state


    protected
    static    mixed
    $state
     = ['Agrigento', 'Alessandria', 'Ancona', 'Aosta', 'Arezzo', 'Ascoli Piceno', 'Asti', 'Avellino', 'Bari', 'Barletta-Andria-Trani', 'Belluno', 'Benevento', 'Bergamo', 'Biella', 'Bologna', 'Bolzano', 'Brescia', 'Brindisi', 'Cagliari', 'Caltanissetta', 'Campobasso', 'Carbonia-Iglesias', 'Caserta', 'Catania', 'Catanzaro', 'Chieti', 'Como', 'Cosenza', 'Cremona', 'Crotone', 'Cuneo', 'Enna', 'Fermo', 'Ferrara', 'Firenze', 'Foggia', 'Forlì-Cesena', 'Frosinone', 'Genova', 'Gorizia', 'Grosseto', 'Imperia', 'Isernia', 'La Spezia', 'L'Aquila', 'Latina', 'Lecce', 'Lecco', 'Livorno', 'Lodi', 'Lucca', 'Macerata', 'Mantova', 'Massa-Carrara', 'Matera', 'Messina', 'Milano', 'Modena', 'Monza e della Brianza', 'Napoli', 'Novara', 'Nuoro', 'Olbia-Tempio', 'Oristano', 'Padova', 'Palermo', 'Parma', 'Pavia', 'Perugia', 'Pesaro e Urbino', 'Pescara', 'Piacenza', 'Pisa', 'Pistoia', 'Pordenone', 'Potenza', 'Prato', 'Ragusa', 'Ravenna', 'Reggio Calabria', 'Reggio Emilia', 'Rieti', 'Rimini', 'Roma', 'Rovigo', 'Salerno', 'Medio Campidano', 'Sassari', 'Savona', 'Siena', 'Siracusa', 'Sondrio', 'Taranto', 'Teramo', 'Terni', 'Torino', 'Ogliastra', 'Trapani', 'Trento', 'Treviso', 'Trieste', 'Udine', 'Varese', 'Venezia', 'Verbano-Cusio-Ossola', 'Vercelli', 'Verona', 'Vibo Valentia', 'Vicenza', 'Viterbo']

$stateAbbr


    protected
    static    mixed
    $stateAbbr
     = ['AG', 'AL', 'AN', 'AO', 'AR', 'AP', 'AT', 'AV', 'BA', 'BT', 'BL', 'BN', 'BG', 'BI', 'BO', 'BZ', 'BS', 'BR', 'CA', 'CL', 'CB', 'CI', 'CE', 'CT', 'CZ', 'CH', 'CO', 'CS', 'CR', 'KR', 'CN', 'EN', 'FM', 'FE', 'FI', 'FG', 'FC', 'FR', 'GE', 'GO', 'GR', 'IM', 'IS', 'SP', 'AQ', 'LT', 'LE', 'LC', 'LI', 'LO', 'LU', 'MC', 'MN', 'MS', 'MT', 'ME', 'MI', 'MO', 'MB', 'NA', 'NO', 'NU', 'OT', 'OR', 'PD', 'PA', 'PR', 'PV', 'PG', 'PU', 'PE', 'PC', 'PI', 'PT', 'PN', 'PZ', 'PO', 'RG', 'RA', 'RC', 'RE', 'RI', 'RN', 'RM', 'RO', 'SA', 'VS', 'SS', 'SV', 'SI', 'SR', 'SO', 'TA', 'TE', 'TR', 'TO', 'OG', 'TP', 'TN', 'TV', 'TS', 'UD', 'VA', 'VE', 'VB', 'VC', 'VR', 'VV', 'VI', 'VT']

$streetAddressFormats


    protected
    static    mixed
    $streetAddressFormats
     = ['{{streetName}} {{buildingNumber}}']

$streetNameFormats


    protected
    static    mixed
    $streetNameFormats
     = ['{{streetSuffix}} {{firstName}}', '{{streetSuffix}} {{lastName}}']

$streetPrefix


    protected
    static    mixed
    $streetPrefix
     = ['Piazza', 'Strada', 'Via', 'Borgo', 'Contrada', 'Rotonda', 'Incrocio']

$streetSuffix


    protected
    static    mixed
    $streetSuffix
     = ['Street']

$unique


    protected
        UniqueGenerator
    $unique

__construct()


    public
                __construct(Generator $generator) : mixed

Parameters

$generator : Generator

Return values

mixed —

address()


    public
                address() : string

Return values

string —

asciify()

Replaces * signs with random numbers and letters and special characters


    public
            static    asciify([string $string = '****' ]) : string

Parameters

$string : string = '****': String that needs to bet parsed

Return values

string —

bothify()

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


    public
            static    bothify([string $string = '## ??' ]) : string

Parameters

$string : string = '## ??': String that needs to bet parsed

Return values

string —

buildingNumber()


    public
            static    buildingNumber() : string

Return values

string —

canton()

Returns a canton


    public
            static    canton() : array<string|int, mixed>

Return values

array<string|int, mixed> —

cantonName()

Returns the name of canton.


    public
            static    cantonName() : string

Return values

string —

cantonShort()

Returns the abbreviation of a canton.


    public
            static    cantonShort() : string

Return values

string —

city()


    public
                city() : string

Return values

string —

cityName()

Returns a random city name.


    public
                cityName() : string

Return values

string —

cityPrefix()


    public
            static    cityPrefix() : mixed

Return values

mixed —

citySuffix()


    public
            static    citySuffix() : string

Return values

string —

country()


    public
            static    country() : string

Return values

string —

latitude()

Uses signed degrees format (returns a float number between -90 and 90)


    public
            static    latitude([float|int $min = -90 ][, float|int $max = 90 ]) : float

Parameters

$min : float|int = -90
$max : float|int = 90

Return values

float —

lexify()

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


    public
            static    lexify([string $string = '????' ]) : string

Parameters

$string : string = '????': String that needs to bet parsed

Return values

string —

localCoordinates()


    public
            static    localCoordinates() : array<string|int, float>

Return values

array<string|int, float> —

longitude()

Uses signed degrees format (returns a float number between -180 and 180)


    public
            static    longitude([float|int $min = -180 ][, float|int $max = 180 ]) : float

Parameters

$min : float|int = -180
$max : float|int = 180

Return values

float —

numberBetween()

Returns a random number between $int1 and $int2 (any order)


    public
            static    numberBetween(int $int1[, int $int2 = 2147483647 ]) : int

Parameters

$int1 : int: default to 0
$int2 : int = 2147483647: defaults to 32 bit max integer, ie 2147483647

Return values

int —

numerify()

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


    public
            static    numerify([string $string = '###' ]) : string

Parameters

$string : string = '###': String that needs to bet parsed

Return values

string —

optional()

Chainable method for making any formatter optional.


    public
                optional([float|int $weight = 0.5 ][, mixed $default = null ]) : mixed|null

Parameters

$weight : float|int = 0.5: 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).
$default : mixed = null

Return values

mixed|null —

passthrough()

Returns the passed value


    public
            static    passthrough(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

postcode()


    public
            static    postcode() : string

Return values

string —

randomAscii()

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


    public
            static    randomAscii() : string

Return values

string —

randomDigit()

Returns a random number between 0 and 9


    public
            static    randomDigit() : int

Return values

int —

randomDigitNot()

Generates a random digit, which cannot be $except


    public
            static    randomDigitNot(int $except) : int

Parameters

$except : int

Return values

int —

randomDigitNotNull()

Returns a random number between 1 and 9


    public
            static    randomDigitNotNull() : int

Return values

int —

randomElement()

Returns a random element from a passed array


    public
            static    randomElement([array<string|int, mixed> $array = ['a', 'b', 'c'] ]) : mixed

Parameters

$array : array<string|int, mixed> = ['a', 'b', 'c']

Return values

mixed —

randomElements()

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


    public
            static    randomElements([array<string|int, mixed> $array = ['a', 'b', 'c'] ][, int $count = 1 ][, bool $allowDuplicates = false ]) : array<string|int, mixed>

Parameters

$array : array<string|int, mixed> = ['a', 'b', 'c']: Array to take elements from. Defaults to a-c
$count : int = 1: Number of elements to take.
$allowDuplicates : bool = false: Allow elements to be picked several times. Defaults to false

Return values

array<string|int, mixed> —

New array with $count elements from $array

randomFloat()

Return a random float number


    public
            static    randomFloat([int $nbMaxDecimals = null ], float|int $min[, float|int $max = null ]) : float

Parameters

$nbMaxDecimals : int = null
$min : float|int
$max : float|int = null

Return values

float —

randomKey()

Returns a random key from a passed associative array


    public
            static    randomKey([array<string|int, mixed> $array = [] ]) : int|string|null

Parameters

$array : array<string|int, mixed> = []

Return values

int|string|null —

randomLetter()

Returns a random letter from a to z


    public
            static    randomLetter() : string

Return values

string —

randomNumber()

Returns a random integer with 0 to $nbDigits digits.


    public
            static    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

Return values

int —

regexify()

Transforms a basic regular expression into a random string satisfying the expression.


    public
            static    regexify([string $regex = '' ]) : string

Parameters

$regex : string = '': A regular expression (delimiters are optional)

Return values

string —

secondaryAddress()


    public
            static    secondaryAddress() : mixed

Return values

mixed —

shuffle()

Returns a shuffled version of the argument.


    public
            static    shuffle([array<string|int, mixed>|string $arg = '' ]) : array<string|int, mixed>|string

This function accepts either an array, or a string.

Parameters

$arg : array<string|int, mixed>|string = '': The set to shuffle

Return values

array<string|int, mixed>|string —

The shuffled set

shuffleArray()

Returns a shuffled version of the array.


    public
            static    shuffleArray([array<string|int, mixed> $array = [] ]) : array<string|int, mixed>

This function does not mutate the original array. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable.

Parameters

$array : array<string|int, mixed> = []: The set to shuffle

Return values

array<string|int, mixed> —

The shuffled set

shuffleString()

Returns a shuffled version of the string.


    public
            static    shuffleString([string $string = '' ][, string $encoding = 'UTF-8' ]) : string

This function does not mutate the original string. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable. Additionally, it is UTF8 safe if the mb extension is available.

Parameters

$string : string = '': The set to shuffle
$encoding : string = 'UTF-8': The string encoding (defaults to UTF-8)

Return values

string —

The shuffled set

state()


    public
            static    state() : mixed

Return values

mixed —

stateAbbr()


    public
            static    stateAbbr() : mixed

Return values

mixed —

streetAddress()


    public
                streetAddress() : string

Return values

string —

streetName()


    public
                streetName() : string

Return values

string —

streetPrefix()

Returns a random street prefix


    public
            static    streetPrefix() : string

Return values

string —

streetSuffix()


    public
            static    streetSuffix() : string

Return values

string —

toLower()

Converts string to lowercase.


    public
            static    toLower([string $string = '' ]) : string

Uses mb_string extension if available.

Parameters

$string : string = '': String that should be converted to lowercase

Return values

string —

toUpper()

Converts string to uppercase.


    public
            static    toUpper([string $string = '' ]) : string

Uses mb_string extension if available.

Parameters

$string : string = '': String that should be converted to uppercase

Return values

string —

unique()

Chainable method for making any formatter unique.


    public
                unique([bool $reset = false ][, int $maxRetries = 10000 ]) : UniqueGenerator


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

Parameters

$reset : bool = false: If set to true, resets the list of existing values
$maxRetries : int = 10000: Maximum number of retries to find a unique value, After which an OverflowException is thrown.

Return values

UniqueGenerator —

A proxy class returning only non-existing values

valid()

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


    public
                valid([Closure $validator = null ][, int $maxRetries = 10000 ]) : ValidGenerator

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

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

Return values

ValidGenerator —

A proxy class returning only valid values

replaceWildcard()


    private
            static    replaceWildcard(mixed $string[, mixed $wildcard = '#' ][, mixed $callback = 'static::randomDigit' ]) : mixed

Parameters

$string : mixed
$wildcard : mixed = '#'
$callback : mixed = 'static::randomDigit'

Return values

mixed —

Address extends Address in package Application

Table of Contents

Properties

$addressFormats

$buildingNumber

$canton

Tags

$cityFormats

$cityNames

Tags

$cityPrefix

$citySuffix

$country

$generator

$postcode

$secondaryAddressFormats

$state

$stateAbbr

$streetAddressFormats

$streetNameFormats

$streetPrefix

$streetSuffix

$unique

Methods

__construct()

Parameters

Return values

address()

Tags

Return values

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

buildingNumber()

Tags

Return values

canton()

Tags

Return values

cantonName()

Return values

cantonShort()

Return values

city()

Tags

Return values

cityName()

Tags

Return values

cityPrefix()

Tags

Return values

citySuffix()

Tags

Return values

country()

Tags

Return values

latitude()

Parameters

Tags

Return values

lexify()

Parameters

Return values

localCoordinates()

Tags

Return values

longitude()

Parameters

Tags

Return values

numberBetween()

Parameters

Tags

Return values

Address extends Address
in package

Application