class SapphireTestState implements TestState (View source)

Traits

A class that can be instantiated or replaced via DI

Properties

protected TestState[] $states

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
getStates()

No description

public
bool|TestState
getStateByName(string $name)

No description

public
bool|TestState
getStateByClass(string $class)

No description

public
$this
setStates(array $states)

No description

public
setUp(SapphireTest $test)

Called on setup

public
tearDown(SapphireTest $test)

Called on tear down

public
setUpOnce(string $class)

Called once on setup

public
tearDownOnce(string $class)

Called once on tear down

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

TestState[] getStates()

No description

Return Value

TestState[]

bool|TestState getStateByName(string $name)

No description

Parameters

string $name

Return Value

bool|TestState

bool|TestState getStateByClass(string $class)

No description

Parameters

string $class

Return Value

bool|TestState

$this setStates(array $states)

No description

Parameters

array $states

Return Value

$this

setUp(SapphireTest $test)

Called on setup

Parameters

SapphireTest $test

tearDown(SapphireTest $test)

Called on tear down

Parameters

SapphireTest $test

setUpOnce(string $class)

Called once on setup

Parameters

string $class

Class being setup

tearDownOnce(string $class)

Called once on tear down

Parameters

string $class

Class being torn down