Address
extends Address
in package
Table of Contents
- $addressFormats : mixed
- $buildingNumber : mixed
- $cityFormats : mixed
- $cityPrefix : mixed
- $citySuffix : mixed
- The suffixes come from this list of communities in Québec http://fr.wikipedia.org/wiki/Liste_des_municipalités_locales_du_Québec
- $country : mixed
- $generator : Generator
- $postcode : mixed
- $secondaryAddressFormats : mixed
- $state : mixed
- $stateAbbr : mixed
- $streetAddressFormats : mixed
- $streetNameFormats : mixed
- $streetPrefix : mixed
- $streetSuffix : mixed
- $unique : UniqueGenerator
- $departments : mixed
- $regions : mixed
- __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
- cityPrefix() : mixed
- citySuffix() : mixed
- country() : string
- department() : array<string|int, mixed>
- Randomly returns a french department ('departmentNumber' => 'departmentName').
- departmentName() : string
- Randomly returns a french department name.
- departmentNumber() : string
- Randomly returns a french department number.
- 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.
- region() : string
- Randomly returns a french region.
- 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() : mixed
- 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}}, {{city}}, {{stateAbbr}} {{postcode}}']
$buildingNumber
protected
static mixed
$buildingNumber
= ['%####', '%###', '%##', '%#', '%']
$cityFormats
protected
static mixed
$cityFormats
= ['{{cityPrefix}}{{firstName}}{{citySuffix}}', '{{cityPrefix}}{{firstName}}']
Tags
$cityPrefix
protected
static mixed
$cityPrefix
= ['Saint-', 'Sainte-', 'St-', 'Ste-']
$citySuffix
The suffixes come from this list of communities in Québec http://fr.wikipedia.org/wiki/Liste_des_municipalités_locales_du_Québec
protected
static mixed
$citySuffix
= [
// Bas-Saint-Laurent
'-des-Sables',
'-sur-Mer',
'-des-Neiges',
'-des-Sept-Douleurs',
'-du-Portage',
'-du-Loup',
'-des-Lacs',
'-de-Lessard',
'-de-Kamourasca',
'-de-Témiscouata',
'-de-Ladrière',
'-de-Rimouski',
'-de-Rivière-du-Loup',
'-du-Lac',
'-du-Ha! Ha!',
'-du-Lac-Long',
'-de-Rioux',
'-du-Squatec',
'-de-Métis',
'-d'Ixworth',
'-de-la-Croix',
'-de-Matane',
'-du-Lac-Humqui',
'-de-Mérici',
'-de-la-Pocatière',
'-sur-le-Lac',
// Saguenay–Lac-Saint-Jean
'-de-Lorette',
'-du-Lac-Saint-Jean',
'-de-Bourget',
'-de-Falardeau',
'-les-Plaines',
'-de-Sales',
'-de-Taillon',
'-de-Milot',
'-du-Nord',
// Québec (Capitale-Nationale)
'-aux-Coudres',
'-des-Anges',
'-de-Desmaures',
'-les-Neiges',
'-de-l'Île-d'Orléans',
'-de-Valcartier',
'-de-Portneuf',
'-du-Cap-Tourmente',
'-des-Carrières',
'-des-Caps',
'-de-Beaupré',
'-de-Laval',
'-de-la-Jacques-Cartier',
'-d'Auvergne',
// Mauricie
'-de-Monteauban',
'-du-Mont-Carmel',
'-des-Monts',
'-de-Maskinongé',
'-de-Caxton',
'-des-Grès',
'-le-Grand',
'-de-Vincennes',
'-du-Parc',
'-de-Champlain',
'-de-Mékinac',
'-de-Prémont',
'-de-la-Pérade',
'-de-Batiscan',
// Estrie (Cantons de l'est)
'-Ouest',
'-Est',
'-Sud',
'-Nord',
'-des-Bois',
'-de-Woburn',
'-de-Brompton',
'-de-Bolton',
'-de-Windsor',
'-de-Clifton',
'-de-Paquette',
'-de-la-Rochelle',
'-de-Hatley',
'-de-Whitton',
// Montréal
'-de-Bellevue',
// Chaudière-Appalaches
'-de-Buckland',
'-des-Pins',
'-du-Rosaire',
'-d'Issoudun',
'-de-Jésus',
'-d'Irlande',
'-de-l'Isle-aux-Grues',
'-de-Tilly',
'-de-Lellis',
'-de-Bellechasse',
'-de-Lessard',
'-de-L'Islet',
'-de-Lotbinière',
'-de-Beauce',
'-de-Forsyth',
'-de-Panet',
'-de-la-Rivière-du-Sud',
'-de-Dorset',
'-de-Shenley',
'-de-Leeds',
'-de-Wolfestown',
'-de-Joly',
'-de-Brébeuf',
'-de-Coleraine',
'-des-Érables',
'-Bretenières',
'-de-Lauzon',
'-de-Standon',
'-de-Gonzague',
'-de-Beaurivage',
'-de-Dorchester',
'-de-Cranbourne',
'-de-Broughton',
'-de-la-Rivière-du-Sud',
'-des-Aulnaies',
'-les-Mines',
'-de-Lotbinière',
'-de-Patton',
'-sur-Rivière-du-Sud',
'-de-Beauregard',
'-de-Watford',
]
$country
protected
static mixed
$country
= []
$generator
protected
Generator
$generator
$postcode
protected
static mixed
$postcode
= ['?#? #?#', '?#?#?#']
$secondaryAddressFormats
protected
static mixed
$secondaryAddressFormats
= ['Apt. ###', 'Suite ###', 'Bureau ###']
$state
protected
static mixed
$state
= ['Alberta', 'Colombie-Britannique', 'Manitoba', 'Nouveau-Brunswick', 'Terre-Neuve-et-Labrador', 'Nouvelle-Écosse', 'Ontario', 'Île-du-Prince-Édouard', 'Québec', 'Saskatchewan']
$stateAbbr
protected
static mixed
$stateAbbr
= ['AB', 'BC', 'MB', 'NB', 'NL', 'NS', 'ON', 'PE', 'QC', 'SK']
$streetAddressFormats
protected
static mixed
$streetAddressFormats
= ['{{buildingNumber}} {{streetName}}', '{{buildingNumber}} {{streetName}} {{secondaryAddress}}']
$streetNameFormats
protected
static mixed
$streetNameFormats
= ['{{streetSuffix}} {{firstName}}', '{{streetSuffix}} {{lastName}}']
Tags
$streetPrefix
protected
static mixed
$streetPrefix
= ['rue', 'rue', 'chemin', 'avenue', 'boulevard', 'place', 'impasse']
$streetSuffix
protected
static mixed
$streetSuffix
= ['Autoroute', 'Avenue', 'Boulevard', 'Chemin', 'Route', 'Rue', 'Pont']
$unique
protected
UniqueGenerator
$unique
$departments
private
static mixed
$departments
= [['01' => 'Ain'], ['02' => 'Aisne'], ['03' => 'Allier'], ['04' => 'Alpes-de-Haute-Provence'], ['05' => 'Hautes-Alpes'], ['06' => 'Alpes-Maritimes'], ['07' => 'Ardèche'], ['08' => 'Ardennes'], ['09' => 'Ariège'], ['10' => 'Aube'], ['11' => 'Aude'], ['12' => 'Aveyron'], ['13' => 'Bouches-du-Rhône'], ['14' => 'Calvados'], ['15' => 'Cantal'], ['16' => 'Charente'], ['17' => 'Charente-Maritime'], ['18' => 'Cher'], ['19' => 'Corrèze'], ['2A' => 'Corse-du-Sud'], ['2B' => 'Haute-Corse'], ['21' => "Côte-d'Or"], ['22' => "Côtes-d'Armor"], ['23' => 'Creuse'], ['24' => 'Dordogne'], ['25' => 'Doubs'], ['26' => 'Drôme'], ['27' => 'Eure'], ['28' => 'Eure-et-Loir'], ['29' => 'Finistère'], ['30' => 'Gard'], ['31' => 'Haute-Garonne'], ['32' => 'Gers'], ['33' => 'Gironde'], ['34' => 'Hérault'], ['35' => 'Ille-et-Vilaine'], ['36' => 'Indre'], ['37' => 'Indre-et-Loire'], ['38' => 'Isère'], ['39' => 'Jura'], ['40' => 'Landes'], ['41' => 'Loir-et-Cher'], ['42' => 'Loire'], ['43' => 'Haute-Loire'], ['44' => 'Loire-Atlantique'], ['45' => 'Loiret'], ['46' => 'Lot'], ['47' => 'Lot-et-Garonne'], ['48' => 'Lozère'], ['49' => 'Maine-et-Loire'], ['50' => 'Manche'], ['51' => 'Marne'], ['52' => 'Haute-Marne'], ['53' => 'Mayenne'], ['54' => 'Meurthe-et-Moselle'], ['55' => 'Meuse'], ['56' => 'Morbihan'], ['57' => 'Moselle'], ['58' => 'Nièvre'], ['59' => 'Nord'], ['60' => 'Oise'], ['61' => 'Orne'], ['62' => 'Pas-de-Calais'], ['63' => 'Puy-de-Dôme'], ['64' => 'Pyrénées-Atlantiques'], ['65' => 'Hautes-Pyrénées'], ['66' => 'Pyrénées-Orientales'], ['67' => 'Bas-Rhin'], ['68' => 'Haut-Rhin'], ['69' => 'Rhône'], ['70' => 'Haute-Saône'], ['71' => 'Saône-et-Loire'], ['72' => 'Sarthe'], ['73' => 'Savoie'], ['74' => 'Haute-Savoie'], ['75' => 'Paris'], ['76' => 'Seine-Maritime'], ['77' => 'Seine-et-Marne'], ['78' => 'Yvelines'], ['79' => 'Deux-Sèvres'], ['80' => 'Somme'], ['81' => 'Tarn'], ['82' => 'Tarn-et-Garonne'], ['83' => 'Var'], ['84' => 'Vaucluse'], ['85' => 'Vendée'], ['86' => 'Vienne'], ['87' => 'Haute-Vienne'], ['88' => 'Vosges'], ['89' => 'Yonne'], ['90' => 'Territoire de Belfort'], ['91' => 'Essonne'], ['92' => 'Hauts-de-Seine'], ['93' => 'Seine-Saint-Denis'], ['94' => 'Val-de-Marne'], ['95' => "Val-d'Oise"], ['971' => 'Guadeloupe'], ['972' => 'Martinique'], ['973' => 'Guyane'], ['974' => 'La Réunion'], ['976' => 'Mayotte']]
$regions
private
static mixed
$regions
= ['Alsace', 'Aquitaine', 'Auvergne', 'Bourgogne', 'Bretagne', 'Centre', 'Champagne-Ardenne', 'Corse', 'Franche-Comté', 'Île-de-France', 'Languedoc-Roussillon', 'Limousin', 'Lorraine', 'Midi-Pyrénées', 'Nord-Pas-de-Calais', 'Basse-Normandie', 'Haute-Normandie', 'Pays-de-Loire', 'Picardie', 'Poitou-Charentes', "Provence-Alpes-Côte d'Azur", 'Rhone-Alpes', 'Guadeloupe', 'Martinique', 'Guyane', 'Réunion', 'Saint-Pierre-et-Miquelon', 'Mayotte', 'Saint-Barthélémy', 'Saint-Martin', 'Wallis-et-Futuna', 'Polynésie française', 'Nouvelle-Calédonie']
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 —cityPrefix()
public
static cityPrefix() : mixed
Tags
Return values
mixed —citySuffix()
public
static citySuffix() : mixed
Tags
Return values
mixed —country()
public
static country() : string
Tags
Return values
string —department()
Randomly returns a french department ('departmentNumber' => 'departmentName').
public
static department() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —departmentName()
Randomly returns a french department name.
public
static departmentName() : string
Tags
Return values
string —departmentNumber()
Randomly returns a french department number.
public
static departmentNumber() : 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 —region()
Randomly returns a french region.
public
static region() : string
Tags
Return values
string —secondaryAddress()
public
static secondaryAddress() : mixed
Tags
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
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
state()
public
static state() : mixed
Tags
Return values
mixed —stateAbbr()
public
static stateAbbr() : mixed
Tags
Return values
mixed —streetAddress()
public
streetAddress() : string
Tags
Return values
string —streetName()
public
streetName() : string
Tags
Return values
string —streetPrefix()
public
static streetPrefix() : mixed
Tags
Return values
mixed —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'