HumHub Documentation (unofficial)

Address extends Address
in package

Application

Properties

$addressFormats : mixed
$buildingNumber : mixed
$buildingPrefix : mixed: Most of the time 'No.' is not needed, and 'Lot' is less used.
$cityFormats : mixed
$citySuffix : mixed
$country : mixed
$generator : Generator
$postcode : mixed
$states : mixed
$streetAddressFormats : mixed
$streetNameFormats : mixed
$streetPrefix : mixed: 'Jalan' & 'Jln' are more frequently used than 'Lorong'
$streetSuffix : mixed
$towns : mixed
$townshipFormats : mixed
$townshipPrefix : mixed: 'Bandar' and 'Taman' are the most common township prefix
$townshipPrefixAbbr : mixed
$townshipSuffix : mixed
$unique : UniqueGenerator

Methods

__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: Return a building number
buildingPrefix() : string: Return a building prefix
city() : string: Return a random city (town)
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: Return a postcode based on state
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() : string: Return a random state
streetAddress() : string
streetName() : string: Return a complete streename
streetPrefix() : mixed: Return a street prefix
streetSuffix() : string
toLower() : string: Converts string to lowercase.
toUpper() : string: Converts string to uppercase.
township() : string: Return a randown township
townshipPrefix() : string: Return a township prefix
townshipPrefixAbbr() : string: Return a township prefix abbreviation
townshipSuffix() : mixed: Return a township suffix
townState() : string: Return the complete town address with matching postcode and state
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}}, {{township}}, {{townState}}']

$buildingNumber


    protected
    static    mixed
    $buildingNumber
     = ['%', '%', '%', '%#', '%#', '%#', '%#', '%##', '%-%', '?-##-##', '%?-##']

$buildingPrefix

Most of the time 'No.' is not needed, and 'Lot' is less used.


    protected
    static    mixed
    $buildingPrefix
     = ['', '', '', '', '', '', 'No. ', 'No. ', 'No. ', 'Lot ']

$cityFormats


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

$citySuffix


    protected
    static    mixed
    $citySuffix
     = ['Ville']

$country


    protected
    static    mixed
    $country
     = ['Abkhazia', 'Afghanistan', 'Afrika Selatan', 'Republik Afrika Tengah', 'Akrotiri dan Dhekelia', 'Albania', 'Algeria', 'Amerika Syarikat', 'Andorra', 'Angola', 'Antigua dan Barbuda', 'Arab Saudi', 'Argentina', 'Armenia', 'Australia', 'Austria', 'Azerbaijan', 'Bahamas', 'Bahrain', 'Bangladesh', 'Barbados', 'Belanda', 'Belarus', 'Belgium', 'Belize', 'Benin', 'Bhutan', 'Bolivia', 'Bonaire', 'Bosnia dan Herzegovina', 'Botswana', 'Brazil', 'Brunei Darussalam', 'Bulgaria', 'Burkina Faso', 'Burundi', 'Cameroon', 'Chad', 'Chile', 'Republik Rakyat China', 'Republik China di Taiwan', 'Colombia', 'Comoros', 'Republik Demokratik Congo', 'Republik Congo', 'Kepulauan Cook', 'Costa Rica', 'Côte d\'Ivoire (Ivory Coast)', 'Croatia', 'Cuba', 'Curaçao', 'Cyprus', 'Republik Turki Cyprus Utara', 'Republik Czech', 'Denmark', 'Djibouti', 'Dominika', 'Republik Dominika', 'Ecuador', 'El Salvador', 'Emiriah Arab Bersatu', 'Eritrea', 'Estonia', 'Kepulauan Faroe', 'Fiji', 'Filipina', 'Finland', 'Gabon', 'Gambia', 'Georgia', 'Ghana', 'Grenada', 'Greece (Yunani)', 'Guatemala', 'Guinea', 'Guinea-Bissau', 'Guinea Khatulistiwa', 'Guiana Perancis', 'Guyana', 'Habsyah (Etiopia)', 'Haiti', 'Honduras', 'Hungary', 'Iceland', 'India', 'Indonesia', 'Iran', 'Iraq', 'Ireland', 'Israel', 'Itali', 'Jamaika', 'Jepun', 'Jerman', 'Jordan', 'Kanada', 'Kazakhstan', 'Kemboja', 'Kenya', 'Kiribati', 'Korea Selatan', 'Korea Utara', 'Kosovo', 'Kuwait', 'Kyrgyzstan', 'Laos', 'Latvia', 'Lesotho', 'Liberia', 'Libya', 'Liechtenstein', 'Lithuania', 'Lubnan', 'Luxembourg', 'Macedonia', 'Madagaskar', 'Maghribi', 'Malawi', 'Malaysia', 'Maldives', 'Mali', 'Malta', 'Kepulauan Marshall', 'Mauritania', 'Mauritius', 'Mesir', 'Mexico', 'Persekutuan Micronesia', 'Moldova', 'Monaco', 'Montenegro', 'Mongolia', 'Mozambique', 'Myanmar', 'Namibia', 'Nauru', 'Nepal', 'New Zealand', 'Nicaragua', 'Niger', 'Nigeria', 'Niue', 'Norway', 'Oman', 'Ossetia Selatan', 'Pakistan', 'Palau', 'Palestin', 'Panama', 'Papua New Guinea', 'Paraguay', 'Perancis', 'Peru', 'Poland', 'Portugal', 'Qatar', 'Romania', 'Russia', 'Rwanda', 'Sahara Barat', 'Saint Kitts dan Nevis', 'Saint Lucia', 'Saint Vincent dan Grenadines', 'Samoa', 'San Marino', 'São Tomé dan Príncipe', 'Scotland', 'Senegal', 'Sepanyol', 'Serbia', 'Seychelles', 'Sierra Leone', 'Singapura', 'Slovakia', 'Slovenia', 'Kepulauan Solomon', 'Somalia', 'Somaliland', 'Sri Lanka', 'Sudan', 'Sudan Selatan', 'Suriname', 'Swaziland', 'Sweden', 'Switzerland', 'Syria', 'Tajikistan', 'Tanjung Verde', 'Tanzania', 'Thailand', 'Timor Leste', 'Togo', 'Tonga', 'Transnistria', 'Trinidad dan Tobago', 'Tunisia', 'Turki', 'Turkmenistan', 'Tuvalu', 'Uganda', 'Ukraine', 'United Kingdom', 'Uruguay', 'Uzbekistan', 'Vanuatu', 'Kota Vatican', 'Venezuela', 'Vietnam', 'Yaman', 'Zambia', 'Zimbabwe']

$generator


    protected
        Generator
    $generator

$postcode


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

$states


    protected
    static    mixed
    $states
     = ['johor' => ['Johor Darul Ta\'zim', 'Johor'], 'kedah' => ['Kedah Darul Aman', 'Kedah'], 'kelantan' => ['Kelantan Darul Naim', 'Kelantan'], 'kl' => ['KL', 'Kuala Lumpur', 'WP Kuala Lumpur'], 'labuan' => ['Labuan'], 'melaka' => ['Malacca', 'Melaka'], 'nsembilan' => ['Negeri Sembilan Darul Khusus', 'Negeri Sembilan'], 'pahang' => ['Pahang Darul Makmur', 'Pahang'], 'penang' => ['Penang', 'Pulau Pinang'], 'perak' => ['Perak Darul Ridzuan', 'Perak'], 'perlis' => ['Perlis Indera Kayangan', 'Perlis'], 'putrajaya' => ['Putrajaya'], 'sabah' => ['Sabah'], 'sarawak' => ['Sarawak'], 'selangor' => ['Selangor Darul Ehsan', 'Selangor'], 'terengganu' => ['Terengganu Darul Iman', 'Terengganu']]

$streetAddressFormats


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

$streetNameFormats


    protected
    static    mixed
    $streetNameFormats
     = ['{{streetPrefix}} %', '{{streetPrefix}} %/%', '{{streetPrefix}} %/%#', '{{streetPrefix}} %/%?', '{{streetPrefix}} %/%#?', '{{streetPrefix}} %?', '{{streetPrefix}} %#?', '{{streetPrefix}} {{streetSuffix}}', '{{streetPrefix}} {{streetSuffix}} %', '{{streetPrefix}} {{streetSuffix}} %/%', '{{streetPrefix}} {{streetSuffix}} %/%#', '{{streetPrefix}} {{streetSuffix}} %/%?', '{{streetPrefix}} {{streetSuffix}} %/%#?', '{{streetPrefix}} {{streetSuffix}} %?', '{{streetPrefix}} {{streetSuffix}} %#?']

$streetPrefix

'Jalan' & 'Jln' are more frequently used than 'Lorong'


    protected
    static    mixed
    $streetPrefix
     = ['Jln', 'Jln', 'Jalan', 'Jalan', 'Jalan', 'Lorong']

$streetSuffix


    protected
    static    mixed
    $streetSuffix
     = ['Air Itam', 'Alor', 'Ampang', 'Ampang Hilir', 'Anson', 'Ariffin', 'Bangsar', 'Baru', 'Bellamy', 'Birch', 'Bijih Timah', 'Bukit Aman', 'Bukit Bintang', 'Bukit Petaling', 'Bukit Tunku', 'Cantonment', 'Cenderawasih', 'Chan Sow Lin', 'Chow Kit', 'Cinta', 'Cochrane', 'Conlay', 'D. S. Ramanathan', 'Damansara', 'Dang Wangi', 'Davis', 'Dewan Bahasa', 'Dato Abdul Rahman', 'Dato\'Keramat', 'Dato\' Maharaja Lela', 'Doraisamy', 'Eaton', 'Faraday', 'Galloway', 'Genting Klang', 'Gereja', 'Hang Jebat', 'Hang Kasturi', 'Hang Lekir', 'Hang Lekiu', 'Hang Tuah', 'Hospital', 'Imbi', 'Istana', 'Jelutong', 'Kampung Attap', 'Kebun Bunga', 'Kedah', 'Keliling', 'Kia Peng', 'Kinabalu', 'Kuala Kangsar', 'Kuching', 'Ledang', 'Lembah Permai', 'Loke Yew', 'Lt. Adnan', 'Lumba Kuda', 'Madras', 'Magazine', 'Maharajalela', 'Masjid', 'Maxwell', 'Mohana Chandran', 'Muda', 'P. Ramlee', 'Padang Kota Lama', 'Pahang', 'Pantai Baharu', 'Parlimen', 'Pasar', 'Pasar Besar', 'Perak', 'Perdana', 'Petaling', 'Prangin', 'Pudu', 'Pudu Lama', 'Raja', 'Raja Abdullah', 'Raja Chulan', 'Raja Laut', 'Rakyat', 'Residensi', 'Robson', 'S.P. Seenivasagam', 'Samarahan 1', 'Selamat', 'Sempadan', 'Sentul', 'Serian 1', 'Sasaran', 'Sin Chee', 'Sultan Abdul Samad', 'Sultan Azlan Shah', 'Sultan Iskandar', 'Sultan Ismail', 'Sultan Sulaiman', 'Sungai Besi', 'Syed Putra', 'Tan Cheng Lock', 'Thambipillay', 'Tugu', 'Tuanku Abdul Halim', 'Tuanku Abdul Rahman', 'Tun Abdul Razak', 'Tun Dr Ismail', 'Tun H S Lee', 'Tun Ismail', 'Tun Perak', 'Tun Razak', 'Tun Sambanthan', 'U-Thant', 'Utama', 'Vermont', 'Vivekananda', 'Wan Kadir', 'Wesley', 'Wisma Putra', 'Yaacob Latif', 'Yap Ah Loy', 'Yap Ah Shak', 'Yap Kwan Seng', 'Yew', 'Zaaba', 'Zainal Abidin']

$towns


    protected
    static    mixed
    $towns
     = ['johor' => ['Ayer Hitam', 'Batu Pahat', 'Bukit Gambir', 'Bukit Kepong', 'Bukit Naning', 'Desaru', 'Endau', 'Gelang Patah', 'Gemas Baharu', 'Iskandar Puteri', 'Jementah', 'Johor Lama', 'Johor Bahru', 'Kempas', 'Kluang', 'Kota Iskandar', 'Kota Tinggi', 'Kukup', 'Kulai', 'Labis ', 'Larkin', 'Layang-Layang', 'Mersing', 'Muar', 'Pagoh', 'Paloh', 'Parit Jawa', 'Pasir Gudang', 'Pekan Nanas', 'Permas Jaya', 'Pontian Kechil', 'Renggam', 'Segamat', 'Senai', 'Simpang Renggam', 'Skudai', 'Sri Gading', 'Tangkak', 'Tebrau', 'Ulu Tiram', 'Yong Peng'], 'kedah' => ['Alor Setar', 'Baling', 'Bukit Kayu Hitam', 'Changlun', 'Durian Burung', 'Gurun', 'Jitra', 'Kepala Batas', 'Kuah', 'Kuala Kedah', 'Kuala Ketil', 'Kulim', 'Langgar', 'Lunas', 'Merbok', 'Padang Serai', 'Pendang', 'Serdang', 'Sintok', 'Sungai Petani', 'Tawar, Baling', 'Yan'], 'kelantan' => ['Bachok', 'Bunut Payong', 'Dabong', 'Gua Musang', 'Jeli', 'Ketereh', 'Kota Bharu', 'Kuala Krai', 'Lojing', 'Machang', 'Pasir Mas', 'Pasir Puteh', 'Rantau Panjang', 'Salor', 'Tok Bali', 'Wakaf Bharu', 'Wakaf Che Yeh'], 'kl' => ['Ampang', 'Bandar Tasik Selatan', 'Bandar Tun Razak', 'Bangsar', 'Batu', 'Brickfields', 'Bukit Bintang', 'Bukit Jalil', 'Bukit Tunku', 'Cheras', 'Chow Kit', 'Damansara Town Centre', 'Dang Wangi', 'Desa Petaling', 'Desa Tun Hussein Onn', 'Jinjang', 'Kampung Baru', 'Kampung Kasipillay', 'Kampung Pandan', 'Kampung Sungai Penchala', 'Kepong', 'KLCC', 'Kuchai Lama', 'Lake Gardens', 'Lembah Pantai', 'Medan Tuanku', 'Mid Valley City', 'Mont Kiara', 'Pantai Dalam', 'Pudu', 'Salak South', 'Segambut', 'Semarak', 'Sentul', 'Setapak', 'Setiawangsa', 'Seputeh', 'Sri Hartamas', 'Sri Petaling', 'Sungai Besi', 'Taman Desa', 'Taman Melawati', 'Taman OUG', 'Taman Tun Dr Ismail', 'Taman U-Thant', 'Taman Wahyu', 'Titiwangsa', 'Tun Razak Exchange', 'Wangsa Maju'], 'labuan' => ['Batu Manikar', 'Kiamsam', 'Layang-Layang', 'Rancha-Rancha'], 'melaka' => ['Alor Gajah', 'Bandaraya Melaka', 'Batu Berendam', 'Bukit Beruang', 'Bukit Katil', 'Cheng', 'Durian Tunggal', 'Hang Tuah Jaya', 'Jasin', 'Klebang', 'Lubuk China', 'Masjid Tanah', 'Naning', 'Pekan Asahan', 'Ramuan China', 'Simpang Ampat', 'Tanjung Bidara', 'Telok Mas', 'Umbai'], 'nsembilan' => ['Ayer Kuning', 'Ampangan', 'Bahau', 'Batang Benar', 'Chembong', 'Dangi', 'Gemas', 'Juasseh', 'Kuala Pilah', 'Labu', 'Lenggeng', 'Linggi', 'Mantin', 'Nilai', 'Pajam', 'Pedas', 'Pengkalan Kempas', 'Port Dickson', 'Rantau', 'Rompin', 'Senawang', 'Seremban', 'Sungai Gadut', 'Tampin', 'Tiroi'], 'pahang' => ['Bandar Tun Razak', 'Bentong', 'Brinchang', 'Bukit Fraser', 'Bukit Tinggi', 'Chendor', 'Gambang', 'Genting Highlands', 'Genting Sempah', 'Jerantut', 'Karak', 'Kemayan', 'Kota Shahbandar', 'Kuala Lipis', 'Kuala Pahang', 'Kuala Rompin', 'Kuantan', 'Lanchang', 'Lubuk Paku', 'Maran', 'Mengkuang', 'Mentakab', 'Nenasi', 'Panching', 'Pekan', 'Penor', 'Raub', 'Sebertak', 'Sungai Lembing', 'Tanah Rata', 'Tanjung Sepat', 'Tasik Chini', 'Temerloh', 'Teriang', 'Tringkap'], 'penang' => ['Air Itam', 'Balik Pulau', 'Batu Ferringhi', 'Batu Kawan', 'Bayan Lepas', 'Bukit Mertajam', 'Butterworth', 'Gelugor', 'George Town', 'Jelutong', 'Kepala Batas', 'Nibong Tebal', 'Permatang Pauh', 'Pulau Tikus', 'Simpang Ampat', 'Tanjung Bungah', 'Tanjung Tokong'], 'perak' => ['Ayer Tawar', 'Bagan Serai', 'Batu Gajah', 'Behrang', 'Bidor', 'Bukit Gantang', 'Bukit Merah', 'Changkat Jering', 'Chemor', 'Chenderiang', 'Damar Laut', 'Gerik', 'Gopeng', 'Gua Tempurung', 'Hutan Melintang', 'Ipoh', 'Jelapang', 'Kamunting', 'Kampar', 'Kuala Kangsar', 'Lekir', 'Lenggong', 'Lumut', 'Malim Nawar', 'Manong', 'Menglembu', 'Pantai Remis', 'Parit', 'Parit Buntar', 'Pasir Salak', 'Proton City', 'Simpang Pulai', 'Sitiawan', 'Slim River', 'Sungai Siput', 'Sungkai', 'Taiping', 'Tambun', 'Tanjung Malim', 'Tanjung Rambutan', 'Tapah', 'Teluk Intan', 'Ulu Bernam'], 'perlis' => ['Arau', 'Beseri', 'Chuping', 'Kaki Bukit', 'Kangar', 'Kuala Perlis', 'Mata Ayer', 'Padang Besar', 'Sanglang', 'Simpang Empat', 'Wang Kelian'], 'putrajaya' => ['Precinct 1', 'Precinct 4', 'Precinct 5', 'Precinct 6', 'Precinct 8', 'Precinct 10', 'Precinct 11', 'Precinct 12', 'Precinct 13', 'Precinct 16', 'Precinct 18', 'Precinct 19'], 'sabah' => ['Beaufort', 'Bingkor', 'Donggongon', 'Inanam', 'Kinabatangan', 'Kota Belud', 'Kota Kinabalu', 'Kuala Penyu', 'Kimanis', 'Kundasang', 'Lahad Datu', 'Likas', 'Lok Kawi', 'Manggatal', 'Nabawan', 'Papar', 'Pitas', 'Ranau', 'Sandakan', 'Sapulut', 'Semporna', 'Sepanggar', 'Tambunan', 'Tanjung Aru', 'Tawau', 'Tenom', 'Tuaran', 'Weston'], 'sarawak' => ['Asajaya', 'Ba\'kelalan', 'Bario', 'Batu Kawa', 'Batu Niah', 'Betong', 'Bintulu', 'Dalat', 'Daro', 'Engkilili', 'Julau', 'Kapit', 'Kota Samarahan', 'Kuching', 'Lawas', 'Limbang', 'Lubok Antu', 'Marudi', 'Matu', 'Miri', 'Oya', 'Pakan', 'Sadong Jaya', 'Sematan', 'Sibu', 'Siburan', 'Song', 'Sri Aman', 'Sungai Tujoh', 'Tanjung Kidurong', 'Tanjung Manis', 'Tatau'], 'selangor' => ['Ampang', 'Assam Jawa', 'Balakong', 'Bandar Baru Bangi', 'Bandar Baru Selayang', 'Bandar Sunway', 'Bangi', 'Banting', 'Batang Kali', 'Batu Caves', 'Bestari Jaya', 'Bukit Lanjan', 'Cheras', 'Cyberjaya', 'Damansara', 'Dengkil', 'Ijok', 'Jenjarom', 'Kajang', 'Kelana Jaya', 'Klang', 'Kuala Kubu Bharu', 'Kuala Selangor', 'Kuang', 'Lagong', 'Morib', 'Pandamaran', 'Paya Jaras', 'Petaling Jaya', 'Port Klang', 'Puchong', 'Rasa', 'Rawang', 'Salak Tinggi', 'Sekinchan', 'Selayang', 'Semenyih', 'Sepang', 'Serendah', 'Seri Kembangan', 'Shah Alam', 'Subang', 'Subang Jaya', 'Sungai Buloh', 'Tanjung Karang', 'Tanjung Sepat', 'Ulu Klang', 'Ulu Yam'], 'terengganu' => ['Ajil', 'Bandar Ketengah Jaya', 'Bandar Permaisuri', 'Bukit Besi', 'Bukit Payong', 'Chukai', 'Jerteh', 'Kampung Raja', 'Kerteh', 'Kijal', 'Kuala Besut', 'Kuala Berang', 'Kuala Dungun', 'Kuala Terengganu', 'Marang', 'Merchang', 'Pasir Raja', 'Rantau Abang', 'Teluk Kalung', 'Wakaf Tapai']]

$townshipFormats


    protected
    static    mixed
    $townshipFormats
     = ['{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefix}} {{townshipSuffix}}', '{{townshipPrefixAbbr}}%', '{{townshipPrefixAbbr}}%#', '{{townshipPrefixAbbr}}%#?']

$townshipPrefix

'Bandar' and 'Taman' are the most common township prefix


    protected
    static    mixed
    $townshipPrefix
     = ['Alam', 'Apartment', 'Ara', 'Bandar', 'Bandar', 'Bandar', 'Bandar', 'Bandar', 'Bandar', 'Bandar Bukit', 'Bandar Seri', 'Bandar Sri', 'Bandar Baru', 'Batu', 'Bukit', 'Desa', 'Damansara', 'Kampung', 'Kampung Baru', 'Kampung Baru', 'Kondominium', 'Kota', 'Laman', 'Lembah', 'Medan', 'Pandan', 'Pangsapuri', 'Petaling', 'Puncak', 'Seri', 'Sri', 'Taman', 'Taman', 'Taman', 'Taman', 'Taman', 'Taman', 'Taman Desa']

$townshipPrefixAbbr


    protected
    static    mixed
    $townshipPrefixAbbr
     = ['SS', 'Seksyen ', 'PJS', 'PJU', 'USJ ']

$townshipSuffix


    protected
    static    mixed
    $townshipSuffix
     = ['Aman', 'Amanjaya', 'Anggerik', 'Angkasa', 'Antarabangsa', 'Awan', 'Bahagia', 'Bangsar', 'Baru', 'Belakong', 'Bendahara', 'Bestari', 'Bintang', 'Brickfields', 'Casa', 'Changkat', 'Country Heights', 'Damansara', 'Damai', 'Dato Harun', 'Delima', 'Duta', 'Flora', 'Gembira', 'Genting', 'Harmoni', 'Hartamas', 'Impian', 'Indah', 'Intan', 'Jasa', 'Jaya', 'Keramat', 'Kerinchi', 'Kiara', 'Kinrara', 'Kuchai', 'Laksamana', 'Mahkota', 'Maluri', 'Manggis', 'Maxwell', 'Medan', 'Melawati', 'Menjalara', 'Meru', 'Mulia', 'Mutiara', 'Pahlawan', 'Perdana', 'Pertama', 'Permai', 'Pelangi', 'Petaling', 'Pinang', 'Puchong', 'Puteri', 'Putra', 'Rahman', 'Rahmat', 'Raya', 'Razak', 'Ria', 'Saujana', 'Segambut', 'Selamat', 'Selatan', 'Semarak', 'Sentosa', 'Seputeh', 'Setapak', 'Setia Jaya', 'Sinar', 'Sungai Besi', 'Sungai Buaya', 'Sungai Long', 'Suria', 'Tasik Puteri', 'Tengah', 'Timur', 'Tinggi', 'Tropika', 'Tun Hussein Onn', 'Tun Perak', 'Tunku', 'Ulu', 'Utama', 'Utara', 'Wangi']

$unique


    protected
        UniqueGenerator
    $unique

__construct()


    public
                    __construct(Generator $generator) : mixed

Parameters

$generator : Generator

address()


    public
                    address() : string

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

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 be parsed

Return values

string

buildingNumber()

Return a building number


    public
            static        buildingNumber() : string

Return values

string

buildingPrefix()

Return a building prefix


    public
            static        buildingPrefix() : string

Return values

string

city()

Return a random city (town)


    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 = 0 ][, int $int2 = 2147483647 ]) : int

Parameters

$int1 : int = 0: 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

postcode()

Return a postcode based on state


    public
            static        postcode([string|null $state = null ]) : string

Parameters

$state : string|null = null: 'state' or null

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>|class-string|Traversable $array = ['a', 'b', 'c'] ]) : mixed

Parameters

$array : array<string|int, mixed>|class-string|Traversable = ['a', 'b', 'c']

randomElements()

Returns randomly ordered subsequence of $count elements from a provided array


    public
            static        randomElements([array<string|int, mixed>|class-string|Traversable $array = ['a', 'b', 'c'] ][, int|null $count = 1 ][, bool $allowDuplicates = false ]) : array<string|int, mixed>

Parameters

$array : array<string|int, mixed>|class-string|Traversable = ['a', 'b', 'c']: Array to take elements from. Defaults to a-c
$count : int|null = 1: Number of elements to take. If null then returns random number of elements
$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 = 0 ][, float|int $max = null ]) : float

Parameters

$nbMaxDecimals : int = null
$min : float|int = 0
$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()

Return a random state


    public
                    state() : string

Return values

string

streetAddress()


    public
                    streetAddress() : string

Return values

string

streetName()

Return a complete streename


    public
                    streetName() : string

Return values

string

streetPrefix()

Return a street prefix


    public
                    streetPrefix() : mixed

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

township()

Return a randown township


    public
                    township() : string

Return values

string

townshipPrefix()

Return a township prefix


    public
                    townshipPrefix() : string

Return values

string

townshipPrefixAbbr()

Return a township prefix abbreviation


    public
                    townshipPrefixAbbr() : string

Return values

string

townshipSuffix()

Return a township suffix


    public
                    townshipSuffix() : mixed

townState()

Return the complete town address with matching postcode and state


    public
                    townState() : string

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

Parameters

$string : mixed
$wildcard : mixed
$callback : mixed

Address extends Address in package Application

Table of Contents

Properties

Methods

Properties

$addressFormats

Tags

$buildingNumber

$buildingPrefix

$cityFormats

$citySuffix

$country

Tags

$generator

$postcode

$states

Tags

$streetAddressFormats

$streetNameFormats

$streetPrefix

Tags

$streetSuffix

Tags

$towns

Tags

$townshipFormats

$townshipPrefix

Tags

$townshipPrefixAbbr

Tags

$townshipSuffix

$unique

Methods

__construct()

Parameters

address()

Tags

Return values

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

buildingNumber()

Tags

Return values

buildingPrefix()

Tags

Return values

city()

Tags

Return values

citySuffix()

Tags

Return values

country()

Tags

Return values

latitude()

Parameters

Tags

Return values

lexify()

Parameters

Return values

localCoordinates()

Tags

Return values

longitude()

Parameters

Tags

Address extends Address
in package

Application