Address
extends Address
in package
Table of Contents
- $addressFormats : mixed
- $buildingNumber : mixed
- $cityFormats : mixed
- $cityNames : mixed
- $citySuffix : mixed
- $country : mixed
- $generator : Generator
- $postcode : mixed
- $streetAddressFormats : mixed
- $streetNameFormats : mixed
- $streets : 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
- city() : string
- cityName() : 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.
- 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.
- street() : mixed
- streetAddress() : string
- streetName() : string
- 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
Properties
$addressFormats
protected
static mixed
$addressFormats
= ['{{streetAddress}}, {{postcode}} {{city}}']
$buildingNumber
protected
static mixed
$buildingNumber
= ['%#']
$cityFormats
protected
static mixed
$cityFormats
= ['{{cityName}}']
$cityNames
protected
static mixed
$cityNames
= ['Bakar', 'Beli Manastir', 'Belišće', 'Benkovac', 'Biograd na Moru', 'Bjelovar', 'Buje', 'Buzet', 'Cres', 'Crikvenica', 'Daruvar', 'Delnice', 'Dodatak:Imena europskih gradova na različitim jezicima', 'Donja Stubica', 'Donji Miholjac', 'Drniš', 'Dubrovnik', 'Duga Resa', 'Dugo Selo', 'Garešnica', 'Glina', 'Gospić', 'Grubišno Polje', 'Hrvatska Kostajnica', 'Hvar', 'Ilok', 'Imotski', 'Ivanec', 'Ivanić-Grad', 'Jastrebarsko', 'Karlovac', 'Kastav', 'Kaštela', 'Klanjec', 'Knin', 'Komiža', 'Koprivnica', 'Korčula', 'Kraljevica', 'Krapina', 'Križevci', 'Krk', 'Kutina', 'Kutjevo', 'Labin', 'Lepoglava', 'Lipik', 'Ludbreg', 'Makarska', 'Mali Lošinj', 'Metković', 'Mursko Središće', 'Našice', 'Nin', 'Nova Gradiška', 'Novalja', 'Novi Marof', 'Novi Vinodolski', 'Novigrad', 'Novska', 'Obrovac', 'Ogulin', 'Omiš', 'Opatija', 'Opuzen', 'Orahovica', 'Oroslavje', 'Osijek', 'Otok', 'Otočac', 'Ozalj', 'Pag', 'Pakrac', 'Pazin', 'Petrinja', 'Pleternica', 'Ploče', 'Popovača', 'Poreč', 'Požega', 'Pregrada', 'Prelog', 'Pula', 'Rab', 'Rijeka', 'Rovinj', 'Samobor', 'Senj', 'Sinj', 'Sisak', 'Skradin', 'Slatina', 'Slavonski Brod', 'Slunj', 'Solin', 'Split', 'Stari Grad', 'Supetar', 'Sveta Nedelja', 'Sveti Ivan Zelina', 'Trilj', 'Trogir', 'Umag', 'Valpovo', 'Varaždin', 'Varaždinske Toplice', 'Velika Gorica', 'Vinkovci', 'Virovitica', 'Vis', 'Vodice', 'Vodnjan', 'Vrbovec', 'Vrbovsko', 'Vrgorac', 'Vrlika', 'Vukovar', 'Zabok', 'Zadar', 'Zagreb', 'Zaprešić', 'Zlatar', 'Čabar', 'Čakovec', 'Čazma', 'Đakovo', 'Đurđevac', 'Šibenik', 'Županja']
Tags
$citySuffix
protected
static mixed
$citySuffix
= ['Ville']
$country
protected
static mixed
$country
= ['Andora', 'Ujedinjeni Arapski Emirati', 'Afganistan', 'Albanija', 'Armenija', 'Nizozemski Antili', 'Angola', 'Antarktika', 'Argentina', 'Američka Samoa', 'Austrija', 'Australija', 'Azerbejdžan', 'Bosna i Hercegovina', 'Barbados', 'Bangladeš', 'Belgija', 'Burkina Faso', 'Bugarska', 'Bahrein', 'Burundi', 'Benin', 'Bolivija', 'Brazil', 'Bjelorusija', 'Belize', 'Kanada', 'Švicarska', 'Obala Bjelokosti', 'Čile', 'Kamerun', 'Kina', 'Kolumbija', 'Kostarika', 'Srbija', 'Crna Gora', 'Kuba', 'Cipar', 'Češka', 'Njemačka', 'Danska', 'Dominikanska Republika', 'Alžir', 'Ekvador', 'Estonija', 'Egipat', 'Španjolska', 'Etiopija', 'Finska', 'Farski Otoci', 'Francuska', 'Ujedinjeno Kraljevstvo', 'Gruzija', 'Gana', 'Gibraltar', 'Gambija', 'Grčka', 'Gvatemala', 'Honduras', 'Hrvatska', 'Mađarska', 'Indonezija', 'Irska', 'Izrael', 'Irak', 'Iran', 'Island', 'Italija', 'Jamajka', 'Jordan', 'Japan', 'Sjeverna Koreja', 'Južna Koreja', 'Kuvajt', 'Kazahstan', 'Lihtenštajn', 'Šri Lanka', 'Luksemburg', 'Libija', 'Maroko', 'Moldavija', 'Makedonija', 'Mali', 'Malta', 'Meksiko', 'Malezija', 'Mozambik', 'Namibija', 'Nigerija', 'Nikaragva', 'Nizozemska', 'Norveška', 'Nepal', 'Novi Zeland', 'Oman', 'Panama', 'Peru', 'Pakistan', 'Poljska', 'Portugal', 'Paragvaj', 'Katar', 'Rumunjska', 'Rusija', 'Saudijska Arabija', 'Švedska', 'Singapur', 'Slovenija', 'Slovačka', 'San Marino', 'Senegal', 'Tajland', 'Turska', 'Trinidad i Tobago', 'Ukrajina', 'Sjedinjene Američke Države', 'Urugvaj', 'Uzbekistan']
Tags
$generator
protected
Generator
$generator
$postcode
protected
static mixed
$postcode
= ['#####']
$streetAddressFormats
protected
static mixed
$streetAddressFormats
= ['{{streetName}} {{buildingNumber}}']
$streetNameFormats
protected
static mixed
$streetNameFormats
= ['{{street}}']
$streets
protected
static mixed
$streets
= ['Baranjska ulica', 'Batina jug', 'Beljska ulica', 'Biljski sokak', 'Blatna ulica', 'Bračka ulica', 'Crkvena ulica', 'Daljok', 'Dravska ulica', 'Draž-planina', 'Dubrovačka ulica', 'Dunavska ulica', 'Glavna ulica', 'Grobljanska ulica', 'Jorgovanska ulica', 'Karanačka', 'Kenđija', 'Kod plota', 'Kolodvorska ulica', 'Komarčev prolaz', 'Konkološ', 'Kruševačka ulica', 'Lugarnica Šarkanj', 'Mirna ulica', 'Nova ulica', 'Osječka ulica', 'Partizanska ulica', 'Planina istok', 'Planina jug', 'Planina zapad', 'Planina', 'Planinska ulica', 'Popovačka ulica', 'Primoštenska ulica', 'Radnička ulica', 'Ribarska ulica', 'Ritska ulica', 'Salaši', 'Savska ulica', 'Slavonska ulica', 'Srednja ulica', 'Staklena ulica', 'Sunčana ulica', 'Trg Josipa bana Jelačića', 'Trg Slobode', 'Trg Stipe Đurina', 'Trg hrvatske mladeži', 'Ulica 1. svibnja', 'Ulica 30. svibnja', 'Ulica Adolfa Waldingera', 'Ulica Alojzija Stepinca', 'Ulica Ankice Dobrokes', 'Ulica Ante Kovačića', 'Ulica Ante Starčevića', 'Ulica Antuna Augustinčića', 'Ulica Antuna Gustava Matoša', 'Ulica Aranji Janoša', 'Ulica Augusta Cesarca', 'Ulica Augusta Šenoe', 'Ulica Bartoka Bele', 'Ulica Biljske satnije ZNH RH', 'Ulica Borisa Kidriča', 'Ulica Branka Gavelle', 'Ulica Branka Radičevića', 'Ulica Dore Pejačević', 'Ulica Dositeja Obradovića', 'Ulica Doža Đerđa', 'Ulica Dragutina Tadijanovića', 'Ulica Eugena Kvaternika', 'Ulica Eugena Savojskog', 'Ulica Frana Krste Frankopana', 'Ulica Franca Liszta', 'Ulica Franje Račkoga', 'Ulica Gustava Krkleca', 'Ulica Hrvatske vojske', 'Ulica Imre Nagya', 'Ulica Ivana Gorana Kovačića', 'Ulica Ivana Gundulića', 'Ulica Ivana Kozarca', 'Ulica Ivana Mažuranića', 'Ulica Ivana Meštrovića', 'Ulica Ivana Milutinovića', 'Ulica Ivane Brlić-Mažuranić', 'Ulica Ive Grgića', 'Ulica Ive Lole Ribara', 'Ulica Ive Petrušića', 'Ulica Izidora Kršnjavoga', 'Ulica Ištvana Vencela', 'Ulica Janka Draškovića', 'Ulica Janusa Pannoniusa', 'Ulica Jerka Zlatarića', 'Ulica Jokai Mora', 'Ulica Josipa Bösendorfera', 'Ulica Josipa Jurja Strossmayera', 'Ulica Josipa Kozarca', 'Ulica Josipa Kraša', 'Ulica Josipa Pančića', 'Ulica Josipa Runjanina', 'Ulica Jovana Jovanovića Zmaja', 'Ulica Jovana Lazića', 'Ulica Jozsefa Antala', 'Ulica Julija Benešića', 'Ulica Julija Klovića', 'Ulica Košut Lajoša', 'Ulica Lajoša Košuta', 'Ulica Lavoslava Ružičke', 'Ulica Ljudevita Gaja', 'Ulica Ljudevita Posavskog', 'Ulica Marije Jurić Zagorke', 'Ulica Marina Držića', 'Ulica Marka Marulića', 'Ulica Marka Oreškovića', 'Ulica Matije Antuna Relkovića', 'Ulica Matije Gupca', 'Ulica Matije Petra Katančića', 'Ulica Matka Peića', 'Ulica Mije Zlatarića', 'Ulica Miladina Popovića', 'Ulica Miroslava Krleže', 'Ulica Nikole Tesle', 'Ulica Obrada Ribića', 'Ulica Petefi Šandora', 'Ulica Petra Berislavića', 'Ulica Petra Dobrovića', 'Ulica Petra Drapšina', 'Ulica Petra Petrovića Njegoša', 'Ulica Petra Preradovića', 'Ulica Petra Zrinskog', 'Ulica Republike', 'Ulica Ruđera Boškovića', 'Ulica Sare Bertić', 'Ulica Silvija Strahimira Kranjčevića', 'Ulica Stipe Matovića', 'Ulica Stjepana Brodarića', 'Ulica Stjepana Radića', 'Ulica Stjepana Stjepanova', 'Ulica Svetozara Miletića', 'Ulica Tina Ujevića', 'Ulica Toldi Ferenca', 'Ulica Vasilja Gaćeše', 'Ulica Vatroslava Lisinskog', 'Ulica Vladana Desnice', 'Ulica Vladimira Filakovca', 'Ulica Vladimira Nazora', 'Ulica Vladimira Preloga', 'Ulica Vladka Mačeka', 'Ulica Vojina Bakića', 'Ulica Vuka Stefanovića Karadžića', 'Ulica Zvonka Brkića', 'Ulica bana Jelačića', 'Ulica bijelog lopoča', 'Ulica braće Radić', 'Ulica crne rode', 'Ulica domovinske zahvalnosti', 'Ulica dr Franje Tuđmana', 'Ulica dr. Ante Starčevića', 'Ulica dr. Franje Tuđmana', 'Ulica dr. Kamila Firingera', 'Ulica hrvatskih branitelja', 'Ulica kardinala Franje Šefera', 'Ulica kneza Branimira', 'Ulica kneza Domagoja', 'Ulica kneza Trpimira', 'Ulica kralja Krešimira', 'Ulica kralja Petra Krešimira IV', 'Ulica kralja Tomislava', 'Ulica kralja Zvonimira', 'Ulica republike', 'Ulica svetog Ivana Nepomuka', 'Ulica svetog Martina', 'Ulica svetog križa', 'Ulica Đure Đakovića', 'Ulica Šandora Petefija', 'Ulica Šovakova', 'Ulica športova', 'Ulica Žarka Zrenjanina', 'Ulica Žikice Jovanovića Španca', 'Ulica žrtava domovinskog rata', 'Vatrogasna ulica', 'Velebitska ulica', 'Vijenac Nikole Tesle', 'Vinogradska ulica', 'Virska ulica', 'Vukovarska ulica', 'Zagrebačka ulica', 'Šećeranska ulica', 'Školska ulica']
Tags
$streetSuffix
protected
static mixed
$streetSuffix
= ['Street']
$unique
protected
UniqueGenerator
$unique
Methods
__construct()
public
__construct(Generator $generator) : mixed
Parameters
- $generator : Generator
Return values
mixed —address()
public
address() : string
Tags
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
Tags
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
Tags
Return values
string —city()
public
city() : string
Tags
Return values
string —cityName()
public
cityName() : mixed
Return values
mixed —citySuffix()
public
static citySuffix() : string
Tags
Return values
string —country()
public
static country() : string
Tags
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
Tags
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>
Tags
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
Tags
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
Tags
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
Tags
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
Tags
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
Tags
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
Tags
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)
Tags
Return values
string —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
Tags
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
Tags
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)
Tags
Return values
string —The shuffled set
street()
public
static street() : mixed
Return values
mixed —streetAddress()
public
streetAddress() : string
Tags
Return values
string —streetName()
public
streetName() : string
Tags
Return values
string —streetSuffix()
public
static streetSuffix() : string
Tags
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.
Tags
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.
Tags
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'