davidbadura/fixtures

A library to load yaml, json or php fixtures. Easy extendable, resolve object dependency and validate objects.

davidbadura\fixtures

, _(*1)

Features:, _(*2)

• Use Services like fzaninotto/Faker, a PHP library that generates fake data for you
• Resolve object dependency automatically (also bidirectional references)
• Configurable default fixture converter (constructor, properties, set* and add* methods)
• Easy to create your own converter
• Many fixtures loader: Yaml, Json, Toml und PHP
• Extendable by events (currently with symfony/event-dispatcher)
• Fixture filtering by tags
• Object validation (currently with symfony/validator over events)
• Persist Fixtures with Doctrine ORM, Doctrine MongoDb or Propel
• Easy to add your own Persister
• Use an expression-language with symfony/expression-language

Todos:, _(*3)

• Add cli functionality.
• Translate documentation ( my english is really bad ;) )
• Write documentation

Documentation

• Symfony
• FixtureManager
• Fixtures
• Loader
• Converter
• ServiceProvider
• Validator
• ExpressionLanguage

Installation

You can easily install this package over composer, _(*4)

composer require 'davidbadura/fixtures'

Useage

First, you must create fixtures files in yaml, json, toml, php or mixed. In this example, we have different formats:, _(*5)

YAML, _(*6)

user:
  properties:
    class: DavidBadura\Fixtures\TestObjects\User
    constructor: [name, email]
  data:
    david:
      name: "David Badura"
      email: "d.badura@gmx.de"
      group: ["@group:owner", "@group:developer"]
      role: ["@role:admin"]
    other:
      name: "Somebody"
      email: "test@example.de"
      group: ["@group:developer"]
      role: ["@role:user"]

PHP, _(*7)

<?php

return array(
            'role' =>
            array(
                'properties' =>
                array(
                    'class' => 'DavidBadura\\Fixtures\\TestObjects\\Role',
                ),
                'data' =>
                array(
                    'admin' =>
                    array(
                        'name' => 'Admin',
                    ),
                    'user' =>
                    array(
                        'name' => 'User',
                    ),
                ),
            )
        );

JSON, _(*8)

{
    "group": {
        "properties": {
            "class": "DavidBadura\\Fixtures\\TestObjects\\Group"
        },
        "data": {
            "developer": {
                "name": "Developer",
                "leader": "@@user:david"
            }
        }
    }
}

You can reference to other objects with following expression @{fixture-name}:{fixture-key}. The references will resolved automatically., _(*9)

What other formats are supported you can read under Loader., _(*10)

How the fixture manager converte the fixtures to objects can you read in the Converter section. You can use the default fixture converter or write your own converter., _(*11)

Load Fixtures, _(*12)

Now, you can load the fixtures, crate the objects and persist these in the database. For this, we use the default fixture manager., _(*13)

use DavidBadura\Fixtures\FixtureManager\FixtureManager;

// $objectManager can be curently Doctrine ORM Entity Manager or other Doctrine DocumentManager like MongoODM or CouchODM
$fixtureManager = FixtureManager::createDefaultFixtureManager($objectManager);

$fixtureManager->load('path/to/fixtures');

You can easily instance your own fixture manager. For more information you can read FixtureManager documentation., _(*14)