Faker

If your codebase uses Faker properties (which are deprecated), you can automate the migration to their equivalent methods using Rector.

1. Install Rector:

composer require --dev rector/rector

2. Run the migration process (replace src/ with your actual source directory):

vendor/bin/rector process src/ --config vendor/fakerphp/faker/rector-migrate.php

Alternatively, you can import the Faker migration configuration directly into your existing rector.php file:

<?php

declare(strict_types=1);

use Rector\Config;

return static function (Config\RectorConfig $rectorConfig): void {
    $rectorConfig->import('vendor/fakerphp/faker/rector-migrate.php');
};

Faker requires PHP >= 7.4. Install the library using Composer to add it to your project.

composer require fakerphp/faker

To generate fake data, use Faker\Factory::create() to initialize a Faker\Generator instance. You can then call methods on the generator instance named after the type of data you wish to produce (e.g., name(), email(), text()). Each call produces a different random result.

<?php

declare(strict_types=1);

require_once 'vendor/autoload.php';

// use the factory to create a Faker\Generator instance
$faker = Faker\Factory::create();

// generate data by calling methods
echo $faker->name();
// 'Vince Sporer'
echo $faker->email();
// 'walter.sophia@hotmail.com'
echo $faker->text();
// 'Numquam ut mollitia at consequuntur inventore dolorem.'

Faker follows Semantic Versioning (Semver).

• Breaking Changes: Only introduced in MAJOR version updates.
• BC Promise: Guarantees that the data type returned from a method will not change. However, the specific value returned is not guaranteed to be consistent.
• Exclusions: Classes marked as @experimental or @internal are not covered by the BC promise.
• Named Arguments: Due to PHP 8 named arguments, the names of method arguments are not included in the backward compatibility promise.

Use these methods to get date/time components as strings:

• date($format, $max): Returns a date string using the provided PHP date format (default is 'Y-m-d').
• time($format, $max): Returns a time string using the provided PHP date format (default is 'H:i:s').
• iso8601($max): Returns a date string formatted with ateTime::ISO8601.
• amPm($max): Returns a random 'am' or 'pm' string.
• dayOfMonth($max): Returns the day of the month (e.g., '07').
• dayOfWeek($max): Returns the full textual representation of the day (e.g., 'Tuesday').
• month($max): Returns the month with leading zeros (e.g., '09').
• monthName($max): Returns the full textual representation of the month (e.g., 'September').
• year($max): Returns the 4-digit year (e.g., '1987').

Generate web-related strings using these methods:

• url(): Returns a random URL using various protocols and formats (e.g., https://www.example.com/slug).
• slug($nbWords = 6, $variableNbWords = true): Generates a URL-friendly slug.
  • $nbWords: The number of words to include.
  • $variableNbWords: If true, the number of words will vary slightly around the $nbWords value.

Generate random processor strings for specific operating systems:

• macProcessor(): Returns a Mac processor string (e.g., Intel or PPC).
• linuxProcessor(): Returns a Linux processor string (e.g., i686 or x86_64).

The siren() method generates a 9-digit French SIREN number that passes the Luhn check.

By default, the number is returned in a formatted string (e.g., 123 456 789). Set the $formatted parameter to false to receive the raw 9-digit string.

Use userName() to generate a random username. The method uses various formats (e.g., lastName.firstName, firstName##) and ensures the result is transliterated to lowercase ASCII characters.

Note: If the selected locale cannot be transliterated to ASCII, this method will throw an Exception. Ensure the intl PHP extension is activated for better compatibility.