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
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.3 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 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

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
      • Constraint
      • Fixture
      • Stub
    • Utility
    • Validation
    • View

Class TestCase

Cake TestCase class

Abstract
Namespace: Cake\TestSuite

Property Summary

  • $_configure protected
    array

    Configure values to restore at end of test.

  • $_pathRestore protected
    array

    Path settings to restore at the end of the test.

  • $autoFixtures public
    bool

    By default, all fixtures attached to this class will be truncated and reloaded after each test. Set this to false to handle manually

  • $backupGlobals protected
    bool

    Enable or disable the backup and restoration of the $GLOBALS array. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!

  • $backupGlobalsBlacklist protected
    array
  • $backupStaticAttributes protected
    bool

    Enable or disable the backup and restoration of static attributes. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!

  • $backupStaticAttributesBlacklist protected
    array
  • $dropTables public
    bool

    Control table create/drops on each test method.

  • $fixtureManager public
    Cake\TestSuite\Fixture\FixtureManager

    The class responsible for managing the creation, loading and removing of fixtures

  • $preserveGlobalState protected
    bool

    Whether or not this test should preserve the global state when running in a separate PHP process.

  • $runTestInSeparateProcess protected
    bool

    Whether or not this test is to be run in a separate PHP process.

Method Summary

  • __construct() public

    Constructs a test case with the given name.

  • _assertAttributes() protected

    Check the attributes as part of an assertTags() check.

  • _normalizePath() protected

    Normalize a path for comparison.

  • addToAssertionCount() public

    Adds a value to the assertion counter.

  • any() public static

    Returns a matcher that matches when the method is executed zero or more times.

  • anything() public static

    Returns a PHPUnit_Framework_Constraint_IsAnything matcher object.

  • arrayHasKey() public static

    Returns a PHPUnit_Framework_Constraint_ArrayHasKey matcher object.

  • assertArrayHasKey() public static

    Asserts that an array has a specified key.

  • assertArrayNotHasKey() public static

    Asserts that an array does not have a specified key.

  • assertArraySubset() public static

    Asserts that an array has a specified subset.

  • assertAttributeContains() public static

    Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.

  • assertAttributeContainsOnly() public static

    Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains only values of a given type.

  • assertAttributeCount() public static

    Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

  • assertAttributeEmpty() public static

    Asserts that a static attribute of a class or an attribute of an object is empty.

  • assertAttributeEquals() public static

    Asserts that a variable is equal to an attribute of an object.

  • assertAttributeGreaterThan() public static

    Asserts that an attribute is greater than another value.

  • assertAttributeGreaterThanOrEqual() public static

    Asserts that an attribute is greater than or equal to another value.

  • assertAttributeInstanceOf() public static

    Asserts that an attribute is of a given type.

  • assertAttributeInternalType() public static

    Asserts that an attribute is of a given type.

  • assertAttributeLessThan() public static

    Asserts that an attribute is smaller than another value.

  • assertAttributeLessThanOrEqual() public static

    Asserts that an attribute is smaller than or equal to another value.

  • assertAttributeNotContains() public static

    Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain a needle.

  • assertAttributeNotContainsOnly() public static

    Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain only values of a given type.

  • assertAttributeNotCount() public static

    Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

  • assertAttributeNotEmpty() public static

    Asserts that a static attribute of a class or an attribute of an object is not empty.

  • assertAttributeNotEquals() public static

    Asserts that a variable is not equal to an attribute of an object.

  • assertAttributeNotInstanceOf() public static

    Asserts that an attribute is of a given type.

  • assertAttributeNotInternalType() public static

    Asserts that an attribute is of a given type.

  • assertAttributeNotSame() public static

    Asserts that a variable and an attribute of an object do not have the same type and value.

  • assertAttributeSame() public static

    Asserts that a variable and an attribute of an object have the same type and value.

  • assertClassHasAttribute() public static

    Asserts that a class has a specified attribute.

  • assertClassHasStaticAttribute() public static

    Asserts that a class has a specified static attribute.

  • assertClassNotHasAttribute() public static

    Asserts that a class does not have a specified attribute.

  • assertClassNotHasStaticAttribute() public static

    Asserts that a class does not have a specified static attribute.

  • assertContains() public static

    Asserts that a haystack contains a needle.

  • assertContainsOnly() public static

    Asserts that a haystack contains only values of a given type.

  • assertContainsOnlyInstancesOf() public static

    Asserts that a haystack contains only instances of a given classname

  • assertCount() public static

    Asserts the number of elements of an array, Countable or Traversable.

  • assertDirectoryExists() public static

    Asserts that a directory exists.

  • assertDirectoryIsReadable() public static

    Asserts that a directory exists and is readable.

  • assertDirectoryIsWritable() public static

    Asserts that a directory exists and is writable.

  • assertDirectoryNotExists() public static

    Asserts that a directory does not exist.

  • assertDirectoryNotIsReadable() public static

    Asserts that a directory exists and is not readable.

  • assertDirectoryNotIsWritable() public static

    Asserts that a directory exists and is not writable.

  • assertEmpty() public static

    Asserts that a variable is empty.

  • assertEqualXMLStructure() public static

    Asserts that a hierarchy of DOMElements matches.

  • assertEquals() public static

    Asserts that two variables are equal.

  • assertEventFired() public

    Asserts that a global event was fired. You must track events in your event manager for this assertion to work

  • assertEventFiredWith() public

    Asserts an event was fired with data

  • assertFalse() public static

    Asserts that a condition is false.

  • assertFileEquals() public static

    Asserts that the contents of one file is equal to the contents of another file.

  • assertFileExists() public static

    Asserts that a file exists.

  • assertFileIsReadable() public static

    Asserts that a file exists and is readable.

  • assertFileIsWritable() public static

    Asserts that a file exists and is writable.

  • assertFileNotEquals() public static

    Asserts that the contents of one file is not equal to the contents of another file.

  • assertFileNotExists() public static

    Asserts that a file does not exist.

  • assertFileNotIsReadable() public static

    Asserts that a file exists and is not readable.

  • assertFileNotIsWritable() public static

    Asserts that a file exists and is not writable.

  • assertFinite() public static

    Asserts that a variable is finite.

  • assertGreaterThan() public static

    Asserts that a value is greater than another value.

  • assertGreaterThanOrEqual() public static

    Asserts that a value is greater than or equal to another value.

  • assertHtml() public

    Asserts HTML tags.

  • assertInfinite() public static

    Asserts that a variable is infinite.

  • assertInstanceOf() public static

    Asserts that a variable is of a given type.

  • assertInternalType() public static

    Asserts that a variable is of a given type.

  • assertIsReadable() public static

    Asserts that a file/dir is readable.

  • assertIsWritable() public static

    Asserts that a file/dir exists and is writable.

  • assertJson() public static

    Asserts that a string is a valid JSON string.

  • assertJsonFileEqualsJsonFile() public static

    Asserts that two JSON files are equal.

  • assertJsonFileNotEqualsJsonFile() public static

    Asserts that two JSON files are not equal.

  • assertJsonStringEqualsJsonFile() public static

    Asserts that the generated JSON encoded object and the content of the given file are equal.

  • assertJsonStringEqualsJsonString() public static

    Asserts that two given JSON encoded objects or arrays are equal.

  • assertJsonStringNotEqualsJsonFile() public static

    Asserts that the generated JSON encoded object and the content of the given file are not equal.

  • assertJsonStringNotEqualsJsonString() public static

    Asserts that two given JSON encoded objects or arrays are not equal.

  • assertLessThan() public static

    Asserts that a value is smaller than another value.

  • assertLessThanOrEqual() public static

    Asserts that a value is smaller than or equal to another value.

  • assertNan() public static

    Asserts that a variable is nan.

  • assertNotContains() public static

    Asserts that a haystack does not contain a needle.

  • assertNotContainsOnly() public static

    Asserts that a haystack does not contain only values of a given type.

  • assertNotCount() public static

    Asserts the number of elements of an array, Countable or Traversable.

  • assertNotEmpty() public static

    Asserts that a variable is not empty.

  • assertNotEquals() public static

    Asserts that two variables are not equal.

  • assertNotFalse() public static

    Asserts that a condition is not false.

  • assertNotInstanceOf() public static

    Asserts that a variable is not of a given type.

  • assertNotInternalType() public static

    Asserts that a variable is not of a given type.

  • assertNotIsReadable() public static

    Asserts that a file/dir exists and is not readable.

  • assertNotIsWritable() public static

    Asserts that a file/dir exists and is not writable.

  • assertNotNull() public static

    Asserts that a variable is not null.

  • assertNotRegExp() public static

    Asserts that a string does not match a given regular expression.

  • assertNotSame() public static

    Asserts that two variables do not have the same type and value. Used on objects, it asserts that two variables do not reference the same object.

  • assertNotSameSize() public static

    Assert that the size of two arrays (or Countable or Traversable objects) is not the same.

  • assertNotTrue() public static

    Asserts that a condition is not true.

  • assertNotWithinRange() protected static

    Compatibility function to test if a value is not between an acceptable range.

  • assertNull() public static

    Asserts that a variable is null.

  • assertObjectHasAttribute() public static

    Asserts that an object has a specified attribute.

  • assertObjectNotHasAttribute() public static

    Asserts that an object does not have a specified attribute.

  • assertPathEquals() protected static

    Compatibility function to test paths.

  • assertPostConditions() protected

    Performs assertions shared by all tests of a test case.

  • assertPreConditions() protected

    Performs assertions shared by all tests of a test case.

  • assertRegExp() public static

    Asserts that a string matches a given regular expression.

  • assertSame() public static

    Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object.

  • assertSameSize() public static

    Assert that the size of two arrays (or Countable or Traversable objects) is the same.

  • assertStringEndsNotWith() public static

    Asserts that a string ends not with a given suffix.

  • assertStringEndsWith() public static

    Asserts that a string ends with a given suffix.

  • assertStringEqualsFile() public static

    Asserts that the contents of a string is equal to the contents of a file.

  • assertStringMatchesFormat() public static

    Asserts that a string matches a given format string.

  • assertStringMatchesFormatFile() public static

    Asserts that a string matches a given format file.

  • assertStringNotEqualsFile() public static

    Asserts that the contents of a string is not equal to the contents of a file.

  • assertStringNotMatchesFormat() public static

    Asserts that a string does not match a given format string.

  • assertStringNotMatchesFormatFile() public static

    Asserts that a string does not match a given format string.

  • assertStringStartsNotWith() public static

    Asserts that a string starts not with a given prefix.

  • assertStringStartsWith() public static

    Asserts that a string starts with a given prefix.

  • assertTags() public deprecated

    Asserts HTML tags.

  • assertTextContains() public

    Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextEndsNotWith() public

    Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextEndsWith() public

    Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextEquals() public

    Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextNotContains() public

    Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextNotEquals() public

    Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextStartsNotWith() public

    Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertTextStartsWith() public

    Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

  • assertThat() public static

    Evaluates a PHPUnit_Framework_Constraint matcher object.

  • assertTrue() public static

    Asserts that a condition is true.

  • assertWithinRange() protected static

    Compatibility function to test if a value is between an acceptable range.

  • assertXmlFileEqualsXmlFile() public static

    Asserts that two XML files are equal.

  • assertXmlFileNotEqualsXmlFile() public static

    Asserts that two XML files are not equal.

  • assertXmlStringEqualsXmlFile() public static

    Asserts that two XML documents are equal.

  • assertXmlStringEqualsXmlString() public static

    Asserts that two XML documents are equal.

  • assertXmlStringNotEqualsXmlFile() public static

    Asserts that two XML documents are not equal.

  • assertXmlStringNotEqualsXmlString() public static

    Asserts that two XML documents are not equal.

  • at() public static

    Returns a matcher that matches when the method is executed at the given index.

  • atLeast() public static

    Returns a matcher that matches when the method is executed at least N times.

  • atLeastOnce() public static

    Returns a matcher that matches when the method is executed at least once.

  • atMost() public static

    Returns a matcher that matches when the method is executed at most N times.

  • attribute() public static

    Returns a PHPUnit_Framework_Constraint_Attribute matcher object.

  • attributeEqualTo() public static

    Returns a PHPUnit_Framework_Constraint_IsEqual matcher object that is wrapped in a PHPUnit_Framework_Constraint_Attribute matcher object.

  • callback() public static

    Returns a PHPUnit_Framework_Constraint_Callback matcher object.

  • checkRequirements() protected
  • classHasAttribute() public static

    Returns a PHPUnit_Framework_Constraint_ClassHasAttribute matcher object.

  • classHasStaticAttribute() public static

    Returns a PHPUnit_Framework_Constraint_ClassHasStaticAttribute matcher object.

  • contains() public static

    Returns a PHPUnit_Framework_Constraint_TraversableContains matcher object.

  • containsOnly() public static

    Returns a PHPUnit_Framework_Constraint_TraversableContainsOnly matcher object.

  • containsOnlyInstancesOf() public static

    Returns a PHPUnit_Framework_Constraint_TraversableContainsOnly matcher object.

  • count() public

    Counts the number of test cases executed by run(TestResult result).

  • countOf() public static

    Returns a PHPUnit_Framework_Constraint_Count matcher object.

  • createConfiguredMock() protected

    Returns a configured test double for the specified class.

  • createMock() protected

    Returns a test double for the specified class.

  • createPartialMock() protected

    Returns a partial test double for the specified class.

  • createResult() protected

    Creates a default TestResult object.

  • dataDescription() public
  • directoryExists() public static

    Returns a PHPUnit_Framework_Constraint_DirectoryExists matcher object.

  • doesNotPerformAssertions() public
  • equalTo() public static

    Returns a PHPUnit_Framework_Constraint_IsEqual matcher object.

  • exactly() public static

    Returns a matcher that matches when the method is executed exactly $count times.

  • expectException() public
  • expectExceptionCode() public
  • expectExceptionMessage() public
  • expectExceptionMessageRegExp() public
  • expectOutputRegex() public
  • expectOutputString() public
  • fail() public static

    Fails a test with the given message.

  • fileExists() public static

    Returns a PHPUnit_Framework_Constraint_FileExists matcher object.

  • getActualOutput() public
  • getAnnotations() public

    Returns the annotations for this test.

  • getCount() public static

    Return the current assertion count.

  • getDataSetAsString() protected

    Gets the data set description of a TestCase.

  • getExpectedException() public
  • getGroups() public
  • getMock() protected deprecated

    Returns a mock object for the specified class.

  • getMockBuilder() public

    Returns a builder object to create mock objects using a fluent interface.

  • getMockClass() protected

    Mocks the specified class and returns the name of the mocked class.

  • getMockForAbstractClass() protected

    Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default. To mock concrete methods, use the 7th parameter ($mockedMethods).

  • getMockForModel() public

    Mock a model, maintain fixtures and table association

  • getMockForTrait() protected

    Returns a mock object for the specified trait with all abstract methods of the trait mocked. Concrete methods to mock can be specified with the $mockedMethods parameter.

  • getMockFromWsdl() protected

    Returns a mock object based on the given WSDL file.

  • getMockObjectGenerator() protected

    Get the mock object generator, creating it if it doesn't exist.

  • getMockWithoutInvokingTheOriginalConstructor() protected deprecated

    Returns a mock with disabled constructor object for the specified class.

  • getName() public

    Gets the name of a TestCase.

  • getNumAssertions() public

    Returns the number of assertions performed by this test.

  • getObjectAttribute() public static

    Returns the value of an object's attribute. This also works for attributes that are declared protected or private.

  • getObjectForTrait() protected

    Returns an object for the specified trait.

  • getProvidedData() protected

    Gets the data set of a TestCase.

  • getResult() public
  • getSize() public

    Returns the size of the test.

  • getStaticAttribute() public static

    Returns the value of a static attribute. This also works for attributes that are declared protected or private.

  • getStatus() public

    Returns the status of this test.

  • getStatusMessage() public

    Returns the status message of this test.

  • getTestResultObject() public
  • greaterThan() public static

    Returns a PHPUnit_Framework_Constraint_GreaterThan matcher object.

  • greaterThanOrEqual() public static

    Returns a PHPUnit_Framework_Constraint_Or matcher object that wraps a PHPUnit_Framework_Constraint_IsEqual and a PHPUnit_Framework_Constraint_GreaterThan matcher object.

  • handleDependencies() protected
  • hasDependencies() public

    Returns true if the tests has dependencies

  • hasExpectationOnOutput() public
  • hasFailed() public

    Returns whether or not this test has failed.

  • hasOutput() public
  • hasPerformedExpectationsOnOutput() public deprecated
  • hasSize() public
  • identicalTo() public static

    Returns a PHPUnit_Framework_Constraint_IsIdentical matcher object.

  • iniSet() protected

    This method is a wrapper for the ini_set() function that automatically resets the modified php.ini setting to its original value after the test is run.

  • isEmpty() public static

    Returns a PHPUnit_Framework_Constraint_IsEmpty matcher object.

  • isFalse() public static

    Returns a PHPUnit_Framework_Constraint_IsFalse matcher object.

  • isFinite() public static

    Returns a PHPUnit_Framework_Constraint_IsFinite matcher object.

  • isInIsolation() public
  • isInfinite() public static

    Returns a PHPUnit_Framework_Constraint_IsInfinite matcher object.

  • isInstanceOf() public static

    Returns a PHPUnit_Framework_Constraint_IsInstanceOf matcher object.

  • isJson() public static

    Returns a PHPUnit_Framework_Constraint_IsJson matcher object.

  • isLarge() public
  • isMedium() public
  • isNan() public static

    Returns a PHPUnit_Framework_Constraint_IsNan matcher object.

  • isNull() public static

    Returns a PHPUnit_Framework_Constraint_IsNull matcher object.

  • isReadable() public static

    Returns a PHPUnit_Framework_Constraint_IsReadable matcher object.

  • isSmall() public
  • isTrue() public static

    Returns a PHPUnit_Framework_Constraint_IsTrue matcher object.

  • isType() public static

    Returns a PHPUnit_Framework_Constraint_IsType matcher object.

  • isWritable() public static

    Returns a PHPUnit_Framework_Constraint_IsWritable matcher object.

  • lessThan() public static

    Returns a PHPUnit_Framework_Constraint_LessThan matcher object.

  • lessThanOrEqual() public static

    Returns a PHPUnit_Framework_Constraint_Or matcher object that wraps a PHPUnit_Framework_Constraint_IsEqual and a PHPUnit_Framework_Constraint_LessThan matcher object.

  • loadFixtures() public

    Chooses which fixtures to load for a given test

  • logicalAnd() public static

    Returns a PHPUnit_Framework_Constraint_And matcher object.

  • logicalNot() public static

    Returns a PHPUnit_Framework_Constraint_Not matcher object.

  • logicalOr() public static

    Returns a PHPUnit_Framework_Constraint_Or matcher object.

  • logicalXor() public static

    Returns a PHPUnit_Framework_Constraint_Xor matcher object.

  • markAsRisky() public
  • markTestIncomplete() public static

    Mark the test as incomplete.

  • markTestSkipped() public static

    Mark the test as skipped.

  • matches() public static

    Returns a PHPUnit_Framework_Constraint_StringMatches matcher object.

  • matchesRegularExpression() public static

    Returns a PHPUnit_Framework_Constraint_PCREMatch matcher object.

  • never() public static

    Returns a matcher that matches when the method is never executed.

  • objectHasAttribute() public static

    Returns a PHPUnit_Framework_Constraint_ObjectHasAttribute matcher object.

  • onConsecutiveCalls() public static
  • onNotSuccessfulTest() protected

    This method is called when a test method did not execute successfully.

  • once() public static

    Returns a matcher that matches when the method is executed exactly once.

  • prepareTemplate() protected

    Performs custom preparations on the process isolation template.

  • prophesize() protected
  • readAttribute() public static

    Returns the value of an attribute of a class or an object. This also works for attributes that are declared protected or private.

  • registerMockObject() public
  • resetCount() public static

    Reset the assertion counter.

  • returnArgument() public static
  • returnCallback() public static
  • returnSelf() public static

    Returns the current object.

  • returnValue() public static
  • returnValueMap() public static
  • run() public

    Runs the test case and collects the results in a TestResult object. If no TestResult object is passed a new one will be created.

  • runBare() public

    Runs the bare test sequence.

  • runTest() protected

    Override to run the test and assert its state.

  • setBackupGlobals() public

    Calling this method in setUp() has no effect!

  • setBackupStaticAttributes() public

    Calling this method in setUp() has no effect!

  • setBeStrictAboutChangesToGlobalState() public
  • setDependencies() public

    Sets the dependencies of a TestCase.

  • setDependencyInput() public

    Sets

  • setExpectedException() public deprecated
  • setExpectedExceptionFromAnnotation() protected
  • setExpectedExceptionRegExp() public deprecated
  • setGroups() public
  • setInIsolation() public
  • setLocale() protected

    This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.

  • setName() public

    Sets the name of a TestCase.

  • setOutputCallback() public
  • setPreserveGlobalState() public
  • setRegisterMockObjectsFromTestArgumentsRecursively() public
  • setResult() public
  • setRunTestInSeparateProcess() public
  • setTestResultObject() public
  • setUp() public

    Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.

  • setUpBeforeClass() public static

    This method is called before the first test of this test class is run.

  • setUseErrorHandler() public
  • setUseErrorHandlerFromAnnotation() protected
  • skipIf() public

    Overrides SimpleTestCase::skipIf to provide a boolean return value

  • skipUnless() protected

    Compatibility function for skipping.

  • stringContains() public static

    Returns a PHPUnit_Framework_Constraint_StringContains matcher object.

  • stringEndsWith() public static

    Returns a PHPUnit_Framework_Constraint_StringEndsWith matcher object.

  • stringStartsWith() public static

    Returns a PHPUnit_Framework_Constraint_StringStartsWith matcher object.

  • tearDown() public

    teardown any static object changes and restore them.

  • tearDownAfterClass() public static

    This method is called after the last test of this test class is run.

  • throwException() public static
  • toString() public

    Returns a string representation of the test case.

  • usesDataProvider() public
  • verifyMockObjects() protected

    Verifies the mock object expectations.

Method Detail

__construct() ¶ public

__construct(string $name = null, array $data = [], string $dataName = '')

Constructs a test case with the given name.

Parameters
string $name optional
array $data optional
string $dataName optional

_assertAttributes() ¶ protected

_assertAttributes(array $assertions, string $string, bool $fullDebug = false, array|string $regex = ''): string

Check the attributes as part of an assertTags() check.

Parameters
array $assertions

Assertions to run.

string $string

The HTML string to check.

bool $fullDebug optional

Whether or not more verbose output should be used.

array|string $regex optional

Full regexp from assertHtml

Returns
string

_normalizePath() ¶ protected

_normalizePath(string $path): string

Normalize a path for comparison.

Parameters
string $path

Path separated by "/" slash.

Returns
string

addToAssertionCount() ¶ public

addToAssertionCount(int $count)

Adds a value to the assertion counter.

Parameters
int $count

any() ¶ public static

any(): PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount

Returns a matcher that matches when the method is executed zero or more times.

Returns
PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount

anything() ¶ public static

anything(): PHPUnit_Framework_Constraint_IsAnything

Returns a PHPUnit_Framework_Constraint_IsAnything matcher object.

Returns
PHPUnit_Framework_Constraint_IsAnything

arrayHasKey() ¶ public static

arrayHasKey(mixed $key): PHPUnit_Framework_Constraint_ArrayHasKey

Returns a PHPUnit_Framework_Constraint_ArrayHasKey matcher object.

Parameters
mixed $key
Returns
PHPUnit_Framework_Constraint_ArrayHasKey

assertArrayHasKey() ¶ public static

assertArrayHasKey(mixed $key, array|ArrayAccess $array, string $message = '')

Asserts that an array has a specified key.

Parameters
mixed $key
array|ArrayAccess $array
string $message optional

assertArrayNotHasKey() ¶ public static

assertArrayNotHasKey(mixed $key, array|ArrayAccess $array, string $message = '')

Asserts that an array does not have a specified key.

Parameters
mixed $key
array|ArrayAccess $array
string $message optional

assertArraySubset() ¶ public static

assertArraySubset(array|ArrayAccess $subset, array|ArrayAccess $array, bool $strict = false, string $message = '')

Asserts that an array has a specified subset.

Parameters
array|ArrayAccess $subset
array|ArrayAccess $array
bool $strict optional

Check for object identity

string $message optional

assertAttributeContains() ¶ public static

assertAttributeContains(mixed $needle, string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.

Parameters
mixed $needle
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

assertAttributeContainsOnly() ¶ public static

assertAttributeContainsOnly(string $type, string $haystackAttributeName, string|object $haystackClassOrObject, bool $isNativeType = null, string $message = '')

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains only values of a given type.

Parameters
string $type
string $haystackAttributeName
string|object $haystackClassOrObject
bool $isNativeType optional
string $message optional

assertAttributeCount() ¶ public static

assertAttributeCount(int $expectedCount, string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '')

Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

Parameters
int $expectedCount
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional

assertAttributeEmpty() ¶ public static

assertAttributeEmpty(string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '')

Asserts that a static attribute of a class or an attribute of an object is empty.

Parameters
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional

assertAttributeEquals() ¶ public static

assertAttributeEquals(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that a variable is equal to an attribute of an object.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

assertAttributeGreaterThan() ¶ public static

assertAttributeGreaterThan(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that an attribute is greater than another value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertAttributeGreaterThanOrEqual() ¶ public static

assertAttributeGreaterThanOrEqual(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that an attribute is greater than or equal to another value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertAttributeInstanceOf() ¶ public static

assertAttributeInstanceOf(string $expected, string $attributeName, string|object $classOrObject, string $message = '')

Asserts that an attribute is of a given type.

Parameters
string $expected
string $attributeName
string|object $classOrObject
string $message optional

assertAttributeInternalType() ¶ public static

assertAttributeInternalType(string $expected, string $attributeName, string|object $classOrObject, string $message = '')

Asserts that an attribute is of a given type.

Parameters
string $expected
string $attributeName
string|object $classOrObject
string $message optional

assertAttributeLessThan() ¶ public static

assertAttributeLessThan(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that an attribute is smaller than another value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertAttributeLessThanOrEqual() ¶ public static

assertAttributeLessThanOrEqual(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that an attribute is smaller than or equal to another value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertAttributeNotContains() ¶ public static

assertAttributeNotContains(mixed $needle, string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain a needle.

Parameters
mixed $needle
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

assertAttributeNotContainsOnly() ¶ public static

assertAttributeNotContainsOnly(string $type, string $haystackAttributeName, string|object $haystackClassOrObject, bool $isNativeType = null, string $message = '')

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain only values of a given type.

Parameters
string $type
string $haystackAttributeName
string|object $haystackClassOrObject
bool $isNativeType optional
string $message optional

assertAttributeNotCount() ¶ public static

assertAttributeNotCount(int $expectedCount, string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '')

Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

Parameters
int $expectedCount
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional

assertAttributeNotEmpty() ¶ public static

assertAttributeNotEmpty(string $haystackAttributeName, string|object $haystackClassOrObject, string $message = '')

Asserts that a static attribute of a class or an attribute of an object is not empty.

Parameters
string $haystackAttributeName
string|object $haystackClassOrObject
string $message optional

assertAttributeNotEquals() ¶ public static

assertAttributeNotEquals(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that a variable is not equal to an attribute of an object.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

assertAttributeNotInstanceOf() ¶ public static

assertAttributeNotInstanceOf(string $expected, string $attributeName, string|object $classOrObject, string $message = '')

Asserts that an attribute is of a given type.

Parameters
string $expected
string $attributeName
string|object $classOrObject
string $message optional

assertAttributeNotInternalType() ¶ public static

assertAttributeNotInternalType(string $expected, string $attributeName, string|object $classOrObject, string $message = '')

Asserts that an attribute is of a given type.

Parameters
string $expected
string $attributeName
string|object $classOrObject
string $message optional

assertAttributeNotSame() ¶ public static

assertAttributeNotSame(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that a variable and an attribute of an object do not have the same type and value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertAttributeSame() ¶ public static

assertAttributeSame(mixed $expected, string $actualAttributeName, string|object $actualClassOrObject, string $message = '')

Asserts that a variable and an attribute of an object have the same type and value.

Parameters
mixed $expected
string $actualAttributeName
string|object $actualClassOrObject
string $message optional

assertClassHasAttribute() ¶ public static

assertClassHasAttribute(string $attributeName, string $className, string $message = '')

Asserts that a class has a specified attribute.

Parameters
string $attributeName
string $className
string $message optional

assertClassHasStaticAttribute() ¶ public static

assertClassHasStaticAttribute(string $attributeName, string $className, string $message = '')

Asserts that a class has a specified static attribute.

Parameters
string $attributeName
string $className
string $message optional

assertClassNotHasAttribute() ¶ public static

assertClassNotHasAttribute(string $attributeName, string $className, string $message = '')

Asserts that a class does not have a specified attribute.

Parameters
string $attributeName
string $className
string $message optional

assertClassNotHasStaticAttribute() ¶ public static

assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message = '')

Asserts that a class does not have a specified static attribute.

Parameters
string $attributeName
string $className
string $message optional

assertContains() ¶ public static

assertContains(mixed $needle, mixed $haystack, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)

Asserts that a haystack contains a needle.

Parameters
mixed $needle
mixed $haystack
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

assertContainsOnly() ¶ public static

assertContainsOnly(string $type, mixed $haystack, bool $isNativeType = null, string $message = '')

Asserts that a haystack contains only values of a given type.

Parameters
string $type
mixed $haystack
bool $isNativeType optional
string $message optional

assertContainsOnlyInstancesOf() ¶ public static

assertContainsOnlyInstancesOf(string $classname, array|Traversable $haystack, string $message = '')

Asserts that a haystack contains only instances of a given classname

Parameters
string $classname
array|Traversable $haystack
string $message optional

assertCount() ¶ public static

assertCount(int $expectedCount, mixed $haystack, string $message = '')

Asserts the number of elements of an array, Countable or Traversable.

Parameters
int $expectedCount
mixed $haystack
string $message optional

assertDirectoryExists() ¶ public static

assertDirectoryExists(string $directory, string $message = '')

Asserts that a directory exists.

Parameters
string $directory
string $message optional

assertDirectoryIsReadable() ¶ public static

assertDirectoryIsReadable(string $directory, string $message = '')

Asserts that a directory exists and is readable.

Parameters
string $directory
string $message optional

assertDirectoryIsWritable() ¶ public static

assertDirectoryIsWritable(string $directory, string $message = '')

Asserts that a directory exists and is writable.

Parameters
string $directory
string $message optional

assertDirectoryNotExists() ¶ public static

assertDirectoryNotExists(string $directory, string $message = '')

Asserts that a directory does not exist.

Parameters
string $directory
string $message optional

assertDirectoryNotIsReadable() ¶ public static

assertDirectoryNotIsReadable(string $directory, string $message = '')

Asserts that a directory exists and is not readable.

Parameters
string $directory
string $message optional

assertDirectoryNotIsWritable() ¶ public static

assertDirectoryNotIsWritable(string $directory, string $message = '')

Asserts that a directory exists and is not writable.

Parameters
string $directory
string $message optional

assertEmpty() ¶ public static

assertEmpty(mixed $actual, string $message = '')

Asserts that a variable is empty.

Parameters
mixed $actual
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertEqualXMLStructure() ¶ public static

assertEqualXMLStructure(DOMElement $expectedElement, DOMElement $actualElement, bool $checkAttributes = false, string $message = '')

Asserts that a hierarchy of DOMElements matches.

Parameters
DOMElement $expectedElement
DOMElement $actualElement
bool $checkAttributes optional
string $message optional

assertEquals() ¶ public static

assertEquals(mixed $expected, mixed $actual, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that two variables are equal.

Parameters
mixed $expected
mixed $actual
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

assertEventFired() ¶ public

assertEventFired(string $name, EventManager|null $eventManager = null, string $message = ''): void

Asserts that a global event was fired. You must track events in your event manager for this assertion to work

Parameters
string $name

Event name

EventManager|null $eventManager optional

Event manager to check, defaults to global event manager

string $message optional

Assertion failure message

Returns
void

assertEventFiredWith() ¶ public

assertEventFiredWith(string $name, string $dataKey, string $dataValue, EventManager|null $eventManager = null, string $message = ''): void

Asserts an event was fired with data

If a third argument is passed, that value is used to compare with the value in $dataKey

Parameters
string $name

Event name

string $dataKey

Data key

string $dataValue

Data value

EventManager|null $eventManager optional

Event manager to check, defaults to global event manager

string $message optional

Assertion failure message

Returns
void

assertFalse() ¶ public static

assertFalse(bool $condition, string $message = '')

Asserts that a condition is false.

Parameters
bool $condition
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertFileEquals() ¶ public static

assertFileEquals(string $expected, string $actual, string $message = '', bool $canonicalize = false, bool $ignoreCase = false)

Asserts that the contents of one file is equal to the contents of another file.

Parameters
string $expected
string $actual
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

assertFileExists() ¶ public static

assertFileExists(string $filename, string $message = '')

Asserts that a file exists.

Parameters
string $filename
string $message optional

assertFileIsReadable() ¶ public static

assertFileIsReadable(string $file, string $message = '')

Asserts that a file exists and is readable.

Parameters
string $file
string $message optional

assertFileIsWritable() ¶ public static

assertFileIsWritable(string $file, string $message = '')

Asserts that a file exists and is writable.

Parameters
string $file
string $message optional

assertFileNotEquals() ¶ public static

assertFileNotEquals(string $expected, string $actual, string $message = '', bool $canonicalize = false, bool $ignoreCase = false)

Asserts that the contents of one file is not equal to the contents of another file.

Parameters
string $expected
string $actual
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

assertFileNotExists() ¶ public static

assertFileNotExists(string $filename, string $message = '')

Asserts that a file does not exist.

Parameters
string $filename
string $message optional

assertFileNotIsReadable() ¶ public static

assertFileNotIsReadable(string $file, string $message = '')

Asserts that a file exists and is not readable.

Parameters
string $file
string $message optional

assertFileNotIsWritable() ¶ public static

assertFileNotIsWritable(string $file, string $message = '')

Asserts that a file exists and is not writable.

Parameters
string $file
string $message optional

assertFinite() ¶ public static

assertFinite(mixed $actual, string $message = '')

Asserts that a variable is finite.

Parameters
mixed $actual
string $message optional

assertGreaterThan() ¶ public static

assertGreaterThan(mixed $expected, mixed $actual, string $message = '')

Asserts that a value is greater than another value.

Parameters
mixed $expected
mixed $actual
string $message optional

assertGreaterThanOrEqual() ¶ public static

assertGreaterThanOrEqual(mixed $expected, mixed $actual, string $message = '')

Asserts that a value is greater than or equal to another value.

Parameters
mixed $expected
mixed $actual
string $message optional

assertHtml() ¶ public

assertHtml(array $expected, string $string, bool $fullDebug = false): bool

Asserts HTML tags.

Takes an array $expected and generates a regex from it to match the provided $string. Samples for $expected:

Checks for an input tag with a name attribute (contains any non-empty value) and an id attribute that contains 'my-input':

['input' => ['name', 'id' => 'my-input']]

Checks for two p elements with some text in them:

[
  ['p' => true],
  'textA',
  '/p',
  ['p' => true],
  'textB',
  '/p'
]

You can also specify a pattern expression as part of the attribute values, or the tag being defined, if you prepend the value with preg: and enclose it with slashes, like so:

[
  ['input' => ['name', 'id' => 'preg:/FieldName\d+/']],
  'preg:/My\s+field/'
]

Important: This function is very forgiving about whitespace and also accepts any permutation of attribute order. It will also allow whitespace between specified tags.

Parameters
array $expected

An array, see above

string $string

An HTML/XHTML/XML string

bool $fullDebug optional

Whether or not more verbose output should be used.

Returns
bool

assertInfinite() ¶ public static

assertInfinite(mixed $actual, string $message = '')

Asserts that a variable is infinite.

Parameters
mixed $actual
string $message optional

assertInstanceOf() ¶ public static

assertInstanceOf(string $expected, mixed $actual, string $message = '')

Asserts that a variable is of a given type.

Parameters
string $expected
mixed $actual
string $message optional

assertInternalType() ¶ public static

assertInternalType(string $expected, mixed $actual, string $message = '')

Asserts that a variable is of a given type.

Parameters
string $expected
mixed $actual
string $message optional

assertIsReadable() ¶ public static

assertIsReadable(string $filename, string $message = '')

Asserts that a file/dir is readable.

Parameters
string $filename
string $message optional

assertIsWritable() ¶ public static

assertIsWritable(string $filename, string $message = '')

Asserts that a file/dir exists and is writable.

Parameters
string $filename
string $message optional

assertJson() ¶ public static

assertJson(string $actualJson, string $message = '')

Asserts that a string is a valid JSON string.

Parameters
string $actualJson
string $message optional

assertJsonFileEqualsJsonFile() ¶ public static

assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = '')

Asserts that two JSON files are equal.

Parameters
string $expectedFile
string $actualFile
string $message optional

assertJsonFileNotEqualsJsonFile() ¶ public static

assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = '')

Asserts that two JSON files are not equal.

Parameters
string $expectedFile
string $actualFile
string $message optional

assertJsonStringEqualsJsonFile() ¶ public static

assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = '')

Asserts that the generated JSON encoded object and the content of the given file are equal.

Parameters
string $expectedFile
string $actualJson
string $message optional

assertJsonStringEqualsJsonString() ¶ public static

assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = '')

Asserts that two given JSON encoded objects or arrays are equal.

Parameters
string $expectedJson
string $actualJson
string $message optional

assertJsonStringNotEqualsJsonFile() ¶ public static

assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = '')

Asserts that the generated JSON encoded object and the content of the given file are not equal.

Parameters
string $expectedFile
string $actualJson
string $message optional

assertJsonStringNotEqualsJsonString() ¶ public static

assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson, string $message = '')

Asserts that two given JSON encoded objects or arrays are not equal.

Parameters
string $expectedJson
string $actualJson
string $message optional

assertLessThan() ¶ public static

assertLessThan(mixed $expected, mixed $actual, string $message = '')

Asserts that a value is smaller than another value.

Parameters
mixed $expected
mixed $actual
string $message optional

assertLessThanOrEqual() ¶ public static

assertLessThanOrEqual(mixed $expected, mixed $actual, string $message = '')

Asserts that a value is smaller than or equal to another value.

Parameters
mixed $expected
mixed $actual
string $message optional

assertNan() ¶ public static

assertNan(mixed $actual, string $message = '')

Asserts that a variable is nan.

Parameters
mixed $actual
string $message optional

assertNotContains() ¶ public static

assertNotContains(mixed $needle, mixed $haystack, string $message = '', bool $ignoreCase = false, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false)

Asserts that a haystack does not contain a needle.

Parameters
mixed $needle
mixed $haystack
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

assertNotContainsOnly() ¶ public static

assertNotContainsOnly(string $type, mixed $haystack, bool $isNativeType = null, string $message = '')

Asserts that a haystack does not contain only values of a given type.

Parameters
string $type
mixed $haystack
bool $isNativeType optional
string $message optional

assertNotCount() ¶ public static

assertNotCount(int $expectedCount, mixed $haystack, string $message = '')

Asserts the number of elements of an array, Countable or Traversable.

Parameters
int $expectedCount
mixed $haystack
string $message optional

assertNotEmpty() ¶ public static

assertNotEmpty(mixed $actual, string $message = '')

Asserts that a variable is not empty.

Parameters
mixed $actual
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertNotEquals() ¶ public static

assertNotEquals(mixed $expected, mixed $actual, string $message = '', float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false)

Asserts that two variables are not equal.

Parameters
mixed $expected
mixed $actual
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

assertNotFalse() ¶ public static

assertNotFalse(bool $condition, string $message = '')

Asserts that a condition is not false.

Parameters
bool $condition
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertNotInstanceOf() ¶ public static

assertNotInstanceOf(string $expected, mixed $actual, string $message = '')

Asserts that a variable is not of a given type.

Parameters
string $expected
mixed $actual
string $message optional

assertNotInternalType() ¶ public static

assertNotInternalType(string $expected, mixed $actual, string $message = '')

Asserts that a variable is not of a given type.

Parameters
string $expected
mixed $actual
string $message optional

assertNotIsReadable() ¶ public static

assertNotIsReadable(string $filename, string $message = '')

Asserts that a file/dir exists and is not readable.

Parameters
string $filename
string $message optional

assertNotIsWritable() ¶ public static

assertNotIsWritable(string $filename, string $message = '')

Asserts that a file/dir exists and is not writable.

Parameters
string $filename
string $message optional

assertNotNull() ¶ public static

assertNotNull(mixed $actual, string $message = '')

Asserts that a variable is not null.

Parameters
mixed $actual
string $message optional

assertNotRegExp() ¶ public static

assertNotRegExp(string $pattern, string $string, string $message = '')

Asserts that a string does not match a given regular expression.

Parameters
string $pattern
string $string
string $message optional

assertNotSame() ¶ public static

assertNotSame(mixed $expected, mixed $actual, string $message = '')

Asserts that two variables do not have the same type and value. Used on objects, it asserts that two variables do not reference the same object.

Parameters
mixed $expected
mixed $actual
string $message optional

assertNotSameSize() ¶ public static

assertNotSameSize(array|Countable|Traversable $expected, array|Countable|Traversable $actual, string $message = '')

Assert that the size of two arrays (or Countable or Traversable objects) is not the same.

Parameters
array|Countable|Traversable $expected
array|Countable|Traversable $actual
string $message optional

assertNotTrue() ¶ public static

assertNotTrue(bool $condition, string $message = '')

Asserts that a condition is not true.

Parameters
bool $condition
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertNotWithinRange() ¶ protected static

assertNotWithinRange(float $expected, float $result, float $margin, string $message = ''): void

Compatibility function to test if a value is not between an acceptable range.

Parameters
float $expected
float $result
float $margin

the rage of acceptation

string $message optional

the text to display if the assertion is not correct

Returns
void

assertNull() ¶ public static

assertNull(mixed $actual, string $message = '')

Asserts that a variable is null.

Parameters
mixed $actual
string $message optional

assertObjectHasAttribute() ¶ public static

assertObjectHasAttribute(string $attributeName, object $object, string $message = '')

Asserts that an object has a specified attribute.

Parameters
string $attributeName
object $object
string $message optional

assertObjectNotHasAttribute() ¶ public static

assertObjectNotHasAttribute(string $attributeName, object $object, string $message = '')

Asserts that an object does not have a specified attribute.

Parameters
string $attributeName
object $object
string $message optional

assertPathEquals() ¶ protected static

assertPathEquals(string $expected, string $result, string $message = ''): void

Compatibility function to test paths.

Parameters
string $expected
string $result
string $message optional

the text to display if the assertion is not correct

Returns
void

assertPostConditions() ¶ protected

assertPostConditions()

Performs assertions shared by all tests of a test case.

This method is called after the execution of a test ends and before tearDown() is called.

assertPreConditions() ¶ protected

assertPreConditions()

Performs assertions shared by all tests of a test case.

This method is called before the execution of a test starts and after setUp() is called.

assertRegExp() ¶ public static

assertRegExp(string $pattern, string $string, string $message = '')

Asserts that a string matches a given regular expression.

Parameters
string $pattern
string $string
string $message optional

assertSame() ¶ public static

assertSame(mixed $expected, mixed $actual, string $message = '')

Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object.

Parameters
mixed $expected
mixed $actual
string $message optional

assertSameSize() ¶ public static

assertSameSize(array|Countable|Traversable $expected, array|Countable|Traversable $actual, string $message = '')

Assert that the size of two arrays (or Countable or Traversable objects) is the same.

Parameters
array|Countable|Traversable $expected
array|Countable|Traversable $actual
string $message optional

assertStringEndsNotWith() ¶ public static

assertStringEndsNotWith(string $suffix, string $string, string $message = '')

Asserts that a string ends not with a given suffix.

Parameters
string $suffix
string $string
string $message optional

assertStringEndsWith() ¶ public static

assertStringEndsWith(string $suffix, string $string, string $message = '')

Asserts that a string ends with a given suffix.

Parameters
string $suffix
string $string
string $message optional

assertStringEqualsFile() ¶ public static

assertStringEqualsFile(string $expectedFile, string $actualString, string $message = '', bool $canonicalize = false, bool $ignoreCase = false)

Asserts that the contents of a string is equal to the contents of a file.

Parameters
string $expectedFile
string $actualString
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

assertStringMatchesFormat() ¶ public static

assertStringMatchesFormat(string $format, string $string, string $message = '')

Asserts that a string matches a given format string.

Parameters
string $format
string $string
string $message optional

assertStringMatchesFormatFile() ¶ public static

assertStringMatchesFormatFile(string $formatFile, string $string, string $message = '')

Asserts that a string matches a given format file.

Parameters
string $formatFile
string $string
string $message optional

assertStringNotEqualsFile() ¶ public static

assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = '', bool $canonicalize = false, bool $ignoreCase = false)

Asserts that the contents of a string is not equal to the contents of a file.

Parameters
string $expectedFile
string $actualString
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

assertStringNotMatchesFormat() ¶ public static

assertStringNotMatchesFormat(string $format, string $string, string $message = '')

Asserts that a string does not match a given format string.

Parameters
string $format
string $string
string $message optional

assertStringNotMatchesFormatFile() ¶ public static

assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message = '')

Asserts that a string does not match a given format string.

Parameters
string $formatFile
string $string
string $message optional

assertStringStartsNotWith() ¶ public static

assertStringStartsNotWith(string $prefix, string $string, string $message = '')

Asserts that a string starts not with a given prefix.

Parameters
string $prefix
string $string
string $message optional

assertStringStartsWith() ¶ public static

assertStringStartsWith(string $prefix, string $string, string $message = '')

Asserts that a string starts with a given prefix.

Parameters
string $prefix
string $string
string $message optional

assertTags() ¶ public

assertTags(string $string, array $expected, bool $fullDebug = false): void

Asserts HTML tags.

Parameters
string $string

An HTML/XHTML/XML string

array $expected

An array, see above

bool $fullDebug optional

Whether or not more verbose output should be used.

Returns
void

assertTextContains() ¶ public

assertTextContains(string $needle, string $haystack, string $message = '', bool $ignoreCase = false): void

Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $needle

The string to search for.

string $haystack

The string to search through.

string $message optional

The message to display on failure.

bool $ignoreCase optional

Whether or not the search should be case-sensitive.

Returns
void

assertTextEndsNotWith() ¶ public

assertTextEndsNotWith(string $suffix, string $string, string $message = ''): void

Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $suffix

The suffix to not find.

string $string

The string to search.

string $message optional

The message to use for failure.

Returns
void

assertTextEndsWith() ¶ public

assertTextEndsWith(string $suffix, string $string, string $message = ''): void

Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $suffix

The suffix to find.

string $string

The string to search.

string $message optional

The message to use for failure.

Returns
void

assertTextEquals() ¶ public

assertTextEquals(string $expected, string $result, string $message = ''): void

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $expected

The expected value.

string $result

The actual value.

string $message optional

The message to use for failure.

Returns
void

assertTextNotContains() ¶ public

assertTextNotContains(string $needle, string $haystack, string $message = '', bool $ignoreCase = false): void

Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $needle

The string to search for.

string $haystack

The string to search through.

string $message optional

The message to display on failure.

bool $ignoreCase optional

Whether or not the search should be case-sensitive.

Returns
void

assertTextNotEquals() ¶ public

assertTextNotEquals(string $expected, string $result, string $message = ''): void

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $expected

The expected value.

string $result

The actual value.

string $message optional

The message to use for failure.

Returns
void

assertTextStartsNotWith() ¶ public

assertTextStartsNotWith(string $prefix, string $string, string $message = ''): void

Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $prefix

The prefix to not find.

string $string

The string to search.

string $message optional

The message to use for failure.

Returns
void

assertTextStartsWith() ¶ public

assertTextStartsWith(string $prefix, string $string, string $message = ''): void

Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters
string $prefix

The prefix to check for.

string $string

The string to search in.

string $message optional

The message to use for failure.

Returns
void

assertThat() ¶ public static

assertThat(mixed $value, PHPUnit_Framework_Constraint $constraint, string $message = '')

Evaluates a PHPUnit_Framework_Constraint matcher object.

Parameters
mixed $value
PHPUnit_Framework_Constraint $constraint
string $message optional

assertTrue() ¶ public static

assertTrue(bool $condition, string $message = '')

Asserts that a condition is true.

Parameters
bool $condition
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

assertWithinRange() ¶ protected static

assertWithinRange(float $expected, float $result, float $margin, string $message = ''): void

Compatibility function to test if a value is between an acceptable range.

Parameters
float $expected
float $result
float $margin

the rage of acceptation

string $message optional

the text to display if the assertion is not correct

Returns
void

assertXmlFileEqualsXmlFile() ¶ public static

assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = '')

Asserts that two XML files are equal.

Parameters
string $expectedFile
string $actualFile
string $message optional

assertXmlFileNotEqualsXmlFile() ¶ public static

assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = '')

Asserts that two XML files are not equal.

Parameters
string $expectedFile
string $actualFile
string $message optional

assertXmlStringEqualsXmlFile() ¶ public static

assertXmlStringEqualsXmlFile(string $expectedFile, string $actualXml, string $message = '')

Asserts that two XML documents are equal.

Parameters
string $expectedFile
string $actualXml
string $message optional

assertXmlStringEqualsXmlString() ¶ public static

assertXmlStringEqualsXmlString(string $expectedXml, string $actualXml, string $message = '')

Asserts that two XML documents are equal.

Parameters
string $expectedXml
string $actualXml
string $message optional

assertXmlStringNotEqualsXmlFile() ¶ public static

assertXmlStringNotEqualsXmlFile(string $expectedFile, string $actualXml, string $message = '')

Asserts that two XML documents are not equal.

Parameters
string $expectedFile
string $actualXml
string $message optional

assertXmlStringNotEqualsXmlString() ¶ public static

assertXmlStringNotEqualsXmlString(string $expectedXml, string $actualXml, string $message = '')

Asserts that two XML documents are not equal.

Parameters
string $expectedXml
string $actualXml
string $message optional

at() ¶ public static

at(int $index): PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex

Returns a matcher that matches when the method is executed at the given index.

Parameters
int $index
Returns
PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex

atLeast() ¶ public static

atLeast(int $requiredInvocations): PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastCount

Returns a matcher that matches when the method is executed at least N times.

Parameters
int $requiredInvocations
Returns
PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastCount

atLeastOnce() ¶ public static

atLeastOnce(): PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastOnce

Returns a matcher that matches when the method is executed at least once.

Returns
PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastOnce

atMost() ¶ public static

atMost(int $allowedInvocations): PHPUnit_Framework_MockObject_Matcher_InvokedAtMostCount

Returns a matcher that matches when the method is executed at most N times.

Parameters
int $allowedInvocations
Returns
PHPUnit_Framework_MockObject_Matcher_InvokedAtMostCount

attribute() ¶ public static

attribute(PHPUnit_Framework_Constraint $constraint, string $attributeName): PHPUnit_Framework_Constraint_Attribute

Returns a PHPUnit_Framework_Constraint_Attribute matcher object.

Parameters
PHPUnit_Framework_Constraint $constraint
string $attributeName
Returns
PHPUnit_Framework_Constraint_Attribute

attributeEqualTo() ¶ public static

attributeEqualTo(string $attributeName, mixed $value, float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false): PHPUnit_Framework_Constraint_Attribute

Returns a PHPUnit_Framework_Constraint_IsEqual matcher object that is wrapped in a PHPUnit_Framework_Constraint_Attribute matcher object.

Parameters
string $attributeName
mixed $value
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional
Returns
PHPUnit_Framework_Constraint_Attribute

callback() ¶ public static

callback(callable $callback): PHPUnit_Framework_Constraint_Callback

Returns a PHPUnit_Framework_Constraint_Callback matcher object.

Parameters
callable $callback
Returns
PHPUnit_Framework_Constraint_Callback

checkRequirements() ¶ protected

checkRequirements()

classHasAttribute() ¶ public static

classHasAttribute(string $attributeName): PHPUnit_Framework_Constraint_ClassHasAttribute

Returns a PHPUnit_Framework_Constraint_ClassHasAttribute matcher object.

Parameters
string $attributeName
Returns
PHPUnit_Framework_Constraint_ClassHasAttribute

classHasStaticAttribute() ¶ public static

classHasStaticAttribute(string $attributeName): PHPUnit_Framework_Constraint_ClassHasStaticAttribute

Returns a PHPUnit_Framework_Constraint_ClassHasStaticAttribute matcher object.

Parameters
string $attributeName
Returns
PHPUnit_Framework_Constraint_ClassHasStaticAttribute

contains() ¶ public static

contains(mixed $value, bool $checkForObjectIdentity = true, bool $checkForNonObjectIdentity = false): PHPUnit_Framework_Constraint_TraversableContains

Returns a PHPUnit_Framework_Constraint_TraversableContains matcher object.

Parameters
mixed $value
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional
Returns
PHPUnit_Framework_Constraint_TraversableContains

containsOnly() ¶ public static

containsOnly(string $type): PHPUnit_Framework_Constraint_TraversableContainsOnly

Returns a PHPUnit_Framework_Constraint_TraversableContainsOnly matcher object.

Parameters
string $type
Returns
PHPUnit_Framework_Constraint_TraversableContainsOnly

containsOnlyInstancesOf() ¶ public static

containsOnlyInstancesOf(string $classname): PHPUnit_Framework_Constraint_TraversableContainsOnly

Returns a PHPUnit_Framework_Constraint_TraversableContainsOnly matcher object.

Parameters
string $classname
Returns
PHPUnit_Framework_Constraint_TraversableContainsOnly

count() ¶ public

count(): int

Counts the number of test cases executed by run(TestResult result).

Returns
int

countOf() ¶ public static

countOf(int $count): PHPUnit_Framework_Constraint_Count

Returns a PHPUnit_Framework_Constraint_Count matcher object.

Parameters
int $count
Returns
PHPUnit_Framework_Constraint_Count

createConfiguredMock() ¶ protected

createConfiguredMock(string $originalClassName, array $configuration): PHPUnit_Framework_MockObject_MockObject

Returns a configured test double for the specified class.

Parameters
string $originalClassName
array $configuration
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

createMock() ¶ protected

createMock(string $originalClassName): PHPUnit_Framework_MockObject_MockObject

Returns a test double for the specified class.

Parameters
string $originalClassName
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

createPartialMock() ¶ protected

createPartialMock(string $originalClassName, array $methods): PHPUnit_Framework_MockObject_MockObject

Returns a partial test double for the specified class.

Parameters
string $originalClassName
array $methods
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

createResult() ¶ protected

createResult(): PHPUnit_Framework_TestResult

Creates a default TestResult object.

Returns
PHPUnit_Framework_TestResult

dataDescription() ¶ public

dataDescription(): string
Returns
string

directoryExists() ¶ public static

directoryExists(): PHPUnit_Framework_Constraint_DirectoryExists

Returns a PHPUnit_Framework_Constraint_DirectoryExists matcher object.

Returns
PHPUnit_Framework_Constraint_DirectoryExists

doesNotPerformAssertions() ¶ public

doesNotPerformAssertions(): bool
Returns
bool

equalTo() ¶ public static

equalTo(mixed $value, float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false, bool $ignoreCase = false): PHPUnit_Framework_Constraint_IsEqual

Returns a PHPUnit_Framework_Constraint_IsEqual matcher object.

Parameters
mixed $value
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional
Returns
PHPUnit_Framework_Constraint_IsEqual

exactly() ¶ public static

exactly(int $count): PHPUnit_Framework_MockObject_Matcher_InvokedCount

Returns a matcher that matches when the method is executed exactly $count times.

Parameters
int $count
Returns
PHPUnit_Framework_MockObject_Matcher_InvokedCount

expectException() ¶ public

expectException(string $exception)
Parameters
string $exception

expectExceptionCode() ¶ public

expectExceptionCode(int|string $code)
Parameters
int|string $code
Throws
PHPUnit_Framework_Exception

expectExceptionMessage() ¶ public

expectExceptionMessage(string $message)
Parameters
string $message
Throws
PHPUnit_Framework_Exception

expectExceptionMessageRegExp() ¶ public

expectExceptionMessageRegExp(string $messageRegExp)
Parameters
string $messageRegExp
Throws
PHPUnit_Framework_Exception

expectOutputRegex() ¶ public

expectOutputRegex(string $expectedRegex)
Parameters
string $expectedRegex
Throws
PHPUnit_Framework_Exception

expectOutputString() ¶ public

expectOutputString(string $expectedString)
Parameters
string $expectedString

fail() ¶ public static

fail(string $message = '')

Fails a test with the given message.

Parameters
string $message optional
Throws
PHPUnit_Framework_AssertionFailedError

fileExists() ¶ public static

fileExists(): PHPUnit_Framework_Constraint_FileExists

Returns a PHPUnit_Framework_Constraint_FileExists matcher object.

Returns
PHPUnit_Framework_Constraint_FileExists

getActualOutput() ¶ public

getActualOutput(): string
Returns
string

getAnnotations() ¶ public

getAnnotations(): array

Returns the annotations for this test.

Returns
array

getCount() ¶ public static

getCount(): int

Return the current assertion count.

Returns
int

getDataSetAsString() ¶ protected

getDataSetAsString(bool $includeData = true): string

Gets the data set description of a TestCase.

Parameters
bool $includeData optional
Returns
string

getExpectedException() ¶ public

getExpectedException(): string
Returns
string

getGroups() ¶ public

getGroups()

getMock() ¶ protected

getMock(string $originalClassName, array|null $methods = [], array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = false, bool $callOriginalMethods = false, object $proxyTarget = null): PHPUnit_Framework_MockObject_MockObject

Returns a mock object for the specified class.

Parameters
string $originalClassName

Name of the class to mock.

array|null $methods optional

When provided, only methods whose names are in the array are replaced with a configurable test double. The behavior of the other methods is not changed. Providing null means that no methods will be replaced.

array $arguments optional

Parameters to pass to the original class' constructor.

string $mockClassName optional

Class name for the generated test double class.

bool $callOriginalConstructor optional

Can be used to disable the call to the original class' constructor.

bool $callOriginalClone optional

Can be used to disable the call to the original class' clone constructor.

bool $callAutoload optional

Can be used to disable __autoload() during the generation of the test double class.

bool $cloneArguments optional
bool $callOriginalMethods optional
object $proxyTarget optional
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

getMockBuilder() ¶ public

getMockBuilder(string|string[] $className): PHPUnit_Framework_MockObject_MockBuilder

Returns a builder object to create mock objects using a fluent interface.

Parameters
string|string[] $className
Returns
PHPUnit_Framework_MockObject_MockBuilder

getMockClass() ¶ protected

getMockClass(string $originalClassName, array $methods = [], array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = false, bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = false): string

Mocks the specified class and returns the name of the mocked class.

Parameters
string $originalClassName
array $methods optional
array $arguments optional
string $mockClassName optional
bool $callOriginalConstructor optional
bool $callOriginalClone optional
bool $callAutoload optional
bool $cloneArguments optional
Returns
string
Throws
PHPUnit_Framework_Exception

getMockForAbstractClass() ¶ protected

getMockForAbstractClass(string $originalClassName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): PHPUnit_Framework_MockObject_MockObject

Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default. To mock concrete methods, use the 7th parameter ($mockedMethods).

Parameters
string $originalClassName
array $arguments optional
string $mockClassName optional
bool $callOriginalConstructor optional
bool $callOriginalClone optional
bool $callAutoload optional
array $mockedMethods optional
bool $cloneArguments optional
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

getMockForModel() ¶ public

getMockForModel(string $alias, mixed $methods = [], array $options = []): Cake\ORM\Table|PHPUnit_Framework_MockObject_MockObject

Mock a model, maintain fixtures and table association

Parameters
string $alias

The model to get a mock for.

mixed $methods optional

The list of methods to mock

array $options optional

The config data for the mock's constructor.

Returns
Cake\ORM\Table|PHPUnit_Framework_MockObject_MockObject
Throws
Cake\ORM\Exception\MissingTableClassException

getMockForTrait() ¶ protected

getMockForTrait(string $traitName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): PHPUnit_Framework_MockObject_MockObject

Returns a mock object for the specified trait with all abstract methods of the trait mocked. Concrete methods to mock can be specified with the $mockedMethods parameter.

Parameters
string $traitName
array $arguments optional
string $mockClassName optional
bool $callOriginalConstructor optional
bool $callOriginalClone optional
bool $callAutoload optional
array $mockedMethods optional
bool $cloneArguments optional
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

getMockFromWsdl() ¶ protected

getMockFromWsdl(string $wsdlFile, string $originalClassName = '', string $mockClassName = '', array $methods = [], bool $callOriginalConstructor = true, array $options = []): PHPUnit_Framework_MockObject_MockObject

Returns a mock object based on the given WSDL file.

Parameters
string $wsdlFile
string $originalClassName optional
string $mockClassName optional
array $methods optional
bool $callOriginalConstructor optional
array $options optional

An array of options passed to SOAPClient::_construct

Returns
PHPUnit_Framework_MockObject_MockObject

getMockObjectGenerator() ¶ protected

getMockObjectGenerator(): PHPUnit_Framework_MockObject_Generator

Get the mock object generator, creating it if it doesn't exist.

Returns
PHPUnit_Framework_MockObject_Generator

getMockWithoutInvokingTheOriginalConstructor() ¶ protected

getMockWithoutInvokingTheOriginalConstructor(string $originalClassName): PHPUnit_Framework_MockObject_MockObject

Returns a mock with disabled constructor object for the specified class.

Parameters
string $originalClassName
Returns
PHPUnit_Framework_MockObject_MockObject
Throws
PHPUnit_Framework_Exception

getName() ¶ public

getName(bool $withDataSet = true): string

Gets the name of a TestCase.

Parameters
bool $withDataSet optional
Returns
string

getNumAssertions() ¶ public

getNumAssertions(): int

Returns the number of assertions performed by this test.

Returns
int

getObjectAttribute() ¶ public static

getObjectAttribute(object $object, string $attributeName): mixed

Returns the value of an object's attribute. This also works for attributes that are declared protected or private.

Parameters
object $object
string $attributeName
Returns
mixed
Throws
PHPUnit_Framework_Exception

getObjectForTrait() ¶ protected

getObjectForTrait(string $traitName, array $arguments = [], string $traitClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, bool $cloneArguments = false): object

Returns an object for the specified trait.

Parameters
string $traitName
array $arguments optional
string $traitClassName optional
bool $callOriginalConstructor optional
bool $callOriginalClone optional
bool $callAutoload optional
bool $cloneArguments optional
Returns
object
Throws
PHPUnit_Framework_Exception

getProvidedData() ¶ protected

getProvidedData(): array

Gets the data set of a TestCase.

Returns
array

getResult() ¶ public

getResult(): mixed
Returns
mixed

getSize() ¶ public

getSize(): int

Returns the size of the test.

Returns
int

getStaticAttribute() ¶ public static

getStaticAttribute(string $className, string $attributeName): mixed

Returns the value of a static attribute. This also works for attributes that are declared protected or private.

Parameters
string $className
string $attributeName
Returns
mixed
Throws
PHPUnit_Framework_Exception

getStatus() ¶ public

getStatus(): int

Returns the status of this test.

Returns
int

getStatusMessage() ¶ public

getStatusMessage(): string

Returns the status message of this test.

Returns
string

getTestResultObject() ¶ public

getTestResultObject(): PHPUnit_Framework_TestResult
Returns
PHPUnit_Framework_TestResult

greaterThan() ¶ public static

greaterThan(mixed $value): PHPUnit_Framework_Constraint_GreaterThan

Returns a PHPUnit_Framework_Constraint_GreaterThan matcher object.

Parameters
mixed $value
Returns
PHPUnit_Framework_Constraint_GreaterThan

greaterThanOrEqual() ¶ public static

greaterThanOrEqual(mixed $value): PHPUnit_Framework_Constraint_Or

Returns a PHPUnit_Framework_Constraint_Or matcher object that wraps a PHPUnit_Framework_Constraint_IsEqual and a PHPUnit_Framework_Constraint_GreaterThan matcher object.

Parameters
mixed $value
Returns
PHPUnit_Framework_Constraint_Or

handleDependencies() ¶ protected

handleDependencies()

hasDependencies() ¶ public

hasDependencies(): bool

Returns true if the tests has dependencies

Returns
bool

hasExpectationOnOutput() ¶ public

hasExpectationOnOutput(): bool
Returns
bool

hasFailed() ¶ public

hasFailed(): bool

Returns whether or not this test has failed.

Returns
bool

hasOutput() ¶ public

hasOutput(): bool
Returns
bool

hasPerformedExpectationsOnOutput() ¶ public

hasPerformedExpectationsOnOutput(): bool
Returns
bool

hasSize() ¶ public

hasSize(): bool
Returns
bool

identicalTo() ¶ public static

identicalTo(mixed $value): PHPUnit_Framework_Constraint_IsIdentical

Returns a PHPUnit_Framework_Constraint_IsIdentical matcher object.

Parameters
mixed $value
Returns
PHPUnit_Framework_Constraint_IsIdentical

iniSet() ¶ protected

iniSet(string $varName, string $newValue)

This method is a wrapper for the ini_set() function that automatically resets the modified php.ini setting to its original value after the test is run.

Parameters
string $varName
string $newValue
Throws
PHPUnit_Framework_Exception

isEmpty() ¶ public static

isEmpty(): PHPUnit_Framework_Constraint_IsEmpty

Returns a PHPUnit_Framework_Constraint_IsEmpty matcher object.

Returns
PHPUnit_Framework_Constraint_IsEmpty

isFalse() ¶ public static

isFalse(): PHPUnit_Framework_Constraint_IsFalse

Returns a PHPUnit_Framework_Constraint_IsFalse matcher object.

Returns
PHPUnit_Framework_Constraint_IsFalse

isFinite() ¶ public static

isFinite(): PHPUnit_Framework_Constraint_IsFinite

Returns a PHPUnit_Framework_Constraint_IsFinite matcher object.

Returns
PHPUnit_Framework_Constraint_IsFinite

isInIsolation() ¶ public

isInIsolation(): bool
Returns
bool

isInfinite() ¶ public static

isInfinite(): PHPUnit_Framework_Constraint_IsInfinite

Returns a PHPUnit_Framework_Constraint_IsInfinite matcher object.

Returns
PHPUnit_Framework_Constraint_IsInfinite

isInstanceOf() ¶ public static

isInstanceOf(string $className): PHPUnit_Framework_Constraint_IsInstanceOf

Returns a PHPUnit_Framework_Constraint_IsInstanceOf matcher object.

Parameters
string $className
Returns
PHPUnit_Framework_Constraint_IsInstanceOf

isJson() ¶ public static

isJson(): PHPUnit_Framework_Constraint_IsJson

Returns a PHPUnit_Framework_Constraint_IsJson matcher object.

Returns
PHPUnit_Framework_Constraint_IsJson

isLarge() ¶ public

isLarge(): bool
Returns
bool

isMedium() ¶ public

isMedium(): bool
Returns
bool

isNan() ¶ public static

isNan(): PHPUnit_Framework_Constraint_IsNan

Returns a PHPUnit_Framework_Constraint_IsNan matcher object.

Returns
PHPUnit_Framework_Constraint_IsNan

isNull() ¶ public static

isNull(): PHPUnit_Framework_Constraint_IsNull

Returns a PHPUnit_Framework_Constraint_IsNull matcher object.

Returns
PHPUnit_Framework_Constraint_IsNull

isReadable() ¶ public static

isReadable(): PHPUnit_Framework_Constraint_IsReadable

Returns a PHPUnit_Framework_Constraint_IsReadable matcher object.

Returns
PHPUnit_Framework_Constraint_IsReadable

isSmall() ¶ public

isSmall(): bool
Returns
bool

isTrue() ¶ public static

isTrue(): PHPUnit_Framework_Constraint_IsTrue

Returns a PHPUnit_Framework_Constraint_IsTrue matcher object.

Returns
PHPUnit_Framework_Constraint_IsTrue

isType() ¶ public static

isType(string $type): PHPUnit_Framework_Constraint_IsType

Returns a PHPUnit_Framework_Constraint_IsType matcher object.

Parameters
string $type
Returns
PHPUnit_Framework_Constraint_IsType

isWritable() ¶ public static

isWritable(): PHPUnit_Framework_Constraint_IsWritable

Returns a PHPUnit_Framework_Constraint_IsWritable matcher object.

Returns
PHPUnit_Framework_Constraint_IsWritable

lessThan() ¶ public static

lessThan(mixed $value): PHPUnit_Framework_Constraint_LessThan

Returns a PHPUnit_Framework_Constraint_LessThan matcher object.

Parameters
mixed $value
Returns
PHPUnit_Framework_Constraint_LessThan

lessThanOrEqual() ¶ public static

lessThanOrEqual(mixed $value): PHPUnit_Framework_Constraint_Or

Returns a PHPUnit_Framework_Constraint_Or matcher object that wraps a PHPUnit_Framework_Constraint_IsEqual and a PHPUnit_Framework_Constraint_LessThan matcher object.

Parameters
mixed $value
Returns
PHPUnit_Framework_Constraint_Or

loadFixtures() ¶ public

loadFixtures(): void

Chooses which fixtures to load for a given test

Each parameter is a model name that corresponds to a fixture, i.e. 'Posts', 'Authors', etc.

Returns
void
Throws
Exception
when no fixture manager is available.
See Also
\Cake\TestSuite\TestCase::$autoFixtures

logicalAnd() ¶ public static

logicalAnd(): PHPUnit_Framework_Constraint_And

Returns a PHPUnit_Framework_Constraint_And matcher object.

Returns
PHPUnit_Framework_Constraint_And

logicalNot() ¶ public static

logicalNot(PHPUnit_Framework_Constraint $constraint): PHPUnit_Framework_Constraint_Not

Returns a PHPUnit_Framework_Constraint_Not matcher object.

Parameters
PHPUnit_Framework_Constraint $constraint
Returns
PHPUnit_Framework_Constraint_Not

logicalOr() ¶ public static

logicalOr(): PHPUnit_Framework_Constraint_Or

Returns a PHPUnit_Framework_Constraint_Or matcher object.

Returns
PHPUnit_Framework_Constraint_Or

logicalXor() ¶ public static

logicalXor(): PHPUnit_Framework_Constraint_Xor

Returns a PHPUnit_Framework_Constraint_Xor matcher object.

Returns
PHPUnit_Framework_Constraint_Xor

markAsRisky() ¶ public

markAsRisky()

markTestIncomplete() ¶ public static

markTestIncomplete(string $message = '')

Mark the test as incomplete.

Parameters
string $message optional
Throws
PHPUnit_Framework_IncompleteTestError

markTestSkipped() ¶ public static

markTestSkipped(string $message = '')

Mark the test as skipped.

Parameters
string $message optional
Throws
PHPUnit_Framework_SkippedTestError

matches() ¶ public static

matches(string $string): PHPUnit_Framework_Constraint_StringMatches

Returns a PHPUnit_Framework_Constraint_StringMatches matcher object.

Parameters
string $string
Returns
PHPUnit_Framework_Constraint_StringMatches

matchesRegularExpression() ¶ public static

matchesRegularExpression(string $pattern): PHPUnit_Framework_Constraint_PCREMatch

Returns a PHPUnit_Framework_Constraint_PCREMatch matcher object.

Parameters
string $pattern
Returns
PHPUnit_Framework_Constraint_PCREMatch

never() ¶ public static

never(): PHPUnit_Framework_MockObject_Matcher_InvokedCount

Returns a matcher that matches when the method is never executed.

Returns
PHPUnit_Framework_MockObject_Matcher_InvokedCount

objectHasAttribute() ¶ public static

objectHasAttribute(string $attributeName): PHPUnit_Framework_Constraint_ObjectHasAttribute

Returns a PHPUnit_Framework_Constraint_ObjectHasAttribute matcher object.

Parameters
string $attributeName
Returns
PHPUnit_Framework_Constraint_ObjectHasAttribute

onConsecutiveCalls() ¶ public static

onConsecutiveCalls(): PHPUnit_Framework_MockObject_Stub_ConsecutiveCalls
Returns
PHPUnit_Framework_MockObject_Stub_ConsecutiveCalls

onNotSuccessfulTest() ¶ protected

onNotSuccessfulTest(Exception|Throwable $e)

This method is called when a test method did not execute successfully.

Parameters
Exception|Throwable $e
Throws
Exception|Throwable

once() ¶ public static

once(): PHPUnit_Framework_MockObject_Matcher_InvokedCount

Returns a matcher that matches when the method is executed exactly once.

Returns
PHPUnit_Framework_MockObject_Matcher_InvokedCount

prepareTemplate() ¶ protected

prepareTemplate(Text_Template $template)

Performs custom preparations on the process isolation template.

Parameters
Text_Template $template

prophesize() ¶ protected

prophesize(string|null $classOrInterface = null): Prophecy\Prophecy\ObjectProphecy
Parameters
string|null $classOrInterface optional
Returns
Prophecy\Prophecy\ObjectProphecy
Throws
LogicException

readAttribute() ¶ public static

readAttribute(string|object $classOrObject, string $attributeName): mixed

Returns the value of an attribute of a class or an object. This also works for attributes that are declared protected or private.

Parameters
string|object $classOrObject
string $attributeName
Returns
mixed
Throws
PHPUnit_Framework_Exception

registerMockObject() ¶ public

registerMockObject(PHPUnit_Framework_MockObject_MockObject $mockObject)
Parameters
PHPUnit_Framework_MockObject_MockObject $mockObject

resetCount() ¶ public static

resetCount()

Reset the assertion counter.

returnArgument() ¶ public static

returnArgument(int $argumentIndex): PHPUnit_Framework_MockObject_Stub_ReturnArgument
Parameters
int $argumentIndex
Returns
PHPUnit_Framework_MockObject_Stub_ReturnArgument

returnCallback() ¶ public static

returnCallback(mixed $callback): PHPUnit_Framework_MockObject_Stub_ReturnCallback
Parameters
mixed $callback
Returns
PHPUnit_Framework_MockObject_Stub_ReturnCallback

returnSelf() ¶ public static

returnSelf(): PHPUnit_Framework_MockObject_Stub_ReturnSelf

Returns the current object.

This method is useful when mocking a fluent interface.

Returns
PHPUnit_Framework_MockObject_Stub_ReturnSelf

returnValue() ¶ public static

returnValue(mixed $value): PHPUnit_Framework_MockObject_Stub_Return
Parameters
mixed $value
Returns
PHPUnit_Framework_MockObject_Stub_Return

returnValueMap() ¶ public static

returnValueMap(array $valueMap): PHPUnit_Framework_MockObject_Stub_ReturnValueMap
Parameters
array $valueMap
Returns
PHPUnit_Framework_MockObject_Stub_ReturnValueMap

run() ¶ public

run(PHPUnit_Framework_TestResult $result = null): PHPUnit_Framework_TestResult

Runs the test case and collects the results in a TestResult object. If no TestResult object is passed a new one will be created.

Parameters
PHPUnit_Framework_TestResult $result optional
Returns
PHPUnit_Framework_TestResult
Throws
PHPUnit_Framework_Exception

runBare() ¶ public

runBare()

Runs the bare test sequence.

runTest() ¶ protected

runTest(): mixed

Override to run the test and assert its state.

Returns
mixed
Throws
Exception|PHPUnit_Framework_Exception

PHPUnit_Framework_Exception

setBackupGlobals() ¶ public

setBackupGlobals(bool $backupGlobals)

Calling this method in setUp() has no effect!

Parameters
bool $backupGlobals

setBackupStaticAttributes() ¶ public

setBackupStaticAttributes(bool $backupStaticAttributes)

Calling this method in setUp() has no effect!

Parameters
bool $backupStaticAttributes

setBeStrictAboutChangesToGlobalState() ¶ public

setBeStrictAboutChangesToGlobalState(bool $beStrictAboutChangesToGlobalState)
Parameters
bool $beStrictAboutChangesToGlobalState

setDependencies() ¶ public

setDependencies(array $dependencies)

Sets the dependencies of a TestCase.

Parameters
array $dependencies

setDependencyInput() ¶ public

setDependencyInput(array $dependencyInput)

Sets

Parameters
array $dependencyInput

setExpectedException() ¶ public

setExpectedException(mixed $exception, string $message = '', int|string $code = null)
Parameters
mixed $exception
string $message optional

Null means we do not check message at all, string (even empty) means we do. Default: null.

int|string $code optional

Null means we do not check code at all, non-null means we do.

Throws
PHPUnit_Framework_Exception

setExpectedExceptionFromAnnotation() ¶ protected

setExpectedExceptionFromAnnotation()

setExpectedExceptionRegExp() ¶ public

setExpectedExceptionRegExp(mixed $exception, string $messageRegExp = '', int $code = null)
Parameters
mixed $exception
string $messageRegExp optional
int $code optional
Throws
PHPUnit_Framework_Exception

setGroups() ¶ public

setGroups(array $groups)
Parameters
array $groups

setInIsolation() ¶ public

setInIsolation(bool $inIsolation)
Parameters
bool $inIsolation
Throws
PHPUnit_Framework_Exception

setLocale() ¶ protected

setLocale()

This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.

Throws
PHPUnit_Framework_Exception

setName() ¶ public

setName(mixed $name)

Sets the name of a TestCase.

Parameters
$name

setOutputCallback() ¶ public

setOutputCallback(callable $callback)
Parameters
callable $callback
Throws
PHPUnit_Framework_Exception

setPreserveGlobalState() ¶ public

setPreserveGlobalState(bool $preserveGlobalState)
Parameters
bool $preserveGlobalState
Throws
PHPUnit_Framework_Exception

setRegisterMockObjectsFromTestArgumentsRecursively() ¶ public

setRegisterMockObjectsFromTestArgumentsRecursively(bool $flag)
Parameters
bool $flag

setResult() ¶ public

setResult(mixed $result)
Parameters
mixed $result

setRunTestInSeparateProcess() ¶ public

setRunTestInSeparateProcess(bool $runTestInSeparateProcess)
Parameters
bool $runTestInSeparateProcess
Throws
PHPUnit_Framework_Exception

setTestResultObject() ¶ public

setTestResultObject(PHPUnit_Framework_TestResult $result)
Parameters
PHPUnit_Framework_TestResult $result

setUp() ¶ public

setUp(): void

Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.

Returns
void

setUpBeforeClass() ¶ public static

setUpBeforeClass()

This method is called before the first test of this test class is run.

setUseErrorHandler() ¶ public

setUseErrorHandler(bool $useErrorHandler)
Parameters
bool $useErrorHandler

setUseErrorHandlerFromAnnotation() ¶ protected

setUseErrorHandlerFromAnnotation()

skipIf() ¶ public

skipIf(bool $shouldSkip, string $message = ''): bool

Overrides SimpleTestCase::skipIf to provide a boolean return value

Parameters
bool $shouldSkip

Whether or not the test should be skipped.

string $message optional

The message to display.

Returns
bool

skipUnless() ¶ protected

skipUnless(bool $condition, string $message = ''): bool

Compatibility function for skipping.

Parameters
bool $condition

Condition to trigger skipping

string $message optional

Message for skip

Returns
bool

stringContains() ¶ public static

stringContains(string $string, bool $case = true): PHPUnit_Framework_Constraint_StringContains

Returns a PHPUnit_Framework_Constraint_StringContains matcher object.

Parameters
string $string
bool $case optional
Returns
PHPUnit_Framework_Constraint_StringContains

stringEndsWith() ¶ public static

stringEndsWith(mixed $suffix): PHPUnit_Framework_Constraint_StringEndsWith

Returns a PHPUnit_Framework_Constraint_StringEndsWith matcher object.

Parameters
mixed $suffix
Returns
PHPUnit_Framework_Constraint_StringEndsWith

stringStartsWith() ¶ public static

stringStartsWith(mixed $prefix): PHPUnit_Framework_Constraint_StringStartsWith

Returns a PHPUnit_Framework_Constraint_StringStartsWith matcher object.

Parameters
mixed $prefix
Returns
PHPUnit_Framework_Constraint_StringStartsWith

tearDown() ¶ public

tearDown(): void

teardown any static object changes and restore them.

Returns
void

tearDownAfterClass() ¶ public static

tearDownAfterClass()

This method is called after the last test of this test class is run.

throwException() ¶ public static

throwException(Throwable|Exception $exception): PHPUnit_Framework_MockObject_Stub_Exception
Parameters
Throwable|Exception $exception
Returns
PHPUnit_Framework_MockObject_Stub_Exception

toString() ¶ public

toString(): string

Returns a string representation of the test case.

Returns
string

usesDataProvider() ¶ public

usesDataProvider(): bool
Returns
bool

verifyMockObjects() ¶ protected

verifyMockObjects()

Verifies the mock object expectations.

Property Detail

$_configure ¶ protected

Configure values to restore at end of test.

Type
array

$_pathRestore ¶ protected

Path settings to restore at the end of the test.

Type
array

$autoFixtures ¶ public

By default, all fixtures attached to this class will be truncated and reloaded after each test. Set this to false to handle manually

Type
bool

$backupGlobals ¶ protected

Enable or disable the backup and restoration of the $GLOBALS array. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!

Type
bool

$backupGlobalsBlacklist ¶ protected

Type
array

$backupStaticAttributes ¶ protected

Enable or disable the backup and restoration of static attributes. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!

Type
bool

$backupStaticAttributesBlacklist ¶ protected

Type
array

$dropTables ¶ public

Control table create/drops on each test method.

If true, tables will still be dropped at the end of each test runner execution.

Type
bool

$fixtureManager ¶ public

The class responsible for managing the creation, loading and removing of fixtures

Type
Cake\TestSuite\Fixture\FixtureManager

$preserveGlobalState ¶ protected

Whether or not this test should preserve the global state when running in a separate PHP process.

Type
bool

$runTestInSeparateProcess ¶ protected

Whether or not this test is to be run in a separate PHP process.

Type
bool
OpenHub
Pingping
Linode
  • 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
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs