1. class
  2. SilverStripe
  3. \
  4. Dev
  5. \
  6. FixtureFactory

FixtureFactory

class FixtureFactory (View source)

Manages a set of database fixtures for DataObject records as well as raw database table rows.

Delegates creation of objects to FixtureBlueprint, which can implement class- and use-case specific fixture setup.

Supports referencing model relations through a specialized syntax:

$factory = new FixtureFactory();
$relatedObj = $factory->createObject(
 'MyRelatedClass',
 'relation1'
);
$obj = $factory->createObject(
 'MyClass',
 'object1'
 array('MyRelationName' => '=>MyRelatedClass.relation1')
);

Relation loading is order dependent.

Properties

protected array $fixtures
protected FixtureBlueprint[] $blueprints

Methods

public
$this
define(string $name, array|FixtureBlueprint $defaults = [])

No description

public
DataObject
createObject(string $name, string $identifier, array $data = null)

Writes the fixture into the database using DataObjects

public
int
createRaw(string $table, string $identifier, array $data)

Writes the fixture into the database directly using a database manipulation.

public
int|false
getId(string $class, string $identifier)

Get the ID of an object from the fixture.

public
array|false
getIds(string $class)

Return all of the IDs in the fixture of a particular class name.

public
$this
setId(string $class, string $identifier, int $databaseId)

No description

public
T|null
get(T> $class, string $identifier)

Get an object from the fixture.

public
array
getFixtures()

No description

public
clear(string $limitToClass = null, bool $metadata = false)

Remove all fixtures previously defined through createObject() or createRaw(), both from the internal fixture mapping and the database.

public
array
getBlueprints()

No description

public
FixtureBlueprint|false
getBlueprint(string $name)

No description

protected
string
parseValue(string $value)

Parse a value from a fixture file. If it starts with => it will get an ID from the fixture dictionary

Details

at line 53
$this define(string $name, array|FixtureBlueprint $defaults = [])

No description

Parameters

string $name

Unique name for this blueprint
array|FixtureBlueprint $defaults

Array of default values, or a blueprint instance

Return Value

$this

at line 79
DataObject createObject(string $name, string $identifier, array $data = null)

Writes the fixture into the database using DataObjects

Parameters

string $name

Name of the FixtureBlueprint to use, usually a DataObject subclass.
string $identifier

Unique identifier for this fixture type
array $data

Map of properties. Overrides default data.

Return Value

DataObject

at line 105
int createRaw(string $table, string $identifier, array $data)

Writes the fixture into the database directly using a database manipulation.

Does not use blueprints. Only supports tables with a primary key.

Parameters

string $table

Existing database table name
string $identifier

Unique identifier for this fixture type
array $data

Map of properties

Return Value

int

Database identifier

at line 126
int|false getId(string $class, string $identifier)

Get the ID of an object from the fixture.

Parameters

string $class

The data class, as specified in your fixture file. Parent classes won't work
string $identifier

The identifier string, as provided in your fixture file

Return Value

int|false

at line 141
array|false getIds(string $class)

Return all of the IDs in the fixture of a particular class name.

Parameters

string $class

The data class or table name

Return Value

array|false

A map of fixture-identifier => object-id

at line 156
$this setId(string $class, string $identifier, int $databaseId)

No description

Parameters

string $class
string $identifier
int $databaseId

Return Value

$this

at line 170
T|null get(T> $class, string $identifier)

Get an object from the fixture.

Parameters

T> $class

The data class or table name, as specified in your fixture file. Parent classes won't work
string $identifier

The identifier string, as provided in your fixture file

Return Value

T|null

at line 194
array getFixtures()

No description

Return Value

array

Map of class names, containing a map of in-memory identifiers mapped to database identifiers.

at line 208
clear(string $limitToClass = null, bool $metadata = false)

Remove all fixtures previously defined through createObject() or createRaw(), both from the internal fixture mapping and the database.

If the $class argument is set, limit clearing to items of this class.

Parameters

string $limitToClass
bool $metadata

Clear internal mapping as well as data. Set to false by default since sometimes data is rolled back by translations.

at line 237
array getBlueprints()

No description

Return Value

array

Of FixtureBlueprint instances

at line 246
FixtureBlueprint|false getBlueprint(string $name)

No description

Parameters

string $name

Return Value

FixtureBlueprint|false

at line 258
protected string parseValue(string $value)

Parse a value from a fixture file. If it starts with => it will get an ID from the fixture dictionary

Parameters

string $value

Return Value

string

Fixture database ID, or the original value