Download the PHP package storefront/faker-minimal without Composer
On this page you can find all versions of the php package storefront/faker-minimal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download storefront/faker-minimal
More information about storefront/faker-minimal
Files in storefront/faker-minimal
Package faker-minimal
Short Description Minimal Faker is a PHP library that generates fake data for you. It's a fork of the original Faker, but reduced in size to only include what we need.
License MIT
Informations about the package faker-minimal
Minimal Faker - A fork of the original Faker, but reduced in size to only what we need
See the original, archived repo at: https://github.com/fzaninotto/Faker
- Our version only includes data for de_DE, en_GB, en_US, fr_FR, fr_BE, nl_BE and nl_NL, the countries we work for mostly.
- Other locales have been removed.
- ORM libraries have been removed.
- PHP support for 5.x was dropped.
Table of Contents
- Installation
- Basic Usage
- Formatters
- Base
- Lorem Ipsum Text
- Person
- Address
- Phone Number
- Company
- Date and Time
- Internet
- User Agent
- Payment
- Color
- File
- Image
- Uuid
- Barcode
- Miscellaneous
- Biased
- Html Lorem
- Modifiers
- Localization
- Seeding the Generator
- Faker Internals: Understanding Providers
- Real Life Usage
- Language specific formatters
- Third-Party Libraries Extending/Based On Faker
- License
Installation
Basic Usage
Autoloading
Faker supports both PSR-0
as PSR-4
autoloaders.
You can also load Fakers
shipped PSR-0
autoloader
alternatively, you can use any another PSR-4 compliant autoloader
Create fake data
Use Faker\Factory::create()
to create and initialize a faker generator, which can generate data by accessing properties named after the type of data you want.
Even if this example shows a property access, each call to $faker->name
yields a different (random) result. This is because Faker uses __get()
magic, and forwards Faker\Generator->$property
calls to Faker\Generator->format($property)
.
Tip: For a quick generation of fake data, you can also use Faker as a command line tool thanks to faker-cli.
Formatters
Each of the generator properties (like name
, address
, and lorem
) are called "formatters". A faker generator has many of them, packaged in "providers". Here is a list of the bundled formatters in the default locale.
Faker\Provider\Base
randomDigit // 7
randomDigitNot(5) // 0, 1, 2, 3, 4, 6, 7, 8, or 9
randomDigitNotNull // 5
randomNumber($nbDigits = NULL, $strict = false) // 79907610
randomFloat($nbMaxDecimals = NULL, $min = 0, $max = NULL) // 48.8932
numberBetween($min = 1000, $max = 9000) // 8567
randomLetter // 'b'
// returns randomly ordered subsequence of a provided array
randomElements($array = array ('a','b','c'), $count = 1) // array('c')
randomElement($array = array ('a','b','c')) // 'b'
shuffle('hello, world') // 'rlo,h eoldlw'
shuffle(array(1, 2, 3)) // array(2, 1, 3)
numerify('Hello ###') // 'Hello 609'
lexify('Hello ???') // 'Hello wgt'
bothify('Hello ##??') // 'Hello 42jz'
asciify('Hello ***') // 'Hello R6+'
regexify('[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}'); // [email protected]
Faker\Provider\Lorem
word // 'aut'
words($nb = 3, $asText = false) // array('porro', 'sed', 'magni')
sentence($nbWords = 6, $variableNbWords = true) // 'Sit vitae voluptas sint non voluptates.'
sentences($nb = 3, $asText = false) // array('Optio quos qui illo error.', 'Laborum vero a officia id corporis.', 'Saepe provident esse hic eligendi.')
paragraph($nbSentences = 3, $variableNbSentences = true) // 'Ut ab voluptas sed a nam. Sint autem inventore aut officia aut aut blanditiis. Ducimus eos odit amet et est ut eum.'
paragraphs($nb = 3, $asText = false) // array('Quidem ut sunt et quidem est accusamus aut. Fuga est placeat rerum ut. Enim ex eveniet facere sunt.', 'Aut nam et eum architecto fugit repellendus illo. Qui ex esse veritatis.', 'Possimus omnis aut incidunt sunt. Asperiores incidunt iure sequi cum culpa rem. Rerum exercitationem est rem.')
text($maxNbChars = 200) // 'Fuga totam reiciendis qui architecto fugiat nemo. Consequatur recusandae qui cupiditate eos quod.'
Faker\Provider\en_US\Person
title($gender = null|'male'|'female') // 'Ms.'
titleMale // 'Mr.'
titleFemale // 'Ms.'
suffix // 'Jr.'
name($gender = null|'male'|'female') // 'Dr. Zane Stroman'
firstName($gender = null|'male'|'female') // 'Maynard'
firstNameMale // 'Maynard'
firstNameFemale // 'Rachel'
lastName // 'Zulauf'
Faker\Provider\en_US\Address
cityPrefix // 'Lake'
secondaryAddress // 'Suite 961'
state // 'NewMexico'
stateAbbr // 'OH'
citySuffix // 'borough'
streetSuffix // 'Keys'
buildingNumber // '484'
city // 'West Judge'
streetName // 'Keegan Trail'
streetAddress // '439 Karley Loaf Suite 897'
postcode // '17916'
address // '8888 Cummings Vista Apt. 101, Susanbury, NY 95473'
country // 'Falkland Islands (Malvinas)'
latitude($min = -90, $max = 90) // 77.147489
longitude($min = -180, $max = 180) // 86.211205
Faker\Provider\en_US\PhoneNumber
phoneNumber // '201-886-0269 x3767'
tollFreePhoneNumber // '(888) 937-7238'
e164PhoneNumber // '+27113456789'
Faker\Provider\en_US\Company
catchPhrase // 'Monitored regional contingency'
bs // 'e-enable robust architectures'
company // 'Bogan-Treutel'
companySuffix // 'and Sons'
jobTitle // 'Cashier'
Faker\Provider\en_US\Text
realText($maxNbChars = 200, $indexSize = 2) // "And yet I wish you could manage it?) 'And what are they made of?' Alice asked in a shrill, passionate voice. 'Would YOU like cats if you were never even spoke to Time!' 'Perhaps not,' Alice replied."
Faker\Provider\DateTime
unixTime($max = 'now') // 58781813
dateTime($max = 'now', $timezone = null) // DateTime('2008-04-25 08:37:17', 'UTC')
dateTimeAD($max = 'now', $timezone = null) // DateTime('1800-04-29 20:38:49', 'Europe/Paris')
iso8601($max = 'now') // '1978-12-09T10:10:29+0000'
date($format = 'Y-m-d', $max = 'now') // '1979-06-09'
time($format = 'H:i:s', $max = 'now') // '20:49:42'
dateTimeBetween($startDate = '-30 years', $endDate = 'now', $timezone = null) // DateTime('2003-03-15 02:00:49', 'Africa/Lagos')
dateTimeInInterval($startDate = '-30 years', $interval = '+ 5 days', $timezone = null) // DateTime('2003-03-15 02:00:49', 'Antartica/Vostok')
dateTimeThisCentury($max = 'now', $timezone = null) // DateTime('1915-05-30 19:28:21', 'UTC')
dateTimeThisDecade($max = 'now', $timezone = null) // DateTime('2007-05-29 22:30:48', 'Europe/Paris')
dateTimeThisYear($max = 'now', $timezone = null) // DateTime('2011-02-27 20:52:14', 'Africa/Lagos')
dateTimeThisMonth($max = 'now', $timezone = null) // DateTime('2011-10-23 13:46:23', 'Antarctica/Vostok')
amPm($max = 'now') // 'pm'
dayOfMonth($max = 'now') // '04'
dayOfWeek($max = 'now') // 'Friday'
month($max = 'now') // '06'
monthName($max = 'now') // 'January'
year($max = 'now') // '1993'
century // 'VI'
timezone // 'Europe/Paris'
Methods accepting a $timezone
argument default to date_default_timezone_get()
. You can pass a custom timezone string to each method, or define a custom timezone for all time methods at once using $faker::setDefaultTimezone($timezone)
.
Faker\Provider\Internet
email // '[email protected]'
safeEmail // '[email protected]'
freeEmail // '[email protected]'
companyEmail // '[email protected]'
freeEmailDomain // 'yahoo.com'
safeEmailDomain // 'example.org'
userName // 'wade55'
password // 'k&|X+a45*2['
domainName // 'wolffdeckow.net'
domainWord // 'feeney'
tld // 'biz'
url // 'http://www.skilesdonnelly.biz/aut-accusantium-ut-architecto-sit-et.html'
slug // 'aut-repellat-commodi-vel-itaque-nihil-id-saepe-nostrum'
ipv4 // '109.133.32.252'
localIpv4 // '10.242.58.8'
ipv6 // '8e65:933d:22ee:a232:f1c1:2741:1f10:117c'
macAddress // '43:85:B7:08:10:CA'
Faker\Provider\UserAgent
userAgent // 'Mozilla/5.0 (Windows CE) AppleWebKit/5350 (KHTML, like Gecko) Chrome/13.0.888.0 Safari/5350'
chrome // 'Mozilla/5.0 (Macintosh; PPC Mac OS X 10_6_5) AppleWebKit/5312 (KHTML, like Gecko) Chrome/14.0.894.0 Safari/5312'
firefox // 'Mozilla/5.0 (X11; Linuxi686; rv:7.0) Gecko/20101231 Firefox/3.6'
safari // 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_1 rv:3.0; en-US) AppleWebKit/534.11.3 (KHTML, like Gecko) Version/4.0 Safari/534.11.3'
opera // 'Opera/8.25 (Windows NT 5.1; en-US) Presto/2.9.188 Version/10.00'
internetExplorer // 'Mozilla/5.0 (compatible; MSIE 7.0; Windows 98; Win 9x 4.90; Trident/3.0)'
Faker\Provider\Payment
creditCardType // 'MasterCard'
creditCardNumber // '4485480221084675'
creditCardExpirationDate // 04/13
creditCardExpirationDateString // '04/13'
creditCardDetails // array('MasterCard', '4485480221084675', 'Aleksander Nowak', '04/13')
// Generates a random IBAN. Set $countryCode to null for a random country
iban($countryCode) // 'IT31A8497112740YZ575DJ28BP4'
swiftBicNumber // 'RZTIAT22263'
Faker\Provider\Color
hexcolor // '#fa3cc2'
rgbcolor // '0,255,122'
rgbColorAsArray // array(0,255,122)
rgbCssColor // 'rgb(0,255,122)'
safeColorName // 'fuchsia'
colorName // 'Gainsbor'
hslColor // '340,50,20'
hslColorAsArray // array(340,50,20)
Faker\Provider\File
fileExtension // 'avi'
mimeType // 'video/x-msvideo'
// Copy a random file from the source to the target directory and returns the fullpath or filename
file($sourceDir = '/tmp', $targetDir = '/tmp') // '/path/to/targetDir/13b73edae8443990be1aa8f1a483bc27.jpg'
file($sourceDir, $targetDir, false) // '13b73edae8443990be1aa8f1a483bc27.jpg'
Faker\Provider\Image
// Image generation provided by LoremPixel (http://lorempixel.com/)
imageUrl($width = 640, $height = 480) // 'http://lorempixel.com/640/480/'
imageUrl($width, $height, 'cats') // 'http://lorempixel.com/800/600/cats/'
imageUrl($width, $height, 'cats', true, 'Faker') // 'http://lorempixel.com/800/400/cats/Faker'
imageUrl($width, $height, 'cats', true, 'Faker', true) // 'http://lorempixel.com/gray/800/400/cats/Faker/' Monochrome image
image($dir = '/tmp', $width = 640, $height = 480) // '/tmp/13b73edae8443990be1aa8f1a483bc27.jpg'
image($dir, $width, $height, 'cats') // 'tmp/13b73edae8443990be1aa8f1a483bc27.jpg' it's a cat!
image($dir, $width, $height, 'cats', false) // '13b73edae8443990be1aa8f1a483bc27.jpg' it's a filename without path
image($dir, $width, $height, 'cats', true, false) // it's a no randomize images (default: `true`)
image($dir, $width, $height, 'cats', true, true, 'Faker') // 'tmp/13b73edae8443990be1aa8f1a483bc27.jpg' it's a cat with 'Faker' text. Default, `null`.
Faker\Provider\Uuid
uuid // '7e57d004-2b97-0e7a-b45f-5387367791cd'
Faker\Provider\Barcode
ean13 // '4006381333931'
ean8 // '73513537'
isbn13 // '9790404436093'
isbn10 // '4881416324'
Faker\Provider\Miscellaneous
boolean // false
boolean($chanceOfGettingTrue = 50) // true
md5 // 'de99a620c50f2990e87144735cd357e7'
sha1 // 'f08e7f04ca1a413807ebc47551a40a20a0b4de5c'
sha256 // '0061e4c60dac5c1d82db0135a42e00c89ae3a333e7c26485321f24348c7e98a5'
locale // en_UK
countryCode // UK
languageCode // en
currencyCode // EUR
emoji // 😁
Faker\Provider\Biased
// get a random number between 10 and 20,
// with more chances to be close to 20
biasedNumberBetween($min = 10, $max = 20, $function = 'sqrt')
Faker\Provider\HtmlLorem
//Generate HTML document which is no more than 2 levels deep, and no more than 3 elements wide at any level.
randomHtml(2,3) // <html><head><title>Aut illo dolorem et accusantium eum.</title></head><body><form action="example.com" method="POST"><label for="username">sequi</label><input type="text" id="username"><label for="password">et</label><input type="password" id="password"></form><b>Id aut saepe non mollitia voluptas voluptas.</b><table><thead><tr><tr>Non consequatur.</tr><tr>Incidunt est.</tr><tr>Aut voluptatem.</tr><tr>Officia voluptas rerum quo.</tr><tr>Asperiores similique.</tr></tr></thead><tbody><tr><td>Sapiente dolorum dolorem sint laboriosam commodi qui.</td><td>Commodi nihil nesciunt eveniet quo repudiandae.</td><td>Voluptates explicabo numquam distinctio necessitatibus repellat.</td><td>Provident ut doloremque nam eum modi aspernatur.</td><td>Iusto inventore.</td></tr><tr><td>Animi nihil ratione id mollitia libero ipsa quia tempore.</td><td>Velit est officia et aut tenetur dolorem sed mollitia expedita.</td><td>Modi modi repudiandae pariatur voluptas rerum ea incidunt non molestiae eligendi eos deleniti.</td><td>Exercitationem voluptatibus dolor est iste quod molestiae.</td><td>Quia reiciendis.</td></tr><tr><td>Inventore impedit exercitationem voluptatibus rerum cupiditate.</td><td>Qui.</td><td>Aliquam.</td><td>Autem nihil aut et.</td><td>Dolor ut quia error.</td></tr><tr><td>Enim facilis iusto earum et minus rerum assumenda quis quia.</td><td>Reprehenderit ut sapiente occaecati voluptatum dolor voluptatem vitae qui velit.</td><td>Quod fugiat non.</td><td>Sunt nobis totam mollitia sed nesciunt est deleniti cumque.</td><td>Repudiandae quo.</td></tr><tr><td>Modi dicta libero quisquam doloremque qui autem.</td><td>Voluptatem aliquid saepe laudantium facere eos sunt dolor.</td><td>Est eos quis laboriosam officia expedita repellendus quia natus.</td><td>Et neque delectus quod fugit enim repudiandae qui.</td><td>Fugit soluta sit facilis facere repellat culpa magni voluptatem maiores tempora.</td></tr><tr><td>Enim dolores doloremque.</td><td>Assumenda voluptatem eum perferendis exercitationem.</td><td>Quasi in fugit deserunt ea perferendis sunt nemo consequatur dolorum soluta.</td><td>Maxime repellat qui numquam voluptatem est modi.</td><td>Alias rerum rerum hic hic eveniet.</td></tr><tr><td>Tempore voluptatem.</td><td>Eaque.</td><td>Et sit quas fugit iusto.</td><td>Nemo nihil rerum dignissimos et esse.</td><td>Repudiandae ipsum numquam.</td></tr><tr><td>Nemo sunt quia.</td><td>Sint tempore est neque ducimus harum sed.</td><td>Dicta placeat atque libero nihil.</td><td>Et qui aperiam temporibus facilis eum.</td><td>Ut dolores qui enim et maiores nesciunt.</td></tr><tr><td>Dolorum totam sint debitis saepe laborum.</td><td>Quidem corrupti ea.</td><td>Cum voluptas quod.</td><td>Possimus consequatur quasi dolorem ut et.</td><td>Et velit non hic labore repudiandae quis.</td></tr></tbody></table></body></html>
Modifiers
Faker provides three special providers, unique()
, optional()
, and valid()
, to be called before any provider.
If you would like to use a modifier with a value not generated by Faker, use the passthrough()
method. passthrough()
simply returns whatever value it was given.
Localization
Faker\Factory
can take a locale as an argument, to return localized data. If no localized provider is found, the factory fallbacks to the default locale (en_US).
You can check available Faker locales in the source code, under the Provider
directory. The localization of Faker is an ongoing process, for which we need your help. Don't hesitate to create localized providers to your own locale and submit a PR!
Seeding the Generator
You may want to get always the same generated data - for instance when using Faker for unit testing purposes. The generator offers a seed()
method, which seeds the random number generator. Calling the same script twice with the same seed produces the same results.
Tip: DateTime formatters won't reproduce the same fake data if you don't fix the
$max
value:Tip: Formatters won't reproduce the same fake data if you use the
rand()
php function. Use$faker
ormt_rand()
instead:
Faker Internals: Understanding Providers
A Faker\Generator
alone can't do much generation. It needs Faker\Provider
objects to delegate the data generation to them. Faker\Factory::create()
actually creates a Faker\Generator
bundled with the default providers. Here is what happens under the hood:
`
Whenever you try to access a property on the $faker
object, the generator looks for a method with the same name in all the providers attached to it. For instance, calling $faker->name
triggers a call to Faker\Provider\Person::name()
. And since Faker starts with the last provider, you can easily override existing formatters: just add a provider containing methods named after the formatters you want to override.
That means that you can easily add your own providers to a Faker\Generator
instance. A provider is usually a class extending \Faker\Provider\Base
. This parent class allows you to use methods like lexify()
or randomNumber()
; it also gives you access to formatters of other providers, through the protected $generator
property. The new formatters are the public methods of the provider class.
Here is an example provider for populating Book data:
To register this provider, just add a new instance of \Faker\Provider\Book
to an existing generator:
Now you can use the two new formatters like any other Faker formatter:
Tip: A provider can also be a Plain Old PHP Object. In that case, all the public methods of the provider become available to the generator.
Real Life Usage
The following script generates a valid XML document:
Running this script produces a document looking like:
Language specific formatters
Faker\Provider\ar_SA\Person
Faker\Provider\ar_SA\Payment
Faker\Provider\at_AT\Payment
Faker\Provider\bg_BG\Payment
Faker\Provider\cs_CZ\Address
Faker\Provider\cs_CZ\Company
Faker\Provider\cs_CZ\DateTime
Faker\Provider\cs_CZ\Person
Faker\Provider\da_DK\Person
Faker\Provider\da_DK\Address
Faker\Provider\da_DK\Company
Faker\Provider\de_CH\Person
Faker\Provider\de_DE\Payment
Faker\Provider\en_HK\Address
Faker\Provider\en_HK\Phone
Faker\Provider\en_NG\Address
Faker\Provider\en_NG\Person
Faker\Provider\en_NZ\Phone
Faker\Provider\en_US\Company
Faker\Provider\en_US\Payment
Faker\Provider\en_US\Person
Faker\Provider\en_ZA\Company
Faker\Provider\en_ZA\Person
Faker\Provider\en_ZA\PhoneNumber
Faker\Provider\es_ES\Person
Faker\Provider\es_ES\Payment
Faker\Provider\es_ES\PhoneNumber
Faker\Provider\es_PE\Person
Faker\Provider\fa_IR\Person
Faker\Provider\fa_IR\Address
Faker\Provider\fa_IR\Company
Faker\Provider\fi_FI\Payment
Faker\Provider\fi_FI\Person
Faker\Provider\fr_BE\Payment
Faker\Provider\es_VE\Person
Faker\Provider\es_VE\Company
Faker\Provider\fr_CH\Person
Faker\Provider\fr_FR\Address
Faker\Provider\fr_FR\Company
Faker\Provider\fr_FR\Payment
Faker\Provider\fr_FR\Person
Faker\Provider\fr_FR\PhoneNumber
Faker\Provider\he_IL\Payment
Faker\Provider\hr_HR\Payment
Faker\Provider\hu_HU\Payment
Faker\Provider\id_ID\Person
Faker\Provider\it_CH\Person
Faker\Provider\it_IT\Company
Faker\Provider\it_IT\Person
Faker\Provider\ja_JP\Person
Faker\Provider\ka_GE\Payment
Faker\Provider\kk_KZ\Company
Faker\Provider\kk_KZ\Payment
Faker\Provider\kk_KZ\Person
Faker\Provider\ko_KR\Address
Faker\Provider\ko_KR\PhoneNumber
Faker\Provider\lt_LT\Payment
Faker\Provider\lv_LV\Person
Faker\Provider\ms_MY\Address
Faker\Provider\ms_MY\Miscellaneous
Faker\Provider\ms_MY\Payment
Faker\Provider\ms_MY\Person
Faker\Provider\ms_MY\PhoneNumber
Faker\Provider\ne_NP\Address
Faker\Provider\nl_BE\Payment
Faker\Provider\nl_BE\Person
Faker\Provider\nl_NL\Company
Faker\Provider\nl_NL\Person
Faker\Provider\nb_NO\MobileNumber
Faker\Provider\nb_NO\Payment
Faker\Provider\pl_PL\Person
Faker\Provider\pl_PL\Company
Faker\Provider\pl_PL\Payment
Faker\Provider\pt_PT\Person
Faker\Provider\pt_BR\Address
Faker\Provider\pt_BR\PhoneNumber
Faker\Provider\pt_BR\Person
Faker\Provider\pt_BR\Company
Faker\Provider\ro_MD\Payment
Faker\Provider\ro_RO\Payment
Faker\Provider\ro_RO\Person
Faker\Provider\ro_RO\PhoneNumber
Faker\Provider\ru_RU\Payment
Faker\Provider\sv_SE\Payment
Faker\Provider\sv_SE\Person
Faker\Provider\tr_TR\Person
Faker\Provider\zh_CN\Payment
Faker\Provider\uk_UA\Payment
Faker\Provider\zh_TW\Person
Faker\Provider\zh_TW\Company
License
Faker is released under the MIT License. See the bundled LICENSE file for details.