Factory Muffin

When defining attributes, you can use several types of generators:

1. Callables/Closures

Use a closure to generate values dynamically. The closure receives the model instance and a boolean indicating if it is being saved.

$fm->define('MyModel')->setDefinitions([
    'slug' => function ($object, $saved) {
        return strtolower(trim(preg_replace("/[^a-zA-Z0-9\/|_|+ -]/", '', $object->title), '-'));
    },
]);

You can also use a string representing a static method: 'MyModel::exampleMethod'.

2. Faker Facade

Use League\FactoryMuffin\Faker\Facade to generate realistic data.

• Standard: Faker::word(), Faker::email(), Faker::firstNameMale(), etc.
• Unique: Faker::unique()->firstNameFemale() ensures the value is unique across generated models.
• Optional: Faker::optional()->imageUrl(400, 400) may return null instead of a value.
• Ranges: Faker::numberBetween(20, 40).

3. Factory Generator (Relationships)

To set up relationships, use the factory|ModelName syntax. This returns the ID of the newly generated related model.

$fm->define('Foo')->addDefinition('bar_id', 'factory|Bar');

use League\FactoryMuffin\Faker\Facade as Faker;

$fm->define('MyModel')->setDefinitions([
    'title' => Faker::sentence(5),
    'slug'  => function ($object, $saved) {
        return strtolower(trim(preg_replace("/[^a-zA-Z0-9\/|_|+ -]/", '', $object->title), '-'));
    },
    'email' => Faker::email(),
    'age'   => Faker::numberBetween(20, 40),
    'name'  => Faker::unique()->firstNameFemale(),
    'pic'   => Faker::optional()->imageUrl(400, 400),
]);

// Relationship example
$fm->define('Foo')->addDefinition('bar_id', 'factory|Bar');

Version 2.0 is a major milestone involving a rename to 'Factory Muffin' and significant breaking changes.

Key Changes:

• Namespace Change: The root namespace moved from Zizacoactorymuff to Leagueactorymuffin. Access the facade via League\FactoryMuffin\Facade::fooBar().
• Autoloading: Moved from PSR-0 to PSR-4.
• Facade: Now uses __callStatic for dynamic calls and returns the factory instance from public methods to support method chaining.
• Factory Definitions: Public static $factory properties on models are no longer supported. You must use the define function.
• Generators (formerly Kinds): Many specific generator classes (Date, Integer, Name, String, Text) were removed in favor of Faker-based alternatives via the Generic generator.
• PHP Requirement: Minimum version increased to PHP 5.3.3.

Migration Steps:

1. Update Class Names and Namespaces

• Zizaco\FactoryMuff\FactoryMuff $\rightarrow$ League\FactoryMuffin\Factory
• Zizaco\FactoryMuff\Facade\FactoryMuff $\rightarrow$ League\FactoryMuffin\Facade
• Zizaco\FactoryMuff\SaveException $\rightarrow$ League\FactoryMuffin\Exceptions\SaveFailedException
• Zizaco\FactoryMuff\NoDefinedFactoryException $\rightarrow$ League\FactoryMuffin\Exceptions\NoDefinedFactoryException
• Zizaco\FactoryMuff\Kind $\rightarrow$ League\FactoryMuffin\Generators\Base
• Zizaco\FactoryMuff\Kind\Call $\rightarrow$ League\FactoryMuffin\Generators\Call
• Zizaco\FactoryMuff\Kind\Closure $\rightarrow$ League\FactoryMuffin\Generators\Closure
• Zizaco\FactoryMuff\Kind\Factory $\rightarrow$ League\FactoryMuffin\Generators\Factory
• Zizaco\FactoryMuff\Kind\Generic $\rightarrow$ League\FactoryMuffin\Generators\Generic

2. Update Factory Definitions

Replace static properties with the define method:

League\FactoryMuffin\Facade::define('Fully\Qualified\ModelName', ['foo' => 'bar']);

To load multiple definitions in tests, use loadFactories in your setupBeforeClass method:

League\FactoryMuffin\Facade::loadFactories(__DIR__ . '/factories');

Note: loadFactories throws League\FactoryMuffin\Exceptions\DirectoryNotFoundException if the directory is missing.

3. Update Generators (Kinds)

Use Faker-compatible names via the generic generator. Examples:

• integer|8 $\rightarrow$ randomNumber|8
• string $\rightarrow$ sentence or word
• name $\rightarrow$ firstNameMale (or other Faker names)
• date and text remain the same.

New syntax features:

• Use ; to send multiple arguments to generators.
• Prefix definitions with unique: or optional: for unique/optional attributes.

4. Update Model Creation and Seeding

• create(): Now saves anything generated with the Factory generator.
• seed($count, ...): A new function that calls create() repeatedly for the specified $count.
• saved(): Returns an array of all saved objects.
• isSaved($model): Checks if a model instance is saved.
• setSaveMethod($method): Set a custom save function.
• setDeleteMethod($method): Set a custom delete function.

5. Update Deletion

• deleteSaved(): Deletes all saved models. Recommended to call this in PHPUnit's tearDownAfterClass.
• If deletion fails, DeletingFailedException is raised. Use getExceptions() on the exception to retrieve the array of underlying exceptions.

6. Fix Breaking API Changes

• attributesFor() and generateAttr(): No longer accept a class name as the first/second argument. You must pass an actual model instance instead.

Installation (v2.0)

Update your composer.json:

{
    "require-dev": {
        "league/factory-muffin": "2.0.*
    }
}