Class TestFixture

Cake TestFixture is responsible for building and destroying tables to be used during testing.

Cake\TestSuite\Fixture\TestFixture implements Cake\Datasource\FixtureInterface, Cake\Datasource\TableSchemaInterface, Cake\Database\Schema\TableSchemaAwareInterface uses Cake\ORM\Locator\LocatorAwareTrait

Namespace: Cake\TestSuite\Fixture
Location: TestSuite/Fixture/TestFixture.php

Properties summary

$_constraints protected

array
Fixture constraints to be created.
$_schema protected

Cake\Database\Schema\TableSchema
The schema for this fixture.
$connection public

string
Fixture Datasource
$fields public

array
Fields / Schema for the fixture.
$import public

array|null
Configuration for importing fixture schema
$records public

array
Fixture records to be inserted.
$table public

string
Full Table Name

Inherited Properties

_tableLocator

Method Summary

__construct() public
Instantiate the fixture.
_getRecords() protected
Converts the internal records into data used to generate a query.
_schemaFromFields() protected
Build the fixtures table schema from the fields property.
_schemaFromImport() protected
Build fixture schema from a table in another datasource.
_schemaFromReflection() protected
Build fixture schema directly from the datasource
_tableFromClass() protected
Returns the table name using the fixture class
connection() public
Get the connection name this fixture should be inserted into.
create() public
Create the fixture schema/mapping/definition
createConstraints() public

Build and execute SQL queries necessary to create the constraints for the fixture
drop() public
Run after all tests executed, should remove the table/collection from the connection.
dropConstraints() public

Build and execute SQL queries necessary to drop the constraints for the fixture
getTableSchema() public
Get and set the schema for this fixture.
init() public
Initialize the fixture.
insert() public
Run before each test is executed.
schema() public deprecated
Gets/Sets the TableSchema instance used by this fixture.
setTableSchema() public
Get and set the schema for this fixture.
sourceName() public
Get the table/collection name for this fixture.
truncate() public
Truncates the current fixture.

Method Detail

__construct()source public

__construct( )

Instantiate the fixture.

Throws

Cake\Core\Exception\Exception
on invalid datasource usage.

_getRecords()source protected

_getRecords( )

Converts the internal records into data used to generate a query.

Returns

array

_schemaFromFields()source protected

_schemaFromFields( )

Build the fixtures table schema from the fields property.

_schemaFromImport()source protected

_schemaFromImport( )

Build fixture schema from a table in another datasource.

Throws

Cake\Core\Exception\Exception
when trying to import from an empty table.

_schemaFromReflection()source protected

_schemaFromReflection( )

Build fixture schema directly from the datasource

Throws

Cake\Core\Exception\Exception
when trying to reflect a table that does not exist

_tableFromClass()source protected

_tableFromClass( )

Returns the table name using the fixture class

Returns

string

connection()source public

connection( )

Get the connection name this fixture should be inserted into.

Returns

string

Implementation of

Cake\Datasource\FixtureInterface::connection()

create()source public

create( Cake\Datasource\ConnectionInterface $db )

Create the fixture schema/mapping/definition

Parameters

Cake\Datasource\ConnectionInterface $db: An instance of the connection the fixture should be created on.

Returns

boolean
True on success, false on failure.

Implementation of

Cake\Datasource\FixtureInterface::create()

createConstraints()source public

createConstraints( Cake\Datasource\ConnectionInterface $db )

Build and execute SQL queries necessary to create the constraints for the fixture

Parameters

Cake\Datasource\ConnectionInterface $db: An instance of the database into which the constraints will be created

Returns

boolean
on success or if there are no constraints to create, or false on failure

Implementation of

Cake\Datasource\FixtureInterface::createConstraints()

drop()source public

drop( Cake\Datasource\ConnectionInterface $db )

Run after all tests executed, should remove the table/collection from the connection.

Parameters

Cake\Datasource\ConnectionInterface $db: An instance of the connection the fixture should be removed from.

Returns

boolean
True on success, false on failure.

Implementation of

Cake\Datasource\FixtureInterface::drop()

dropConstraints()source public

dropConstraints( Cake\Datasource\ConnectionInterface $db )

Build and execute SQL queries necessary to drop the constraints for the fixture

Parameters

Cake\Datasource\ConnectionInterface $db: An instance of the database into which the constraints will be dropped

Returns

boolean
on success or if there are no constraints to drop, or false on failure

Implementation of

Cake\Datasource\FixtureInterface::dropConstraints()

getTableSchema()source public

getTableSchema( )

Get and set the schema for this fixture.

Returns

Cake\Database\Schema\TableSchemaInterface|null

Implementation of

Cake\Database\Schema\TableSchemaAwareInterface::getTableSchema()

init()source public

init( )

Initialize the fixture.

Throws

Cake\ORM\Exception\MissingTableClassException
When importing from a table that does not exist.

insert()source public

insert( Cake\Datasource\ConnectionInterface $db )

Run before each test is executed.

Parameters

Cake\Datasource\ConnectionInterface $db: An instance of the connection into which the records will be inserted.

Returns

Cake\Database\StatementInterface|boolean
on success or if there are no records to insert, or false on failure.

Implementation of

Cake\Datasource\FixtureInterface::insert()

schema()source public deprecated

schema( Cake\Database\Schema\TableSchema $schema = null )

Gets/Sets the TableSchema instance used by this fixture.

Deprecated

3.5.0 Use getTableSchema/setTableSchema instead.

Parameters

Cake\Database\Schema\TableSchema $schema optional null: The table to set.

Returns

Cake\Database\Schema\TableSchema|null

Implementation of

Cake\Datasource\TableSchemaInterface::schema()

setTableSchema()source public

setTableSchema( Cake\Database\Schema\TableSchemaInterface $schema )

Get and set the schema for this fixture.

Parameters

Cake\Database\Schema\TableSchemaInterface $schema: The table to set.

Returns

$this

Implementation of

Cake\Database\Schema\TableSchemaAwareInterface::setTableSchema()

sourceName()source public

sourceName( )

Get the table/collection name for this fixture.

Returns

string

Implementation of

Cake\Datasource\FixtureInterface::sourceName()

truncate()source public

truncate( Cake\Datasource\ConnectionInterface $db )

Truncates the current fixture.

Parameters

Cake\Datasource\ConnectionInterface $db: A reference to a db instance

Returns

boolean

Implementation of

Cake\Datasource\FixtureInterface::truncate()

Methods used from Cake\ORM\Locator\LocatorAwareTrait

getTableLocator()source public

getTableLocator( )

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

tableLocator()source public deprecated

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Sets the table locator. If no parameters are passed, it will return the currently used locator.

Deprecated

3.5.0 Use getTableLocator()/setTableLocator() instead.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null: LocatorInterface instance.

Returns

Cake\ORM\Locator\LocatorInterface

Magic methods inherited from Cake\Datasource\TableSchemaInterface

getTableSchema()

Properties detail

$_constraintssource

protected array

Fixture constraints to be created.

[]

$_schemasource

protected Cake\Database\Schema\TableSchema

The schema for this fixture.

$connectionsource

public string

Fixture Datasource

'test'

$fieldssource

public array

Fields / Schema for the fixture.

This array should be compatible with Cake\Database\Schema\Schema. The _constraints, _options and _indexes keys are reserved for defining constraints, options and indexes respectively.

[]

$importsource

public array|null

Configuration for importing fixture schema

Accepts a connection and model or table key, to define which table and which connection contain the schema to be imported.

$recordssource

public array

Fixture records to be inserted.

[]

$tablesource

public string

Full Table Name

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.7/class-Cake.TestSuite.Fixture.TestFixture.html