Class FixtureFactory

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 dependant.

Package: framework\core
Located at sapphire/dev/FixtureFactory.php

Methods summary

`public`	# `define( String $name, array\|FixtureBlueprint $defaults = array() )` Parameters `$name` `String` $name Unique name for this blueprint `$defaults` `array\|FixtureBlueprint` $defaults Array of default values, or a blueprint instance
`public DataObject`	# `createObject( String $name, String $identifier, Array $data = null )` Writes the fixture into the database using DataObjects Writes the fixture into the database using DataObjects Parameters `$name` `String` $name Name of the `FixtureBlueprint` to use, usually a DataObject subclass. `$identifier` `String` $identifier Unique identifier for this fixture type `$data` `Array` $data Map of properties. Overrides default data. Returns `DataObject`
`public 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. Writes the fixture into the database directly using a database manipulation. Does not use blueprints. Only supports tables with a primary key. Parameters `$table` `String` $table Existing database table name `$identifier` `String` $identifier Unique identifier for this fixture type `$data` `Array` $data Map of properties Returns `Int` Database identifier
`public`	# `getId( mixed $class, mixed $identifier )` Get the ID of an object from the fixture. Get the ID of an object from the fixture. Parameters `$class` `mixed` $className The data class, as specified in your fixture file. Parent classes won't work `$identifier` `mixed` $identifier The identifier string, as provided in your fixture file
`public A`	# `getIds( mixed $class )` Return all of the IDs in the fixture of a particular class name. Return all of the IDs in the fixture of a particular class name. Returns `A` map of fixture-identifier => object-id
`public`	# `setId( String $class, String $identifier, Int $databaseId )` Parameters `$class` `String` `$identifier` `String` $identifier `$databaseId` `Int` $databaseId
`public`	# `get( mixed $class, mixed $identifier )` Get an object from the fixture. Get an object from the fixture. Parameters `$class` `mixed` $class The data class, as specified in your fixture file. Parent classes won't work `$identifier` `mixed` $identifier The identifier string, as provided in your fixture file
`public Array`	# `getFixtures( )` Returns `Array` Map of class names, containing a map of in-memory identifiers mapped to database identifiers.
`public`	# `clear( String $limitToClass = null )` Remove all fixtures previously defined through `FixtureFactory::createObject()` or `FixtureFactory::createRaw()`, both from the internal fixture mapping and the database. If the $class argument is set, limit clearing to items of this class. Remove all fixtures previously defined through `FixtureFactory::createObject()` or `FixtureFactory::createRaw()`, both from the internal fixture mapping and the database. If the $class argument is set, limit clearing to items of this class. Parameters `$limitToClass` `String` $class
`public Array`	# `getBlueprints( )` Returns `Array` Of `FixtureBlueprint` instances
`public FixtureBlueprint`	# `getBlueprint( String $name )` Parameters `$name` `String` $name Returns `FixtureBlueprint`
`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 Parse a value from a fixture file. If it starts with => it will get an ID from the fixture dictionary Parameters `$value` `String` $fieldVal Returns `String` Fixture database ID, or the original value

Magic methods summary

Properties summary

`protected array`	`$fixtures`	# Array of fixture items, keyed by class and unique identifier, with values being the generated database ID. Does not store object instances. Array of fixture items, keyed by class and unique identifier, with values being the generated database ID. Does not store object instances.
`protected array`	`$blueprints`	# Callbacks Callbacks

Packages

Classes

Interfaces

Functions

Class FixtureFactory

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary

Comments