Documentation

Company extends Company
in package

Table of Contents

$companies  : mixed
$companySuffix  : mixed
There are more Private Limited Companies(Sdn Bhd) than Public Listed Companies(Berhad)
$formats  : mixed
$generator  : Generator
$industry  : mixed
$jobTitleFormat  : mixed
$unique  : UniqueGenerator
__construct()  : 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
company()  : string
companyName()  : mixed
Return a random company name
companySuffix()  : string
industry()  : mixed
Return a random industry
jobTitle()  : string
lexify()  : string
Replaces all question mark ('?') occurrences with a random letter
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
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.
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

$companies

protected static mixed $companies = ['Adventa', 'AirAsia', 'AmBank', 'Astro Malaysia Holdings', 'Astro Radio', 'Axiata', 'Berjaya Group', 'Bonia', 'Boustead Holdings', 'BSA Manufacturing', 'Bufori', 'Bumiputra-Commerce Holdings', 'Bursa Malaysia', 'Capital Dynamics', 'Celcom', 'CIMB', 'Digi Telecommunications', 'DRB-HICOM', 'Edaran Otomobil Nasional (EON)', 'Friendster', 'Gamuda', 'Genting Group', 'Golden Hope', 'Golden Screen Cinemas', 'Guthrie', 'HELP International Corporation', 'iMoney.my', 'IOI Group', 'Iskandar Investment', 'The Italian Baker', 'Jaring', 'JobStreet.com', 'Johor Corporation', 'Johor Land', 'Khazanah Nasional', 'Khind Holdings', 'KLCC Properties', 'Keretapi Tanah Melayu (KTM)', 'Konsortium Transnasional (KTB)', 'Kulim (Malaysia)', 'Lam Eng Rubber', 'Lion Group', 'Magnum Corporation', 'Maybank', 'Malaysia Airlines', 'Malaysia Airports', 'Marrybrown', 'Maxis Communications', 'MBO Cinemas', 'Media Prima', 'MIMOS', 'MISC', 'Modenas', 'MUI Group', 'Mydin', 'NAZA Group', 'New Straits Times Press', 'OYL Industries', 'Parkson', 'Pensonic', 'Permodalan Nasional', 'Perodua', 'Petronas', 'PLUS', 'Pos Malaysia', 'Prasarana Malaysia', 'Proton Holdings', 'Public Bank', 'Ramly Group', 'Ranhill Holdings', 'Resort World', 'RHB Bank', 'Royal Selangor', 'Scientex Incorporated', 'Scomi', 'Sime Darby', 'SIRIM', 'Sunway Group', 'Supermax', 'Tan Chong Motor', 'Tanjong', 'Tenaga Nasional', 'Telekom Malaysia(TM)', 'TGV Cinemas', 'Top Glove', 'U Mobile', 'UEM Group', 'UMW Holdings', 'VADS', 'ViTrox', 'Wasco Energy', 'YTL Corporation']
Tags
see
https://en.wikipedia.org/wiki/List_of_companies_of_Malaysia

$formats

protected static mixed $formats = ['{{companyName}} {{companySuffix}}', '{{industry}} {{lastNameMalay}} {{companySuffix}}', '{{industry}} {{firstNameMaleChinese}} {{companySuffix}}', '{{industry}} {{firstNameMaleIndian}} {{companySuffix}}']

$industry

protected static mixed $industry = ['Agen Pengembaraan', 'Agen Penghantaran', 'Agen Perkapalan', 'Agensi Kredit Dan Pemfaktoran', 'Air', 'Akseso Kenderaan', 'Aksesori', 'Aksesori Jentera Berat', 'Aksesori Penghubung Dan Telekomunikasi', 'Aksesori Senjata Api', 'Akuatik', 'Akustik Dan Gelombang', 'Alat Forensik Dan Aksesori', 'Alat Gani', 'Alat Ganti', 'Alat Ganti Dan Kelengkapan Bot', 'Alat Hawa Dingin', 'Alat Hawa Dingin Kenderaan', 'Alat Kebombaan', 'Alat Kelengkapan Perubatan', 'Alat Keselamatan, Perlindungan Dan Kawalan Perlindungan Dan Kawalan', 'Alat Muzik Dan Aksesori', 'Alat Muzik, Kesenian dan Aksesori', 'Alat Penghasil Nyalaan', 'Alat penyelamat', 'Alat Penyimpan Tenaga Dan Aksesori', 'Alat Perhubungan', 'Alat Semboyan', 'Alat-Alat Marin', 'Alatganti Dan Kelengkapan Pesawat', 'Alatulis', 'Animation', 'Anti Kakis', 'Artis Dan Penghibur Profesional', 'Audio Visual', 'Bagasi Dan Beg dari kulit', 'Bahan Api Nuklear', 'Bahan Bacaan', 'Bahan Bacaan Terbitan Luar Negara', 'Bahan Bakar', 'Bahan Binaan', 'Bahan dan Peralatan Solekan dan Andaman', 'Bahan Letupan', 'Bahan Peledak', 'Bahan Pelincir', 'Bahan pembungkusan', 'Bahan Pencuci Dan Pembersihan', 'Bahan Pendidikan', 'Bahan Penerbitan Elektronik Dan Muzik', 'Bahan Surih, Drafting Dan Alat Lukis', 'Bahan Tambah', 'Bahan Tarpaulin Dan Kanvas', 'Baik Pulih Kasut Dan Barangan Kulit', 'Baikpulih Barang-Barang Logam', 'Baja Dan Nutrien Tumbuhan', 'Baka', 'Bangunan', 'Bantuan Kecemasan DanAmbulan', 'Bantuan Kemanusiaan', 'Barangan Hiasan Dalaman Dan Aksesori', 'Barangan PVC', 'Barge', 'Bas', 'Basah', 'Basikal', 'Bekalan Pejabat Dan Alatulis', 'Bekas', 'Belon Panas', 'Benih Semaian', 'Bill Board', 'Bioteknologi', 'Bot', 'Bot Malim', 'Bot Tunda', 'Brangan Logam', 'Broker Insuran', 'Broker Perkapalan', 'Bunga Api Dan Mercun', 'Butang Dan Bekalan Jahitan', 'Cat', 'Cenderamata Dan Hadiah', 'Cetakan Hologram', 'Cetakan Keselamatan', 'Chalet', 'Cloud Seeding', 'Complete Rounds', 'Customization and maintenance including data', 'Dadah Berjadual', 'Dan Aksesori', 'Darat', 'Dasar Dan Peraturan', 'Data management –Provide services including Disaster', 'Dll', 'DNA', 'Dobi', 'Dokumentasi Dan Panduarah', 'Elektronik', 'Empangan', 'Enjin Kenderaan', 'Enjin, Komponen Enjin Dan Aksesori', 'Entry, data processing', 'Fabrik', 'Faksimili', 'Feri', 'Filem dan Mikrofilem', 'Filem Siap Untuk Tayangan', 'Fotografi', 'Gas', 'Gas Turbine', 'Geographic Information System', 'Geologi', 'Graphic Design', 'Habitat Dan Tempat Kurungan Haiwan', 'Haiwan Ternakan, Bukan Ternakan dan Akuatik', 'Hak Harta Intelek', 'Hardware', 'Hardware', 'Hardware and Software leasing', 'Hasil Sampingan Dan Sisa Perladangan', 'Helikopter', 'Hiasan Dalaman', 'Hiasan Jalan', 'Hidrografi', 'Homestay', 'Hortikultur', 'Hotel', 'Hubungan Antarabangsa', 'Hutan Dan Ladang Hutan', 'ICT security and firewall, Encryption, PKI, Anti Virus', 'Industri', 'Infrastructure', 'Internet', 'Jentera', 'Jentera Berat', 'Jentera Berat', 'Jet Ski', 'Kabel Elektrik Dan Aksesori', 'Kain', 'Kajian Telekomunikasi', 'Kakitangan Iktisas', 'Kakitangan Separa Iktisas', 'Kamera dan Aksesori', 'Kanvas', 'Kapal', 'Kapal Angkasa Dan Alatganti', 'Kapal Laut', 'Kapal Selam', 'Kapal Selam', 'Kapal Terbang', 'Kawalan Keselamatan', 'Kawalan Serangga Perosak, Anti Termite', 'Kawasan', 'Kayu', 'Kediaman', 'Kelengkapan', 'Kelengkapan Dan Aksesori', 'Kelengkapan Hospital Dan Makmal', 'Kelengkapan Pakaian', 'Kelengkapan Sasaran', 'Kemudahan Awam', 'Kemudahan Awam', 'Kenderaan', 'Kenderaan Bawah 3 Ton', 'Kenderaan Ber Rel Dan kereta Kabel', 'Kenderaan Jenazah', 'Kenderaan Kegunaan Khusus', 'Kenderaan Kegunaan Khusus', 'Kenderaan Melebihi 3Ton', 'Kenderaan Rekreasi', 'Kenderaan Udara', 'Kereta', 'Kerja Pembaikan Kapal Angkasa', 'Kerja-Kerja Khusus', 'Kerja-kerja Mengetuk dan Mengecat', 'Kerja-Kerja Pembaikan Kenderaan Ber Rel Dan Kereta Kabel', 'Kerja-Kerja Penyelenggaraan Sistem Kenderaan', 'Kertas', 'Kertas Komputer', 'Khidmat Guaman', 'Khidmat Latihan, Tenaga Pengajar dan Moderator', 'Khidmat Udara', 'Kit Pendidikan', 'Kodifikasi', 'Kolam Kumbahan', 'Komponen Dan Aksesori Elektrik', 'Komponen Enjin Pembakaran Dalaman', 'Kontena', 'Kotak', 'Kren', 'Kunci, Perkakasan Perlindungan Dan Aksesori', 'Kusyen dan Bumbung', 'Label', 'Ladang', 'Lagu', 'Lain-lain Media Pengiklanan', 'Laminating', 'Lampu, Komponen Lampu Dan Aksesori', 'Laut', 'Lesen', 'LIDAR', 'Lilin', 'Logam', 'Lokomotif Dan Troli Elektrik', 'Lori', 'Maintenance', 'Makanan', 'Makanan Bermasak', 'Makanan Bermasak', 'Makanan Dan Bahan Mentah Kering', 'Makanan dan Minuman', 'Makanan Haiwan', 'Makmal', 'Malim Kapal', 'Marker', 'Mechanisation System', 'Media Cetak', 'Media Elektronik', 'Medium Penyimpanan', 'Membaik Pulih Bateri', 'Membaik Pulih Tayar', 'Membaik Pulih TempatDuduk', 'Membaiki Buff Fuel Tank', 'Membaikpulih BahanTerbitan Dan Manuskrip', 'Membekal Air', 'Membeli Barang Lusuh Perlu Permit', 'Membeli Barang Lusuh Tanpa Permit', 'Membersih Kawasan', 'Membersih Kenderaan', 'Membersih Pantai', 'Memproses Air', 'Memproses Filem', 'Menangkap', 'Mencetak Borang', 'Mencetak Buku, Majalah, Laporan Akhbar', 'Mencetak Continuous Stationery Forms', 'Mencetak Fail, Kad Perniagaan Dan Kad Ucapan', 'Mencetak Label, Poster dan Pelekat', 'Mencetak Label, Poster, Pelekat dan Iron On', 'Mencuci Kolam Renang', 'Menembak Haiwan', 'Mengangkat Sampah', 'Mengangkut Mayat', 'Mengikat Dan Melepas Tali Kapal', 'Menjahit Bukan Pakaian', 'Menjahit Pakaian Dan Kelengkapan', 'Menjilid Kulit Keras', 'Menjilid Kulit Lembut', 'Menyelam', 'Mereka-Cipta Dan Seni Halus', 'Mesin Dan Kelengkapan Bengkel', 'Mesin dan Kelengkapan Khusus', 'Mesin dan peralatan makmal', 'Mesin dan Peralatan Pejabat', 'Mesin dan Peralatan Woksyop', 'Mesin Pengimbas', 'Mesin-Mesin Pejabat', 'Mesin-Mesin Pejabat Dan Aksesori', 'Minuman Tambahan', 'Motel', 'Motor Dan Alat Ubah', 'Motosikal', 'Multimedia-products services and maintenance', 'Multimodal Transport Operator', 'Negotiator', 'Networking-supply', 'Nylon', 'Oceanografi', 'P.A Sistem Dan Alat Muzik', 'Paip Air Dan Komponen', 'Paip Dan Kelengkapan', 'Pakaian', 'Pakaian Keselamatan, Kelengkapan Dan Aksesori', 'Pakaian Sukan Dan Aksesori', 'Palet', 'Pameran pertunjukan, taman hiburan dan karnival', 'Papan Tanda dan Aksesori', 'Pejabat', 'Pekakas Perubatan Pakai Buang', 'Pelancar Misil Dan Roket', 'Pelupusan Dan Perawatan Sisa berbahaya', 'Pelupusan Dan Perawatan Sisa tidak berbahaya', 'Pelupusan dan Rawatan Sisa Radio Aktif dan Nuklear', 'Peluru Berpandu', 'Peluru Dan Bom', 'Pemadam Api', 'Pembaikan Alat Keselamatan', 'Pembaikan Kenderaan Yang Tidak Berenjin', 'Pembajaan', 'Pembersihan Bangunan Dan Pejabat', 'Pembersihan Tumpahan Minyak', 'Pembuat', 'Pembuat', 'Pembuat Keselamatan', 'Pembungkusan', 'Pembungkusan Dan Penyimpanan', 'Pemeliharaan Bahan Bahan Sejarah Dan Tempat Bersejarah', 'Pemetaan', 'Pemetaan Utiliti Bawah Tanah', 'Pemilik Kapal', 'Pemungut Hutang', 'Pencahayaan', 'Pencelup', 'Pencucuh', 'Penerbitan Elektronik Atas Talian', 'Pengangkutan Lori', 'Pengatur Huruf', 'Pengeluaran Filem', 'Pengenalan Dan Pas Keselamatan Bersalut', 'Penghantar Notis', 'Penghantaran Dokumen', 'Pengkomersilan', 'Pengurusan Jenazah Dan Kelengkapan', 'Pengurusan Kewangan Dan Korporat', 'Pengurusan Pelabuhan', 'Penjana Kuasa', 'Pensijilan dan Pengiktirafan', 'Penterjemahan', 'Penulisan – Semua Jenis Penulisan', 'Penyediaan Akaun dan Pengauditan', 'Penyediaan Pentas', 'Penyelenggaraan', 'Penyelenggaraan Kapal Terbang', 'Penyelenggaraan Misil', 'Penyelenggaraan Simulator Helikopter', 'Penyelenggaraan Simulator Kapal', 'Penyelenggaraan Simulator Kapal Terbang', 'PenyelenggaraanHelikopter', 'Penyelenggaran Dan Pembaikan Senjata', 'Penyiaran', 'Penyiasat Persendirian', 'Penyimpanan Rekod', 'Perabot', 'Perabot Jalan Raya', 'Perabot Pejabat', 'Perabot, Perabot Makmal dan Kelengkapan Berasaskan', 'Peralatan', 'Peralatan Dan Kelengkapan Hospital', 'Peralatan Dan Kelengkapan Pertanian', 'Peralatan Dan Kelengkapan Perubatan', 'Peralatan Dan Perkakas Domestik', 'Peralatan Kawalan Api', 'Peralatan Kawalan Keselamatan', 'Peralatan Keselamatan', 'Peralatan Keselamatan dan Senjata', 'Peralatan Makmal Pengukuran, Pencerapan Dan Sukat', 'Peralatan Makmal serta Aksesori', 'Peralatan Marin', 'Peralatan Memancing', 'Peralatan Memburu', 'Peralatan Pemantauan Dan Pengesanan', 'Peralatan Pemprosesan Fotografi, Mikrofilem', 'Peralatan Pengawalan Perosak Tanaman', 'Peralatan Percetakan Serta Aksesori', 'Peralatan Perindustrian Hiliran', 'Peralatan Perindustrian Huluan', 'Peralatan Perkhemahan Dan Aktiviti Luar', 'Peralatan Servis Dan Selenggara', 'Peralatan Sistem Bunyi, Pembesar Suara dan Projektor', 'Peralatan Sistem Kumbahan Dan Aksesori', 'Peralatan Sukan', 'Peralatan Untuk Orang Kurang Upaya Dan Pemulihan', 'Perhubungan', 'Perikanan Dan Akuakultur', 'Perkakas', 'Perkakas Elektrik Dan Aksesori', 'Perkakas Elektronik Dan Aksesori', 'Perkakasan Dan Bahan Kebersihan Diri Dan Mandian, Kelengkapan Bilik Air', 'Perkakasan Penyuntingan', 'Perkhidmatan Fotostat', 'Perkhidmatan Mel Pukal', 'Permainan', 'Perosak, Rumpai', 'Persembahan', 'Pertanian', 'Perundingan', 'Pesakit', 'Pesawat', 'Pesawat Udara', 'Pest Control', 'Pestaria', 'Pewarna', 'Pisah Warna', 'Plastik', 'Plastik', 'Printers, storage area network', 'Production Testing, Surface Well Testing and Wire Line Services', 'Pump', 'Pusat Latihan', 'Pvc', 'Racun Berjadual', 'Racun Serangga', 'Radar Dan Alatganti', 'Rakaman', 'Rawatan Hutan', 'Reaktor dan Instrumen Nuklear', 'Rekabentuk Percetakan', 'Renting', 'Resort', 'Roket Dan Sub Sistem, Pelancar', 'Rotan', 'Ruang Niaga', 'Rumah Kediaman', 'Rumah Tumpangan', 'Salvage Boat', 'Sampan', 'Sampel dan Sampel Awetan Haiwan', 'Sand Blasting Dan Mengecat Untuk Kapal', 'Satelit', 'Satelit Dan Alatganti', 'Semua Peralatan Sukatan', 'Senjata Api', 'Serangga', 'Sesalur', 'Shelf packages including maintenance', 'Ship Chandling', 'Ship Trimming', 'Simulator', 'Simulator Bot', 'Simulator serta lain-lain', 'Sisa Perawatan', 'Sistem Elektrik', 'Sistem Elektronik', 'Sistem Pencegah Kebakaran', 'Sistem Perhubungan', 'Sistem, Peralatan, Alat Ganti Keretapi Dan Aksesori', 'Software', 'Solekan', 'Split', 'Stesen Janakuasa, Peralatan', 'Stevedor', 'Stor', 'Sub Sistem Roket', 'Sukan', 'Sumber Air', 'Sungai', 'Syarikat Insuran', 'Syarikat pelelong awam', 'System development', 'Tag', 'Talian Paip', 'Taman', 'Tanaman', 'Tanda Dan Stiker', 'Tangki', 'Tasik', 'Tatahias Haiwan', 'Teknologi Hijau', 'Teknologi Maklumat Dan Komunikasi', 'Tekstil', 'Tekstil Guna Semula Kakitangan', 'Tekstil Pakai Buang Kakitangan', 'Telecommunication', 'Telekomunikasi', 'Telly Clerk', 'Tempat Letak Kereta', 'Tenaga Buruh', 'Ternakan', 'Terusan', 'Topografi', 'Trailer Dan Aksesori', 'Tukun Tiruan', 'Tumbuhan', 'Ubat Haiwan', 'Ubat Tidak Berjadual', 'Ujian Makmal', 'Ukuran', 'Varnishing', 'WAN', 'Wayar Elektrik Dan Aksesori', 'Wireless']
Tags
see
http://www.daftarsyarikat.biz/perkhidmatan-dan-konsultasi/pendaftaran-lesen-kementerian-kewangan/senarai-kod-bidang/

$jobTitleFormat

protected static mixed $jobTitleFormat = ['{{word}}']

Methods

__construct()

public __construct(Generator $generator) : mixed
Parameters
$generator : Generator
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

Tags
example

$faker->asciify(''********'); // "s5'G!uC3"

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 —

company()

public company() : string
Tags
example

'Acme Ltd'

Return values
string —

companyName()

Return a random company name

public static companyName() : mixed
Tags
example

'AirAsia'

Return values
mixed —

companySuffix()

public static companySuffix() : string
Tags
example

'Ltd'

Return values
string —

industry()

Return a random industry

public static industry() : mixed
Tags
example

'Automobil'

Return values
mixed —

jobTitle()

public jobTitle() : string
Tags
example

'Job'

Return values
string —

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 —

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
example

79907610

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 —

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
throws
LengthException

When requesting more elements than provided

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
example

48.8932

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
example

79907610

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
example

$faker->regexify('[A-Z0-9._%+-]+@[A-Z0-9.-]+.[A-Z]{2,4}'); // sm0@y8k96a.ej

Regex delimiters '/.../' and begin/end markers '^...$' are ignored.

Only supports a small subset of the regex syntax. For instance, unicode, negated classes, unbounded ranges, subpatterns, back references, assertions, recursive patterns, and comments are not supported. Escaping support is extremely fragile.

This method is also VERY slow. Use it only when no other formatter can generate the fake data you want. For instance, prefer calling $faker->email rather than regexify with the previous regular expression.

Also note than bothify can probably do most of what this method does, but much faster. For instance, for a dummy email generation, try $faker->bothify('?????????@???.???').

see
https://github.com/icomefromthenet/ReverseRegex

for a more robust implementation

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
example

$faker->shuffle([1, 2, 3]); // [2, 1, 3]

example

$faker->shuffle('hello, world'); // 'rlo,h eold!lw'

see
shuffleArray()
see
shuffleString()
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
see
http://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
example

$faker->shuffleArray([1, 2, 3]); // [2, 1, 3]

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
see
http://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
example

$faker->shuffleString('hello, world'); // 'rlo,h eold!lw'

Return values
string —

The shuffled set

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
throws
OverflowException

When no unique value can be found by iterating $maxRetries times

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
throws
OverflowException

When no valid value can be found by iterating $maxRetries times

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 —

Search results