Address
extends Address
in package
Table of Contents
- $addressFormats : mixed
- $buildingNumber : mixed
- $cityFormats : mixed
- $cityNames : mixed
- $citySuffix : mixed
- $country : mixed
- $generator : Generator
- $postcode : mixed
- $state : mixed
- $stateAbbr : array<string|int, mixed>
- Abbreviated State Names.
- $street : 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
- 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.
- state() : mixed
- stateAbbr() : mixed
- street() : 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}} {{postcode}}, {{stateAbbr}}']
$buildingNumber
protected
static mixed
$buildingNumber
= ['%#']
$cityFormats
protected
static mixed
$cityFormats
= ['{{cityName}}']
$cityNames
protected
static mixed
$cityNames
= ['Administrasi Jakarta Barat', 'Administrasi Jakarta Pusat', 'Administrasi Jakarta Selatan', 'Administrasi Jakarta Timur', 'Administrasi Jakarta Utara', 'Ambon', 'Balikpapan', 'Banda Aceh', 'Bandar Lampung', 'Bandung', 'Banjar', 'Banjarbaru', 'Banjarmasin', 'Batam', 'Batu', 'Bau-Bau', 'Bekasi', 'Bengkulu', 'Bima', 'Binjai', 'Bitung', 'Blitar', 'Bogor', 'Bontang', 'Bukittinggi', 'Cilegon', 'Cimahi', 'Cirebon', 'Denpasar', 'Depok', 'Dumai', 'Gorontalo', 'Gunungsitoli', 'Jambi', 'Jayapura', 'Kediri', 'Kendari', 'Kotamobagu', 'Kupang', 'Langsa', 'Lhokseumawe', 'Lubuklinggau', 'Madiun', 'Magelang', 'Makassar', 'Malang', 'Manado', 'Mataram', 'Medan', 'Metro', 'Mojokerto', 'Padang', 'Padangpanjang', 'Padangsidempuan', 'Pagar Alam', 'Palangka Raya', 'Palembang', 'Palopo', 'Palu', 'Pangkal Pinang', 'Parepare', 'Pariaman', 'Pasuruan', 'Payakumbuh', 'Pekalongan', 'Pekanbaru', 'Pematangsiantar', 'Pontianak', 'Prabumulih', 'Probolinggo', 'Sabang', 'Salatiga', 'Samarinda', 'Sawahlunto', 'Semarang', 'Serang', 'Sibolga', 'Singkawang', 'Solok', 'Sorong', 'Subulussalam', 'Sukabumi', 'Sungai Penuh', 'Surabaya', 'Surakarta', 'Tangerang', 'Tangerang Selatan', 'Tanjung Pinang', 'Tanjungbalai', 'Tarakan', 'Tasikmalaya', 'Tebing Tinggi', 'Tegal', 'Ternate', 'Tidore Kepulauan', 'Tomohon', 'Tual', 'Yogyakarta']
Tags
$citySuffix
protected
static mixed
$citySuffix
= ['Ville']
$country
protected
static mixed
$country
= [
'Afganistan',
'Afrika Selatan',
'Albania',
'Aljazair',
'Amerika Serikat',
'Andorra',
'Angola',
'Anguilla',
// http://id.wikipedia.org/wiki/Antartika
'Antartika',
'Antigua dan Barbuda',
// http://id.wikipedia.org/wiki/Antillen_Belanda
'Antillen Belanda',
'Arab Saudi',
'Argentina',
'Armenia',
'Aruba',
'Australia',
'Austria',
'Azerbaijan',
'Bahama',
'Bahrain',
'Bangladesh',
'Barbados',
'Belanda',
'Belarus',
'Belgia',
'Belize',
'Benin',
'Bermuda',
'Bhutan',
'Bolivia',
// http://id.wikipedia.org/wiki/Bosnia_dan_Herzegovina
'Bosnia dan Herzegovina',
'Botswana',
'Brasil',
'Brunei Darussalam',
'Bulgaria',
'Burkina Faso',
'Burundi',
'Chili',
'Cina',
'Kepulauan Cocos (Keeling)',
'Denmark',
'Djibouti',
// http://id.wikipedia.org/wiki/Dominica
'Dominika',
'Ekuador',
'El Salvador',
'Eritrea',
'Estonia',
'Ethiopia',
'Federasi Rusia',
'Fiji',
'Filipina',
'Finlandia',
'Gabon',
'Gambia',
'Georgia',
// http://id.wikipedia.org/wiki/South_Georgia_and_the_South_Sandwich_Islands
'Georgia Selatan dan Kepulauan Sandwich Selatan',
'Ghana',
'Gibraltar',
'Greenland',
'Grenada',
'Guadeloupe',
'Guam',
'Guatemala',
'Guernsey',
'Guinea',
'Guinea Ekuatorial',
'Guinea-Bissau',
'Guyana',
'Guyana Prancis',
'Haiti',
'Honduras',
'Hong Kong',
'Hongaria',
'India',
'Indonesia',
'Inggris Raya',
'Irak',
'Iran',
'Irlandia',
'Islandia',
'Israel',
'Italia',
'Jamaika',
'Jepang',
'Jerman',
'Jersey',
'Jordan',
'Kaledonia baru',
'Kamboja',
'Kamerun',
'Kanada',
'Kazakhstan',
'Kenya',
'Kepulauan Cayman',
'Kepulauan Cook',
'Kepulauan Falkland (Malvinas)',
'Kepulauan Faroe',
'Kepulauan Mariana Utara',
'Kepulauan Marshall',
'Kepulauan Pitcairn',
'Kepulauan Solomon',
// http://id.wikipedia.org/wiki/United_States_Minor_Outlying_Islands
'Kepulauan Terluar Kecil Amerika Serikat',
'Kepulauan Turks dan Caicos',
// http://id.wikipedia.org/wiki/United_States_Virgin_Islands
'Kepulauan Virgin Amerika Serikat',
'Kepulauan Virgin Inggris',
'Kiribati',
'Kolombia',
'Komoro',
'Kongo',
'Korea',
'Korea Utara',
'Kosta Rika',
'Kroasia',
// http://id.wikipedia.org/wiki/Cuba
'Kuba',
'Kuwait',
'Latvia',
'Lebanon',
'Lesotho',
'Liberia',
'Libya',
'Liechtenstein',
'Lithuania',
'Luxembourg',
'Madagaskar',
'Makau',
'Makedonia',
'Maladewa',
'Malawi',
'Malaysia',
'Mali',
'Malta',
'Maroko',
// http://id.wikipedia.org/wiki/Martinique
'Martinik',
'Mauritania',
'Mauritius',
'Mayotte',
'Meksiko',
'Mesir',
'Mikronesia',
'Moldova',
'Monako',
'Mongolia',
'Montenegro',
'Montserrat',
'Mozambik',
'Myanmar',
'Namibia',
'Nauru',
'Nepal',
'Niger',
'Nigeria',
'Nikaragua',
'Niue',
'Norwegia',
'Oman',
'Pakistan',
'Palau',
'Panama',
// http://id.wikipedia.org/wiki/Cote_d%27Ivoire
'Pantai Gading',
'Papua Nugini',
'Paraguay',
'Peru',
'Polandia',
'Polinesia Prancis',
'Portugal',
'Prancis',
'Puerto Rico',
// http://ms.wikipedia.org/wiki/Pulau_Bouvet
'Pulau Bouvet',
// http://id.wikipedia.org/wiki/Pulau_Heard_dan_Kepulauan_McDonald
'Pulau Heard dan Kepulauan McDonald',
// http://id.wikipedia.org/wiki/Isle_of_Man
'Pulau Man',
'Pulau Natal',
'Pulau Norfolk',
'Qatar',
'Republik Afrika Tengah',
'Republik Ceko',
// http://id.wikipedia.org/wiki/Chad
'Republik Chad',
'Republik Demokratik Rakyat Laos',
'Republik Dominika',
'Republik Kirgizstan',
// http://id.wikipedia.org/wiki/Reunion
'Réunion',
'Rumania',
'Rwanda',
'Sahara Barat',
'Saint Barthelemy',
'Saint Helena',
'Saint Kitts dan Nevis',
'Saint Lucia',
'Saint Martin',
'Saint Pierre dan Miquelon',
'Saint Vincent dan Grenadines',
'Samoa',
'Samoa Amerika',
'San Marino',
'Sao Tome dan Principe',
'Selandia baru',
'Senegal',
'Serbia',
'Seychelles',
'Sierra Leone',
'Singapura',
'Siprus',
'Slovakia (Republik Slovak)',
'Slovenia',
'Somalia',
'Spanyol',
'Sri Lanka',
'Sudan',
'Suriah',
'Suriname',
'Svalbard & Jan Mayen Islands',
'Swaziland',
'Swedia',
'Swiss',
'Taiwan',
'Tajikistan',
// http://id.wikipedia.org/wiki/Cape_Verde
'Tanjung Verde',
'Tanzania',
'Thailand',
'Timor-Leste',
'Togo',
'Tokelau',
'Tonga',
'Trinidad dan Tobago',
'Tunisia',
'Turki',
'Turkmenistan',
'Tuvalu',
'Uganda',
'Ukraina',
'Uni Emirat Arab',
'Uruguay',
'Uzbekistan',
'Vanuatu',
// http://id.wikipedia.org/wiki/Holy_See
'Vatikan',
'Venezuela',
'Vietnam',
'Wallis dan Futuna',
'Wilayah Palestina',
// http://id.wikipedia.org/wiki/United_States_Virgin_Islands
'Wilayah Samudra Hindia Britania',
'Wilayah Selatan Perancis',
'Yaman',
'Yunani',
'Zambia',
'Zimbabwe',
]
Tags
$generator
protected
Generator
$generator
$postcode
protected
static mixed
$postcode
= ['%####']
$state
protected
static mixed
$state
= ['Aceh', 'Sumatera Utara', 'Sumatera Barat', 'Jambi', 'Kepulauan Bangka Belitung', 'Riau', 'Kepulauan Riau', 'Bengkulu', 'Sumatera Selatan', 'Lampung', 'Banten', 'DKI Jakarta', 'Jawa Barat', 'Jawa Tengah', 'Jawa Timur', 'Nusa Tenggara Timur', 'DI Yogyakarta', 'Bali', 'Nusa Tenggara Barat', 'Kalimantan Barat', 'Kalimantan Tengah', 'Kalimantan Selatan', 'Kalimantan Timur', 'Kalimantan Utara', 'Sulawesi Selatan', 'Sulawesi Utara', 'Gorontalo', 'Sulawesi Tengah', 'Sulawesi Barat', 'Sulawesi Tenggara', 'Maluku', 'Maluku Utara', 'Papua Barat', 'Papua']
Tags
$stateAbbr
Abbreviated State Names.
protected
static array<string|int, mixed>
$stateAbbr
= ['Aceh', 'Sumut', 'Sumbar', 'Jambi', 'Babel', 'Riau', 'Kepri', 'Bengkulu', 'Sumsel', 'Lampung', 'Banten', 'DKI', 'Jabar', 'Jateng', 'Jatim', 'NTT', 'DIY', 'Bali', 'NTB', 'Kalbar', 'Kalteng', 'Kalsel', 'Kaltim', 'Kaltara', 'Sulsel', 'Sulut', 'Gorontalo', 'Sulteng', 'Sulbar', 'Sultra', 'Maluku', 'Malut', 'Pabar', 'Papua']
Tags
$street
protected
static mixed
$street
= ['Abang', 'Abdul', 'Abdul Muis', 'Abdul Rahmat', 'Abdul. Muis', 'Abdullah', 'Aceh', 'Achmad', 'Achmad Yani', 'Acordion', 'Adisucipto', 'Adisumarmo', 'Agus Salim', 'Ahmad Dahlan', 'Antapani Lama', 'Arifin', 'Asia Afrika', 'Astana Anyar', 'B.Agam 1', 'B.Agam Dlm', 'BKR', 'Baabur Royan', 'Baan', 'Babadak', 'Babadan', 'Babah', 'Babakan', 'Bacang', 'Badak', 'Bagas Pati', 'Bagis Utama', 'Bagonwoto ', 'Bah Jaya', 'Baha', 'Bahagia', 'Bahagia ', 'Baiduri', 'Baik', 'Baing', 'Baja', 'Baja Raya', 'Bak Air', 'Bak Mandi', 'Bakaru', 'Bakau', 'Bakau Griya Utama', 'Bakhita', 'Bakin', 'Bakit ', 'Bakti', 'Baladewa', 'Bambon', 'Bambu', 'Banal', 'Banceng Pondok', 'Banda', 'Bank Dagang Negara', 'Bappenas', 'Bara', 'Bara Tambar', 'Baranang', 'Baranang Siang', 'Baranang Siang Indah', 'Baranangsiang', 'Barasak', 'Barat', 'Basket', 'Basmol Raya', 'Basoka', 'Basoka Raya', 'Bass', 'Basudewo', 'Basuki', 'Basuki Rahmat ', 'Bata Putih', 'Batako', 'Baung', 'Bawal', 'Baya Kali Bungur', 'Bayam', 'Bayan', 'Bazuka Raya', 'Bhayangkara', 'Camar', 'Casablanca', 'Cemara', 'Cihampelas', 'Cikapayang', 'Cikutra Barat', 'Cikutra Timur', 'Ciumbuleuit', 'Ciwastra', 'Cokroaminoto', 'Cut Nyak Dien', 'Daan', 'Dago', 'Dahlia', 'Dewi Sartika', 'Dipatiukur', 'Dipenogoro', 'Diponegoro', 'Dr. Junjunan', 'Eka', 'Ekonomi', 'Elang', 'Fajar', 'Flora', 'Flores', 'Gading', 'Gajah', 'Gajah Mada', 'Gambang', 'Gardujati', 'Gatot Subroto', 'Gedebage Selatan', 'Gegerkalong Hilir', 'Gotong Royong', 'Gremet', 'HOS. Cjokroaminoto (Pasirkaliki)', 'Haji', 'Halim', 'Hang', 'Hasanuddin', 'Honggowongso', 'Ikan', 'Imam', 'Imam Bonjol', 'Industri', 'Ir. H. Juanda', 'Jagakarsa', 'Jakarta', 'Jaksa', 'Jambu', 'Jamika', 'Jayawijaya', 'Jend. A. Yani', 'Jend. Sudirman', 'Juanda', 'K.H. Maskur', 'K.H. Wahid Hasyim (Kopo)', 'Kali', 'Kalimalang', 'Kalimantan', 'Karel S. Tubun', 'Kartini', 'Katamso', 'Kebangkitan Nasional', 'Kebonjati', 'Ketandan', 'Ki Hajar Dewantara', 'Kiaracondong', 'Krakatau', 'Kusmanto', 'Kyai Gede', 'Kyai Mojo', 'Labu', 'Lada', 'Laksamana', 'Laswi', 'Lembong', 'Lumban Tobing', 'M.T. Haryono', 'Madiun', 'Madrasah', 'Mahakam', 'Merdeka', 'Moch. Ramdan', 'Moch. Toha', 'Moch. Yamin', 'Monginsidi', 'Mulyadi', 'Muwardi', 'Nakula', 'Nanas', 'Nangka', 'Orang', 'Otista', 'Otto', 'PHH. Mustofa', 'Pacuan Kuda', 'Padang', 'Padma', 'Pahlawan', 'Panjaitan', 'Pasir Koja', 'Pasirkoja', 'Pasteur', 'Pattimura', 'Pelajar Pejuang 45', 'Perintis Kemerdekaan', 'Peta', 'Qrisdoren', 'R.E. Martadinata', 'R.M. Said', 'Raden', 'Raden Saleh', 'Radio', 'Rajawali', 'Rajawali Barat', 'Rajawali Timur', 'Rajiman', 'Raya Setiabudhi', 'Raya Ujungberung', 'Reksoninten', 'Ronggowarsito', 'Rumah Sakit', 'S. Parman', 'Sadang Serang', 'Salak', 'Salam', 'Salatiga', 'Sam Ratulangi', 'Samanhudi', 'Sampangan', 'Sentot Alibasa', 'Setia Budi', 'Setiabudhi', 'Siliwangi', 'Soekarno Hatta', 'Sudiarto', 'Sudirman', 'Sugiono', 'Sugiyopranoto', 'Suharso', 'Sukabumi', 'Sukajadi', 'Sumpah Pemuda', 'Sunaryo', 'Suniaraja', 'Supomo', 'Supono', 'Suprapto', 'Surapati', 'Suryo', 'Suryo Pranoto', 'Sutami', 'Sutan Syahrir', 'Sutarjo', 'Sutarto', 'Sutoyo', 'Taman', 'Tambak', 'Tambun', 'Tangkuban Perahu', 'Tentara Pelajar', 'Ters. Buah Batu', 'Ters. Jakarta', 'Ters. Kiaracondong', 'Ters. Pasir Koja', 'Teuku Umar', 'Thamrin', 'Tubagus Ismail', 'Ujung', 'Uluwatu', 'Umalas', 'Untung Suropati', 'Urip Sumoharjo', 'Veteran', 'Villa', 'W.R. Supratman', 'Wahid', 'Wahid Hasyim', 'Wahidin', 'Wahidin Sudirohusodo', 'Warga', 'Wora Wari', 'Yap Tjwan Bing', 'Yoga', 'Yogyakarta', 'Yohanes', 'Yos', 'Yos Sudarso', 'Yosodipuro', 'Zamrud']
Tags
$streetAddressFormats
protected
static mixed
$streetAddressFormats
= ['{{streetPrefix}} {{street}} No. {{buildingNumber}}']
$streetNameFormats
protected
static mixed
$streetNameFormats
= ['{{street}}']
$streetPrefix
protected
static mixed
$streetPrefix
= ['Ds.', 'Dk.', 'Gg.', 'Jln.', 'Jr.', 'Kpg.', 'Ki.', 'Psr.']
$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
Return values
string —city()
public
city() : string
Return values
string —cityName()
public
static 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
state()
public
static state() : mixed
Tags
Return values
mixed —stateAbbr()
public
static stateAbbr() : mixed
Tags
Return values
mixed —street()
public
static street() : mixed
Return values
mixed —streetAddress()
public
streetAddress() : string
Tags
Return values
string —streetName()
public
streetName() : string
Tags
Return values
string —streetPrefix()
public
static streetPrefix() : mixed
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'