CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.6 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.6
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CakeFixtureManager
  • CakeTestFixture
  • CakeTestModel

Class CakeTestFixture

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

Package: Cake\TestSuite\Fixture
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/Fixture/CakeTestFixture.php

Properties summary

  • $canUseMemory public
    boolean

    Fixture data can be stored in memory by default. When table is created for a fixture the MEMORY engine is used where possible. Set $canUseMemory to false if you don't want this.

  • $created public
    array
    List of datasources where this fixture has been created
  • $db public
    object
    CakePHP's DBO driver (e.g: DboMysql).
  • $fields public
    array

    Fields / Schema for the fixture. This array should match the output of Model::schema()

  • $name public
    string
    Name of the object
  • $primaryKey public
    string
    The primary key for the table this fixture represents.
  • $records public
    array
    Fixture records to be inserted.
  • $table public
    string
    Full Table Name
  • $useDbConfig public
    string
    Fixture Datasource

Method Summary

  • __construct() public
    Instantiate the fixture.
  • create() public
    Run before all tests execute, should return SQL statement to create table for this fixture could be executed successfully.
  • drop() public
    Run after all tests executed, should return SQL statement to drop table for this fixture.
  • init() public
    Initialize the fixture.
  • insert() public

    Run before each tests is executed, should return a set of SQL statements to insert records for the table of this fixture could be executed successfully.

  • truncate() public

    Truncates the current fixture. Can be overwritten by classes extending CakeFixture to trigger other events before / after truncate.

Method Detail

__construct() public ¶

__construct( )

Instantiate the fixture.

Throws
CakeException
on invalid datasource usage.

create() public ¶

create( DboSource $db )

Run before all tests execute, should return SQL statement to create table for this fixture could be executed successfully.

Parameters
DboSource $db
An instance of the database object used to create the fixture table
Returns
boolean
True on success, false on failure

drop() public ¶

drop( DboSource $db )

Run after all tests executed, should return SQL statement to drop table for this fixture.

Parameters
DboSource $db
An instance of the database object used to create the fixture table
Returns
boolean
True on success, false on failure

init() public ¶

init( )

Initialize the fixture.

Throws
MissingModelException
Whe importing from a model that does not exist.

insert() public ¶

insert( DboSource $db )

Run before each tests is executed, should return a set of SQL statements to insert records for the table of this fixture could be executed successfully.

Parameters
DboSource $db
An instance of the database into which the records will be inserted
Returns
boolean
on success or if there are no records to insert, or false on failure
Throws
CakeException
if counts of values and fields do not match.

truncate() public ¶

truncate( DboSource $db )

Truncates the current fixture. Can be overwritten by classes extending CakeFixture to trigger other events before / after truncate.

Parameters
DboSource $db
A reference to a db instance
Returns
boolean

Properties detail

$canUseMemory ¶

public boolean

Fixture data can be stored in memory by default. When table is created for a fixture the MEMORY engine is used where possible. Set $canUseMemory to false if you don't want this.

true

$created ¶

public array

List of datasources where this fixture has been created

array()

$db ¶

public object

CakePHP's DBO driver (e.g: DboMysql).

null

$fields ¶

public array

Fields / Schema for the fixture. This array should match the output of Model::schema()

array()

$name ¶

public string

Name of the object

null

$primaryKey ¶

public string

The primary key for the table this fixture represents.

null

$records ¶

public array

Fixture records to be inserted.

array()

$table ¶

public string

Full Table Name

null

$useDbConfig ¶

public string

Fixture Datasource

'test'
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs