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

FixtureBlueprint

class FixtureBlueprint (View source)

A blueprint on how to create instances of a certain DataObject subclass.

Relies on a FixtureFactory to manage database relationships between instances, and manage the mappings between fixture identifiers and their database IDs.

Properties

protected array $defaults
protected string $name
protected string $class
protected array $callbacks

Methods

public
__construct(string $name, string $class = null, array $defaults = [])

No description

public
FixtureFactory
getFactory()

No description

public
FixtureBlueprint
setFactory(FixtureFactory $factory)

No description

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

No description

public
$this
setDefaults(array $defaults)

No description

public
array
getDefaults()

No description

public
string
getClass()

No description

public
$this
addCallback(string $type, callable $callback)

See class documentation.

public
$this
removeCallback(string $type, callable $callback)

No description

protected
invokeCallbacks($type, $args = [])

No description

protected
string
parseValue(string $value, array $fixtures = null, string $class = null)

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

protected
setValue($obj, $name, $value, $fixtures = null)

No description

protected
overrideField($obj, $fieldName, $value, $fixtures = null)

No description

Details

at line 57
__construct(string $name, string $class = null, array $defaults = [])

No description

Parameters

string $name
string $class

Defaults to $name
array $defaults

at line 75
FixtureFactory getFactory()

No description

Return Value

FixtureFactory

at line 80
FixtureBlueprint setFactory(FixtureFactory $factory)

No description

Parameters

FixtureFactory $factory

Return Value

FixtureBlueprint

at line 96
DataObject createObject(string $identifier, array $data = null, array $fixtures = null)

No description

Parameters

string $identifier

Unique identifier for this fixture type
array $data

Map of property names to their values.
array $fixtures

Map of fixture names to an associative array of their in-memory identifiers mapped to their database IDs. Used to look up existing fixtures which might be referenced in the $data attribute via the => notation.

Return Value

DataObject

Exceptions

Exception

at line 267
$this setDefaults(array $defaults)

No description

Parameters

array $defaults

Return Value

$this

at line 276
array getDefaults()

No description

Return Value

array

at line 284
string getClass()

No description

Return Value

string

at line 296
$this addCallback(string $type, callable $callback)

See class documentation.

Parameters

string $type
callable $callback

Return Value

$this

at line 311
$this removeCallback(string $type, callable $callback)

No description

Parameters

string $type
callable $callback

Return Value

$this

at line 321
protected invokeCallbacks($type, $args = [])

No description

Parameters

$type
$args

at line 338
protected string parseValue(string $value, array $fixtures = null, string $class = null)

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

Parameters

string $value
array $fixtures

See createObject()
string $class

If the value parsed is a class relation, this parameter will be given the value of that class's name

Return Value

string

Fixture database ID, or the original value

at line 358
protected setValue($obj, $name, $value, $fixtures = null)

No description

Parameters

$obj
$name
$value
$fixtures

at line 363
protected overrideField($obj, $fieldName, $value, $fixtures = null)

No description

Parameters

$obj
$fieldName
$value
$fixtures