Documentation

Address extends Address
in package

Application

$addressFormats : mixed
$areas : mixed
$buildingNumber : mixed
$cites : mixed
$cityFormats : mixed
$citySuffix : mixed
$country : mixed
$generator : Generator
$postcode : mixed
$stateAbbr : mixed
$states : mixed
$streetAddressFormats : mixed
$streetNameFormats : mixed
$streetSuffix : mixed
$unique : UniqueGenerator
__construct() : mixed
address() : string
area() : mixed
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
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.
state() : mixed
stateAbbr() : 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

$addressFormats


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

$areas


    protected
    static    mixed
    $areas
     = ['西夏区', '永川区', '秀英区', '高港区', '清城区', '兴山区', '锡山区', '清河区', '龙潭区', '华龙区', '海陵区', '滨城区', '东丽区', '高坪区', '沙湾区', '平山区', '城北区', '海港区', '沙市区', '双滦区', '长寿区', '山亭区', '南湖区', '浔阳区', '南长区', '友好区', '安次区', '翔安区', '沈河区', '魏都区', '西峰区', '萧山区', '金平区', '沈北新区', '孝南区', '上街区', '城东区', '牧野区', '大东区', '白云区', '花溪区', '吉利区', '新城区', '怀柔区', '六枝特区', '涪城区', '清浦区', '南溪区', '淄川区', '高明区', '金水区', '中原区', '高新开发区', '经济开发新区', '新区']

$buildingNumber


    protected
    static    mixed
    $buildingNumber
     = ['%#']

$cites


    protected
    static    mixed
    $cites
     = ['北京', '上海', '天津', '重庆', '哈尔滨', '长春', '沈阳', '呼和浩特', '石家庄', '乌鲁木齐', '兰州', '西宁', '西安', '银川', '郑州', '济南', '太原', '合肥', '武汉', '长沙', '南京', '成都', '贵阳', '昆明', '南宁', '拉萨', '杭州', '南昌', '广州', '福州', '海口', '香港', '澳门']

$cityFormats


    protected
    static    mixed
    $cityFormats
     = ['{{firstName}}{{citySuffix}}']

$citySuffix


    protected
    static    mixed
    $citySuffix
     = ['Ville']

$country


    protected
    static    mixed
    $country
     = ['阿富汗', '阿拉斯加', '阿尔巴尼亚', '阿尔及利亚', '安道尔', '安哥拉', '安圭拉岛英', '安提瓜和巴布达', '阿根廷', '亚美尼亚', '阿鲁巴岛', '阿森松', '澳大利亚', '奥地利', '阿塞拜疆', '巴林', '孟加拉国', '巴巴多斯', '白俄罗斯', '比利时', '伯利兹', '贝宁', '百慕大群岛', '不丹', '玻利维亚', '波斯尼亚和黑塞哥维那', '博茨瓦纳', '巴西', '保加利亚', '布基纳法索', '布隆迪', '喀麦隆', '加拿大', '加那利群岛', '佛得角', '开曼群岛', '中非', '乍得', '智利', '圣诞岛', '科科斯岛', '哥伦比亚', '巴哈马国', '多米尼克国', '科摩罗', '刚果', '科克群岛', '哥斯达黎加', '克罗地亚', '古巴', '塞浦路斯', '捷克', '丹麦', '迪戈加西亚岛', '吉布提', '多米尼加共和国', '厄瓜多尔', '埃及', '萨尔瓦多', '赤道几内亚', '厄立特里亚', '爱沙尼亚', '埃塞俄比亚', '福克兰群岛', '法罗群岛', '斐济', '芬兰', '法国', '法属圭亚那', '法属波里尼西亚', '加蓬', '冈比亚', '格鲁吉亚', '德国', '加纳', '直布罗陀', '希腊', '格陵兰岛', '格林纳达', '瓜德罗普岛', '关岛', '危地马拉', '几内亚', '几内亚比绍', '圭亚那', '海地', '夏威夷', '洪都拉斯', '匈牙利', '冰岛', '印度', '印度尼西亚', '伊郎', '伊拉克', '爱尔兰', '以色列', '意大利', '科特迪瓦', '牙买加', '日本', '约旦', '柬埔塞', '哈萨克斯坦', '肯尼亚', '基里巴斯', '朝鲜', '韩国', '科威特', '吉尔吉斯斯坦', '老挝', '拉脱维亚', '黎巴嫩', '莱索托', '利比里亚', '利比亚', '列支敦士登', '立陶宛', '卢森堡', '马其顿', '马达加斯加', '马拉维', '马来西亚', '马尔代夫', '马里', '马耳他', '马里亚纳群岛', '马绍尔群岛', '马提尼克', '毛里塔尼亚', '毛里求斯', '马约特岛', '墨西哥', '密克罗尼西亚', '中途岛', '摩尔多瓦', '摩纳哥', '蒙古', '蒙特塞拉特岛', '摩洛哥', '莫桑比克', '缅甸', '纳米比亚', '瑙鲁', '尼泊尔', '荷兰', '荷属安的列斯群岛', '新喀里多尼亚群岛', '新西兰', '尼加拉瓜', '尼日尔', '尼日利亚', '纽埃岛', '诺福克岛', '挪威', '阿曼', '帕劳', '巴拿马', '巴布亚新几内亚', '巴拉圭', '秘鲁', '菲律宾', '波兰', '葡萄牙', '巴基斯坦', '波多黎各', '卡塔尔', '留尼汪岛', '罗马尼亚', '俄罗斯', '卢旺达', '东萨摩亚', '西萨摩亚', '圣马力诺', '圣皮埃尔岛及密克隆岛', '圣多美和普林西比', '沙特阿拉伯', '塞内加尔', '塞舌尔', '新加坡', '斯洛伐克', '斯洛文尼亚', '所罗门群岛', '索马里', '南非', '西班牙', '斯里兰卡', '圣克里斯托弗和尼维斯', '圣赫勒拿', '圣卢西亚', '圣文森特岛', '苏丹', '苏里南', '斯威士兰', '瑞典', '瑞士', '叙利亚', '塔吉克斯坦', '坦桑尼亚', '泰国', '阿拉伯联合酋长国', '多哥', '托克劳群岛', '汤加', '特立尼达和多巴哥', '突尼斯', '土耳其', '土库曼斯坦', '特克斯和凯科斯群岛(', '图瓦卢', '美国', '乌干达', '乌克兰', '英国', '乌拉圭', '乌兹别克斯坦', '瓦努阿图', '梵蒂冈', '委内瑞拉', '越南', '维尔京群岛', '维尔京群岛和圣罗克伊', '威克岛', '瓦里斯和富士那群岛', '西撒哈拉', '也门', '南斯拉夫', '扎伊尔', '赞比亚', '桑给巴尔', '津巴布韦', '中华人民共和国', '中国']

$generator


    protected
        Generator
    $generator

$postcode


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

$stateAbbr


    protected
    static    mixed
    $stateAbbr
     = ['京', '皖', '渝', '闽', '甘', '粤', '桂', '黔', '琼', '冀', '豫', '黑', '鄂', '湘', '吉', '苏', '赣', '辽', '蒙', '宁', '青', '鲁', '晋', '陕', '沪', '川', '津', '藏', '新', '滇', '浙', '港', '澳', '台']

$states


    protected
    static    mixed
    $states
     = ['北京市', '天津市', '河北省', '山西省', '内蒙古自治区', '辽宁省', '吉林省', '黑龙江省', '上海市', '江苏省', '浙江省', '安徽省', '福建省', '江西省', '山东省', '河南省', '湖北省', '湖南省', '广东省', '广西壮族自治区', '海南省', '重庆市', '四川省', '贵州省', '云南省', '西藏自治区', '陕西省', '甘肃省', '青海省', '宁夏回族自治区', '新疆维吾尔自治区', '香港特别行政区', '澳门特别行政区', '台湾省']

$streetAddressFormats


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

$streetNameFormats


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

$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 —

area()


    public
            static    area() : mixed

Return values

mixed —

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 —

city()


    public
                city() : string

Return values

string —

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 —

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
                state() : mixed

Return values

mixed —

stateAbbr()


    public
                stateAbbr() : mixed

Return values

mixed —

streetAddress()


    public
                streetAddress() : string

Return values

string —

streetName()


    public
                streetName() : 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

$areas

$buildingNumber

$cites

$cityFormats

$citySuffix

$country

$generator

$postcode

$stateAbbr

$states

$streetAddressFormats

$streetNameFormats

$streetSuffix

$unique

Methods

__construct()

Parameters

Return values

address()

Return values

area()

Return values

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

buildingNumber()

Tags

Return values

city()

Return values

citySuffix()

Tags

Return values

country()

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

numerify()

Parameters

Return values

optional()

Parameters

Return values

passthrough()

Parameters

Return values

postcode()

Return values

randomAscii()

Return values

randomDigit()

Return values

randomDigitNot()

Parameters

Return values

randomDigitNotNull()

Address extends Address
in package

Application