Menu

## Functions.php

### Table of Contents

assertArrayHasKey() : void
  Asserts that an array has a specified key.
assertArrayNotHasKey() : void
  Asserts that an array does not have a specified key.
assertContains() : void
  Asserts that a haystack contains a needle.
assertContainsEquals() : void
assertNotContains() : void
  Asserts that a haystack does not contain a needle.
assertNotContainsEquals() : void
assertContainsOnly() : void
  Asserts that a haystack contains only values of a given type.
assertContainsOnlyInstancesOf() : void
  Asserts that a haystack contains only instances of a given class name.
assertNotContainsOnly() : void
  Asserts that a haystack does not contain only values of a given type.
assertCount() : void
  Asserts the number of elements of an array, Countable or Traversable.
assertNotCount() : void
  Asserts the number of elements of an array, Countable or Traversable.
assertEquals() : void
  Asserts that two variables are equal.
assertEqualsCanonicalizing() : void
  Asserts that two variables are equal (canonicalizing).
assertEqualsIgnoringCase() : void
  Asserts that two variables are equal (ignoring case).
assertEqualsWithDelta() : void
  Asserts that two variables are equal (with delta).
assertNotEquals() : void
  Asserts that two variables are not equal.
assertNotEqualsCanonicalizing() : void
  Asserts that two variables are not equal (canonicalizing).
assertNotEqualsIgnoringCase() : void
  Asserts that two variables are not equal (ignoring case).
assertNotEqualsWithDelta() : void
  Asserts that two variables are not equal (with delta).
assertObjectEquals() : void
assertEmpty() : void
  Asserts that a variable is empty.
assertNotEmpty() : void
  Asserts that a variable is not empty.
assertGreaterThan() : void
  Asserts that a value is greater than another value.
assertGreaterThanOrEqual() : void
  Asserts that a value is greater than or equal to another value.
assertLessThan() : void
  Asserts that a value is smaller than another value.
assertLessThanOrEqual() : void
  Asserts that a value is smaller than or equal to another value.
assertFileEquals() : void
  Asserts that the contents of one file is equal to the contents of another file.
assertFileEqualsCanonicalizing() : void
  Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
assertFileEqualsIgnoringCase() : void
  Asserts that the contents of one file is equal to the contents of another file (ignoring case).
assertFileNotEquals() : void
  Asserts that the contents of one file is not equal to the contents of another file.
assertFileNotEqualsCanonicalizing() : void
  Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
assertFileNotEqualsIgnoringCase() : void
  Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
assertStringEqualsFile() : void
  Asserts that the contents of a string is equal to the contents of a file.
assertStringEqualsFileCanonicalizing() : void
  Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
assertStringEqualsFileIgnoringCase() : void
  Asserts that the contents of a string is equal to the contents of a file (ignoring case).
assertStringNotEqualsFile() : void
  Asserts that the contents of a string is not equal to the contents of a file.
assertStringNotEqualsFileCanonicalizing() : void
  Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
assertStringNotEqualsFileIgnoringCase() : void
  Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
assertIsReadable() : void
  Asserts that a file/dir is readable.
assertIsNotReadable() : void
  Asserts that a file/dir exists and is not readable.
assertNotIsReadable() : void
  Asserts that a file/dir exists and is not readable.
assertIsWritable() : void
  Asserts that a file/dir exists and is writable.
assertIsNotWritable() : void
  Asserts that a file/dir exists and is not writable.
assertNotIsWritable() : void
  Asserts that a file/dir exists and is not writable.
assertDirectoryExists() : void
  Asserts that a directory exists.
assertDirectoryDoesNotExist() : void
  Asserts that a directory does not exist.
assertDirectoryNotExists() : void
  Asserts that a directory does not exist.
assertDirectoryIsReadable() : void
  Asserts that a directory exists and is readable.
assertDirectoryIsNotReadable() : void
  Asserts that a directory exists and is not readable.
assertDirectoryNotIsReadable() : void
  Asserts that a directory exists and is not readable.
assertDirectoryIsWritable() : void
  Asserts that a directory exists and is writable.
assertDirectoryIsNotWritable() : void
  Asserts that a directory exists and is not writable.
assertDirectoryNotIsWritable() : void
  Asserts that a directory exists and is not writable.
assertFileExists() : void
  Asserts that a file exists.
assertFileDoesNotExist() : void
  Asserts that a file does not exist.
assertFileNotExists() : void
  Asserts that a file does not exist.
assertFileIsReadable() : void
  Asserts that a file exists and is readable.
assertFileIsNotReadable() : void
  Asserts that a file exists and is not readable.
assertFileNotIsReadable() : void
  Asserts that a file exists and is not readable.
assertFileIsWritable() : void
  Asserts that a file exists and is writable.
assertFileIsNotWritable() : void
  Asserts that a file exists and is not writable.
assertFileNotIsWritable() : void
  Asserts that a file exists and is not writable.
assertTrue() : void
  Asserts that a condition is true.
assertNotTrue() : void
  Asserts that a condition is not true.
assertFalse() : void
  Asserts that a condition is false.
assertNotFalse() : void
  Asserts that a condition is not false.
assertNull() : void
  Asserts that a variable is null.
assertNotNull() : void
  Asserts that a variable is not null.
assertFinite() : void
  Asserts that a variable is finite.
assertInfinite() : void
  Asserts that a variable is infinite.
assertNan() : void
  Asserts that a variable is nan.
assertClassHasAttribute() : void
  Asserts that a class has a specified attribute.
assertClassNotHasAttribute() : void
  Asserts that a class does not have a specified attribute.
assertClassHasStaticAttribute() : void
  Asserts that a class has a specified static attribute.
assertClassNotHasStaticAttribute() : void
  Asserts that a class does not have a specified static attribute.
assertObjectHasAttribute() : void
  Asserts that an object has a specified attribute.
assertObjectNotHasAttribute() : void
  Asserts that an object does not have a specified attribute.
assertSame() : void
  Asserts that two variables have the same type and value.
assertNotSame() : void
  Asserts that two variables do not have the same type and value.
assertInstanceOf() : void
  Asserts that a variable is of a given type.
assertNotInstanceOf() : void
  Asserts that a variable is not of a given type.
assertIsArray() : void
  Asserts that a variable is of type array.
assertIsBool() : void
  Asserts that a variable is of type bool.
assertIsFloat() : void
  Asserts that a variable is of type float.
assertIsInt() : void
  Asserts that a variable is of type int.
assertIsNumeric() : void
  Asserts that a variable is of type numeric.
assertIsObject() : void
  Asserts that a variable is of type object.
assertIsResource() : void
  Asserts that a variable is of type resource.
assertIsClosedResource() : void
  Asserts that a variable is of type resource and is closed.
assertIsString() : void
  Asserts that a variable is of type string.
assertIsScalar() : void
  Asserts that a variable is of type scalar.
assertIsCallable() : void
  Asserts that a variable is of type callable.
assertIsIterable() : void
  Asserts that a variable is of type iterable.
assertIsNotArray() : void
  Asserts that a variable is not of type array.
assertIsNotBool() : void
  Asserts that a variable is not of type bool.
assertIsNotFloat() : void
  Asserts that a variable is not of type float.
assertIsNotInt() : void
  Asserts that a variable is not of type int.
assertIsNotNumeric() : void
  Asserts that a variable is not of type numeric.
assertIsNotObject() : void
  Asserts that a variable is not of type object.
assertIsNotResource() : void
  Asserts that a variable is not of type resource.
assertIsNotClosedResource() : void
  Asserts that a variable is not of type resource.
assertIsNotString() : void
  Asserts that a variable is not of type string.
assertIsNotScalar() : void
  Asserts that a variable is not of type scalar.
assertIsNotCallable() : void
  Asserts that a variable is not of type callable.
assertIsNotIterable() : void
  Asserts that a variable is not of type iterable.
assertMatchesRegularExpression() : void
  Asserts that a string matches a given regular expression.
assertRegExp() : void
  Asserts that a string matches a given regular expression.
assertDoesNotMatchRegularExpression() : void
  Asserts that a string does not match a given regular expression.
assertNotRegExp() : void
  Asserts that a string does not match a given regular expression.
assertSameSize() : void
  Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
assertNotSameSize() : void
  Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
assertStringMatchesFormat() : void
  Asserts that a string matches a given format string.
assertStringNotMatchesFormat() : void
  Asserts that a string does not match a given format string.
assertStringMatchesFormatFile() : void
  Asserts that a string matches a given format file.
assertStringNotMatchesFormatFile() : void
  Asserts that a string does not match a given format string.
assertStringStartsWith() : void
  Asserts that a string starts with a given prefix.
assertStringStartsNotWith() : void
  Asserts that a string starts not with a given prefix.
assertStringContainsString() : void
assertStringContainsStringIgnoringCase() : void
assertStringNotContainsString() : void
assertStringNotContainsStringIgnoringCase() : void
assertStringEndsWith() : void
  Asserts that a string ends with a given suffix.
assertStringEndsNotWith() : void
  Asserts that a string ends not with a given suffix.
assertXmlFileEqualsXmlFile() : void
  Asserts that two XML files are equal.
assertXmlFileNotEqualsXmlFile() : void
  Asserts that two XML files are not equal.
assertXmlStringEqualsXmlFile() : void
  Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlFile() : void
  Asserts that two XML documents are not equal.
assertXmlStringEqualsXmlString() : void
  Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlString() : void
  Asserts that two XML documents are not equal.
assertEqualXMLStructure() : void
  Asserts that a hierarchy of DOMElements matches.
assertThat() : void
  Evaluates a PHPUnit\Framework\Constraint matcher object.
assertJson() : void
  Asserts that a string is a valid JSON string.
assertJsonStringEqualsJsonString() : void
  Asserts that two given JSON encoded objects or arrays are equal.
assertJsonStringNotEqualsJsonString() : void
  Asserts that two given JSON encoded objects or arrays are not equal.
assertJsonStringEqualsJsonFile() : void
  Asserts that the generated JSON encoded object and the content of the given file are equal.
assertJsonStringNotEqualsJsonFile() : void
  Asserts that the generated JSON encoded object and the content of the given file are not equal.
assertJsonFileEqualsJsonFile() : void
  Asserts that two JSON files are equal.
assertJsonFileNotEqualsJsonFile() : void
  Asserts that two JSON files are not equal.
logicalAnd() : LogicalAnd
logicalOr() : LogicalOr
logicalNot() : LogicalNot
logicalXor() : LogicalXor
anything() : IsAnything
isTrue() : IsTrue
callback() : Callback
isFalse() : IsFalse
isJson() : IsJson
isNull() : IsNull
isFinite() : IsFinite
isInfinite() : IsInfinite
isNan() : IsNan
containsEqual() : TraversableContainsEqual
containsIdentical() : TraversableContainsIdentical
containsOnly() : TraversableContainsOnly
containsOnlyInstancesOf() : TraversableContainsOnly
arrayHasKey() : ArrayHasKey
equalTo() : IsEqual
equalToCanonicalizing() : IsEqualCanonicalizing
equalToIgnoringCase() : IsEqualIgnoringCase
equalToWithDelta() : IsEqualWithDelta
isEmpty() : IsEmpty
isWritable() : IsWritable
isReadable() : IsReadable
directoryExists() : DirectoryExists
fileExists() : FileExists
greaterThan() : GreaterThan
greaterThanOrEqual() : LogicalOr
classHasAttribute() : ClassHasAttribute
classHasStaticAttribute() : ClassHasStaticAttribute
objectHasAttribute() : ObjectHasAttribute
identicalTo() : IsIdentical
isInstanceOf() : IsInstanceOf
isType() : IsType
lessThan() : LessThan
lessThanOrEqual() : LogicalOr
matchesRegularExpression() : RegularExpression
matches() : StringMatchesFormatDescription
stringStartsWith() : StringStartsWith
stringContains() : StringContains
stringEndsWith() : StringEndsWith
countOf() : Count
objectEquals() : ObjectEquals
any() : AnyInvokedCount
  Returns a matcher that matches when the method is executed zero or more times.
never() : InvokedCount
  Returns a matcher that matches when the method is never executed.
atLeast() : InvokedAtLeastCount
  Returns a matcher that matches when the method is executed at least N times.
atLeastOnce() : InvokedAtLeastOnce
  Returns a matcher that matches when the method is executed at least once.
once() : InvokedCount
  Returns a matcher that matches when the method is executed exactly once.
exactly() : InvokedCount
  Returns a matcher that matches when the method is executed exactly $count times.
atMost() : InvokedAtMostCount
  Returns a matcher that matches when the method is executed at most N times.
at() : InvokedAtIndex
  Returns a matcher that matches when the method is executed at the given index.
returnValue() : ReturnStub
returnValueMap() : ReturnValueMap
returnArgument() : ReturnArgument
returnCallback() : ReturnCallback
returnSelf() : ReturnSelf
  Returns the current object.
throwException() : Exception
onConsecutiveCalls() : ConsecutiveCalls

### Functions

#### assertArrayHasKey()

Functions.php : 89

Asserts that an array has a specified key.

`assertArrayHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void`

##### Parameters

$key : int|string
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertArrayHasKey

##### Return values

void —

#### assertArrayNotHasKey()

Functions.php : 110

Asserts that an array does not have a specified key.

`assertArrayNotHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void`

##### Parameters

$key : int|string
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertArrayNotHasKey

##### Return values

void —

#### assertContains()

Functions.php : 128

Asserts that a haystack contains a needle.

`assertContains(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : mixed
$haystack : iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertContains

##### Return values

void —

#### assertContainsEquals()

Functions.php : 135
`assertContainsEquals(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : mixed
$haystack : iteratable<string|int, mixed>
$message : string = ''

##### Return values

void —

#### assertNotContains()

Functions.php : 153

Asserts that a haystack does not contain a needle.

`assertNotContains(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : mixed
$haystack : iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotContains

##### Return values

void —

#### assertNotContainsEquals()

Functions.php : 160
`assertNotContainsEquals(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : mixed
$haystack : iteratable<string|int, mixed>
$message : string = ''

##### Return values

void —

#### assertContainsOnly()

Functions.php : 177

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

`assertContainsOnly(string $type, iteratable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void`

##### Parameters

$type : string
$haystack : iteratable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertContainsOnly

##### Return values

void —

#### assertContainsOnlyInstancesOf()

Functions.php : 194

Asserts that a haystack contains only instances of a given class name.

`assertContainsOnlyInstancesOf(string $className, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$className : string
$haystack : iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertContainsOnlyInstancesOf

##### Return values

void —

#### assertNotContainsOnly()

Functions.php : 211

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

`assertNotContainsOnly(string $type, iteratable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void`

##### Parameters

$type : string
$haystack : iteratable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotContainsOnly

##### Return values

void —

#### assertCount()

Functions.php : 231

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

`assertCount(int $expectedCount, Countable|iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$expectedCount : int
$haystack : Countable|iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertCount

##### Return values

void —

#### assertNotCount()

Functions.php : 251

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

`assertNotCount(int $expectedCount, Countable|iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void`

##### Parameters

$expectedCount : int
$haystack : Countable|iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotCount

##### Return values

void —

#### assertEquals()

Functions.php : 268

Asserts that two variables are equal.

`assertEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEquals

##### Return values

void —

#### assertEqualsCanonicalizing()

Functions.php : 285

Asserts that two variables are equal (canonicalizing).

`assertEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEqualsCanonicalizing

##### Return values

void —

#### assertEqualsIgnoringCase()

Functions.php : 302

Asserts that two variables are equal (ignoring case).

`assertEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEqualsIgnoringCase

##### Return values

void —

#### assertEqualsWithDelta()

Functions.php : 319

Asserts that two variables are equal (with delta).

`assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$delta : float
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEqualsWithDelta

##### Return values

void —

#### assertNotEquals()

Functions.php : 336

Asserts that two variables are not equal.

`assertNotEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotEquals

##### Return values

void —

#### assertNotEqualsCanonicalizing()

Functions.php : 353

Asserts that two variables are not equal (canonicalizing).

`assertNotEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotEqualsCanonicalizing

##### Return values

void —

#### assertNotEqualsIgnoringCase()

Functions.php : 370

Asserts that two variables are not equal (ignoring case).

`assertNotEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotEqualsIgnoringCase

##### Return values

void —

#### assertNotEqualsWithDelta()

Functions.php : 387

Asserts that two variables are not equal (with delta).

`assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$delta : float
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotEqualsWithDelta

##### Return values

void —

#### assertObjectEquals()

Functions.php : 401
`assertObjectEquals(object $expected, object $actual[, string $method = 'equals' ][, string $message = '' ]) : void`

##### Parameters

$expected : object
$actual : object
$method : string = 'equals'
$message : string = ''

##### Tags

throws
  ExpectationFailedException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertObjectEquals

##### Return values

void —

#### assertEmpty()

Functions.php : 420

Asserts that a variable is empty.

`assertEmpty(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  empty $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEmpty

##### Return values

void —

#### assertNotEmpty()

Functions.php : 439

Asserts that a variable is not empty.

`assertNotEmpty(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !empty $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotEmpty

##### Return values

void —

#### assertGreaterThan()

Functions.php : 456

Asserts that a value is greater than another value.

`assertGreaterThan(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertGreaterThan

##### Return values

void —

#### assertGreaterThanOrEqual()

Functions.php : 473

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

`assertGreaterThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertGreaterThanOrEqual

##### Return values

void —

#### assertLessThan()

Functions.php : 490

Asserts that a value is smaller than another value.

`assertLessThan(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertLessThan

##### Return values

void —

#### assertLessThanOrEqual()

Functions.php : 507

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

`assertLessThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertLessThanOrEqual

##### Return values

void —

#### assertFileEquals()

Functions.php : 525

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

`assertFileEquals(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileEquals

##### Return values

void —

#### assertFileEqualsCanonicalizing()

Functions.php : 543

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

`assertFileEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileEqualsCanonicalizing

##### Return values

void —

#### assertFileEqualsIgnoringCase()

Functions.php : 561

Asserts that the contents of one file is equal to the contents of another file (ignoring case).

`assertFileEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileEqualsIgnoringCase

##### Return values

void —

#### assertFileNotEquals()

Functions.php : 579

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

`assertFileNotEquals(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotEquals

##### Return values

void —

#### assertFileNotEqualsCanonicalizing()

Functions.php : 597

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

`assertFileNotEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotEqualsCanonicalizing

##### Return values

void —

#### assertFileNotEqualsIgnoringCase()

Functions.php : 615

Asserts that the contents of one file is not equal to the contents of another file (ignoring case).

`assertFileNotEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotEqualsIgnoringCase

##### Return values

void —

#### assertStringEqualsFile()

Functions.php : 633

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

`assertStringEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringEqualsFile

##### Return values

void —

#### assertStringEqualsFileCanonicalizing()

Functions.php : 651

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

`assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringEqualsFileCanonicalizing

##### Return values

void —

#### assertStringEqualsFileIgnoringCase()

Functions.php : 669

Asserts that the contents of a string is equal to the contents of a file (ignoring case).

`assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringEqualsFileIgnoringCase

##### Return values

void —

#### assertStringNotEqualsFile()

Functions.php : 687

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

`assertStringNotEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotEqualsFile

##### Return values

void —

#### assertStringNotEqualsFileCanonicalizing()

Functions.php : 705

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

`assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotEqualsFileCanonicalizing

##### Return values

void —

#### assertStringNotEqualsFileIgnoringCase()

Functions.php : 723

Asserts that the contents of a string is not equal to the contents of a file (ignoring case).

`assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualString : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotEqualsFileIgnoringCase

##### Return values

void —

#### assertIsReadable()

Functions.php : 740

Asserts that a file/dir is readable.

`assertIsReadable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsReadable

##### Return values

void —

#### assertIsNotReadable()

Functions.php : 757

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

`assertIsNotReadable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotReadable

##### Return values

void —

#### assertNotIsReadable()

Functions.php : 778

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

`assertNotIsReadable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4062

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotIsReadable

##### Return values

void —

#### assertIsWritable()

Functions.php : 795

Asserts that a file/dir exists and is writable.

`assertIsWritable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsWritable

##### Return values

void —

#### assertIsNotWritable()

Functions.php : 812

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

`assertIsNotWritable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotWritable

##### Return values

void —

#### assertNotIsWritable()

Functions.php : 833

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

`assertNotIsWritable(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4065

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotIsWritable

##### Return values

void —

#### assertDirectoryExists()

Functions.php : 850

Asserts that a directory exists.

`assertDirectoryExists(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryExists

##### Return values

void —

#### assertDirectoryDoesNotExist()

Functions.php : 867

Asserts that a directory does not exist.

`assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryDoesNotExist

##### Return values

void —

#### assertDirectoryNotExists()

Functions.php : 888

Asserts that a directory does not exist.

`assertDirectoryNotExists(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4068

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryNotExists

##### Return values

void —

#### assertDirectoryIsReadable()

Functions.php : 905

Asserts that a directory exists and is readable.

`assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryIsReadable

##### Return values

void —

#### assertDirectoryIsNotReadable()

Functions.php : 922

Asserts that a directory exists and is not readable.

`assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryIsNotReadable

##### Return values

void —

#### assertDirectoryNotIsReadable()

Functions.php : 943

Asserts that a directory exists and is not readable.

`assertDirectoryNotIsReadable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4071

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryNotIsReadable

##### Return values

void —

#### assertDirectoryIsWritable()

Functions.php : 960

Asserts that a directory exists and is writable.

`assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryIsWritable

##### Return values

void —

#### assertDirectoryIsNotWritable()

Functions.php : 977

Asserts that a directory exists and is not writable.

`assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryIsNotWritable

##### Return values

void —

#### assertDirectoryNotIsWritable()

Functions.php : 998

Asserts that a directory exists and is not writable.

`assertDirectoryNotIsWritable(string $directory[, string $message = '' ]) : void`

##### Parameters

$directory : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4074

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDirectoryNotIsWritable

##### Return values

void —

#### assertFileExists()

Functions.php : 1015

Asserts that a file exists.

`assertFileExists(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileExists

##### Return values

void —

#### assertFileDoesNotExist()

Functions.php : 1032

Asserts that a file does not exist.

`assertFileDoesNotExist(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileDoesNotExist

##### Return values

void —

#### assertFileNotExists()

Functions.php : 1053

Asserts that a file does not exist.

`assertFileNotExists(string $filename[, string $message = '' ]) : void`

##### Parameters

$filename : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4077

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotExists

##### Return values

void —

#### assertFileIsReadable()

Functions.php : 1070

Asserts that a file exists and is readable.

`assertFileIsReadable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileIsReadable

##### Return values

void —

#### assertFileIsNotReadable()

Functions.php : 1087

Asserts that a file exists and is not readable.

`assertFileIsNotReadable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileIsNotReadable

##### Return values

void —

#### assertFileNotIsReadable()

Functions.php : 1108

Asserts that a file exists and is not readable.

`assertFileNotIsReadable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4080

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotIsReadable

##### Return values

void —

#### assertFileIsWritable()

Functions.php : 1125

Asserts that a file exists and is writable.

`assertFileIsWritable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileIsWritable

##### Return values

void —

#### assertFileIsNotWritable()

Functions.php : 1142

Asserts that a file exists and is not writable.

`assertFileIsNotWritable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileIsNotWritable

##### Return values

void —

#### assertFileNotIsWritable()

Functions.php : 1163

Asserts that a file exists and is not writable.

`assertFileNotIsWritable(string $file[, string $message = '' ]) : void`

##### Parameters

$file : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4083

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFileNotIsWritable

##### Return values

void —

#### assertTrue()

Functions.php : 1182

Asserts that a condition is true.

`assertTrue(mixed $condition[, string $message = '' ]) : void`

##### Parameters

$condition : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  true $condition

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertTrue

##### Return values

void —

#### assertNotTrue()

Functions.php : 1201

Asserts that a condition is not true.

`assertNotTrue(mixed $condition[, string $message = '' ]) : void`

##### Parameters

$condition : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !true $condition

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotTrue

##### Return values

void —

#### assertFalse()

Functions.php : 1220

Asserts that a condition is false.

`assertFalse(mixed $condition[, string $message = '' ]) : void`

##### Parameters

$condition : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  false $condition

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFalse

##### Return values

void —

#### assertNotFalse()

Functions.php : 1239

Asserts that a condition is not false.

`assertNotFalse(mixed $condition[, string $message = '' ]) : void`

##### Parameters

$condition : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !false $condition

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotFalse

##### Return values

void —

#### assertNull()

Functions.php : 1258

Asserts that a variable is null.

`assertNull(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  null $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNull

##### Return values

void —

#### assertNotNull()

Functions.php : 1277

Asserts that a variable is not null.

`assertNotNull(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !null $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotNull

##### Return values

void —

#### assertFinite()

Functions.php : 1294

Asserts that a variable is finite.

`assertFinite(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertFinite

##### Return values

void —

#### assertInfinite()

Functions.php : 1311

Asserts that a variable is infinite.

`assertInfinite(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertInfinite

##### Return values

void —

#### assertNan()

Functions.php : 1328

Asserts that a variable is nan.

`assertNan(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNan

##### Return values

void —

#### assertClassHasAttribute()

Functions.php : 1346

Asserts that a class has a specified attribute.

`assertClassHasAttribute(string $attributeName, string $className[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$className : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertClassHasAttribute

##### Return values

void —

#### assertClassNotHasAttribute()

Functions.php : 1364

Asserts that a class does not have a specified attribute.

`assertClassNotHasAttribute(string $attributeName, string $className[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$className : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertClassNotHasAttribute

##### Return values

void —

#### assertClassHasStaticAttribute()

Functions.php : 1382

Asserts that a class has a specified static attribute.

`assertClassHasStaticAttribute(string $attributeName, string $className[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$className : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertClassHasStaticAttribute

##### Return values

void —

#### assertClassNotHasStaticAttribute()

Functions.php : 1400

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

`assertClassNotHasStaticAttribute(string $attributeName, string $className[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$className : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertClassNotHasStaticAttribute

##### Return values

void —

#### assertObjectHasAttribute()

Functions.php : 1420

Asserts that an object has a specified attribute.

`assertObjectHasAttribute(string $attributeName, object $object[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$object : object
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertObjectHasAttribute

##### Return values

void —

#### assertObjectNotHasAttribute()

Functions.php : 1440

Asserts that an object does not have a specified attribute.

`assertObjectNotHasAttribute(string $attributeName, object $object[, string $message = '' ]) : void`

##### Parameters

$attributeName : string
$object : object
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertObjectNotHasAttribute

##### Return values

void —

#### assertSame()

Functions.php : 1463

Asserts that two variables have the same type and value.

`assertSame(mixed $expected, mixed $actual[, string $message = '' ]) : void`

Used on objects, it asserts that two variables reference the same object.

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-template

  ExpectedType

psalm-param

  ExpectedType $expected

psalm-assert

  =ExpectedType $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertSame

##### Return values

void —

#### assertNotSame()

Functions.php : 1482

Asserts that two variables do not have the same type and value.

`assertNotSame(mixed $expected, mixed $actual[, string $message = '' ]) : void`

Used on objects, it asserts that two variables do not reference the same object.

##### Parameters

$expected : mixed
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotSame

##### Return values

void —

#### assertInstanceOf()

Functions.php : 1504

Asserts that a variable is of a given type.

`assertInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
psalm-template

  ExpectedType of object

psalm-param

  class-string $expected

psalm-assert

  =ExpectedType $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertInstanceOf

##### Return values

void —

#### assertNotInstanceOf()

Functions.php : 1526

Asserts that a variable is not of a given type.

`assertNotInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void`

##### Parameters

$expected : string
$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
psalm-template

  ExpectedType of object

psalm-param

  class-string $expected

psalm-assert

  !ExpectedType $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotInstanceOf

##### Return values

void —

#### assertIsArray()

Functions.php : 1545

Asserts that a variable is of type array.

`assertIsArray(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  array $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsArray

##### Return values

void —

#### assertIsBool()

Functions.php : 1564

Asserts that a variable is of type bool.

`assertIsBool(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  bool $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsBool

##### Return values

void —

#### assertIsFloat()

Functions.php : 1583

Asserts that a variable is of type float.

`assertIsFloat(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  float $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsFloat

##### Return values

void —

#### assertIsInt()

Functions.php : 1602

Asserts that a variable is of type int.

`assertIsInt(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  int $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsInt

##### Return values

void —

#### assertIsNumeric()

Functions.php : 1621

Asserts that a variable is of type numeric.

`assertIsNumeric(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  numeric $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNumeric

##### Return values

void —

#### assertIsObject()

Functions.php : 1640

Asserts that a variable is of type object.

`assertIsObject(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  object $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsObject

##### Return values

void —

#### assertIsResource()

Functions.php : 1659

Asserts that a variable is of type resource.

`assertIsResource(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  resource $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsResource

##### Return values

void —

#### assertIsClosedResource()

Functions.php : 1678

Asserts that a variable is of type resource and is closed.

`assertIsClosedResource(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  resource $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsClosedResource

##### Return values

void —

#### assertIsString()

Functions.php : 1697

Asserts that a variable is of type string.

`assertIsString(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  string $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsString

##### Return values

void —

#### assertIsScalar()

Functions.php : 1716

Asserts that a variable is of type scalar.

`assertIsScalar(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  scalar $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsScalar

##### Return values

void —

#### assertIsCallable()

Functions.php : 1735

Asserts that a variable is of type callable.

`assertIsCallable(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  callable $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsCallable

##### Return values

void —

#### assertIsIterable()

Functions.php : 1754

Asserts that a variable is of type iterable.

`assertIsIterable(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  iterable $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsIterable

##### Return values

void —

#### assertIsNotArray()

Functions.php : 1773

Asserts that a variable is not of type array.

`assertIsNotArray(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !array $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotArray

##### Return values

void —

#### assertIsNotBool()

Functions.php : 1792

Asserts that a variable is not of type bool.

`assertIsNotBool(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !bool $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotBool

##### Return values

void —

#### assertIsNotFloat()

Functions.php : 1811

Asserts that a variable is not of type float.

`assertIsNotFloat(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !float $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotFloat

##### Return values

void —

#### assertIsNotInt()

Functions.php : 1830

Asserts that a variable is not of type int.

`assertIsNotInt(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !int $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotInt

##### Return values

void —

#### assertIsNotNumeric()

Functions.php : 1849

Asserts that a variable is not of type numeric.

`assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !numeric $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotNumeric

##### Return values

void —

#### assertIsNotObject()

Functions.php : 1868

Asserts that a variable is not of type object.

`assertIsNotObject(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !object $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotObject

##### Return values

void —

#### assertIsNotResource()

Functions.php : 1887

Asserts that a variable is not of type resource.

`assertIsNotResource(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !resource $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotResource

##### Return values

void —

#### assertIsNotClosedResource()

Functions.php : 1906

Asserts that a variable is not of type resource.

`assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !resource $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotClosedResource

##### Return values

void —

#### assertIsNotString()

Functions.php : 1925

Asserts that a variable is not of type string.

`assertIsNotString(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !string $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotString

##### Return values

void —

#### assertIsNotScalar()

Functions.php : 1944

Asserts that a variable is not of type scalar.

`assertIsNotScalar(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !scalar $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotScalar

##### Return values

void —

#### assertIsNotCallable()

Functions.php : 1963

Asserts that a variable is not of type callable.

`assertIsNotCallable(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !callable $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotCallable

##### Return values

void —

#### assertIsNotIterable()

Functions.php : 1982

Asserts that a variable is not of type iterable.

`assertIsNotIterable(mixed $actual[, string $message = '' ]) : void`

##### Parameters

$actual : mixed
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
psalm-assert

  !iterable $actual

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertIsNotIterable

##### Return values

void —

#### assertMatchesRegularExpression()

Functions.php : 1999

Asserts that a string matches a given regular expression.

`assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void`

##### Parameters

$pattern : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertMatchesRegularExpression

##### Return values

void —

#### assertRegExp()

Functions.php : 2020

Asserts that a string matches a given regular expression.

`assertRegExp(string $pattern, string $string[, string $message = '' ]) : void`

##### Parameters

$pattern : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4086

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertRegExp

##### Return values

void —

#### assertDoesNotMatchRegularExpression()

Functions.php : 2037

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

`assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void`

##### Parameters

$pattern : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertDoesNotMatchRegularExpression

##### Return values

void —

#### assertNotRegExp()

Functions.php : 2058

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

`assertNotRegExp(string $pattern, string $string[, string $message = '' ]) : void`

##### Parameters

$pattern : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4089

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotRegExp

##### Return values

void —

#### assertSameSize()

Functions.php : 2080

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

`assertSameSize(Countable|iteratable<string|int, mixed> $expected, Countable|iteratable<string|int, mixed> $actual[, string $message = '' ]) : void`

##### Parameters

$expected : Countable|iteratable<string|int, mixed>
$actual : Countable|iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertSameSize

##### Return values

void —

#### assertNotSameSize()

Functions.php : 2102

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

`assertNotSameSize(Countable|iteratable<string|int, mixed> $expected, Countable|iteratable<string|int, mixed> $actual[, string $message = '' ]) : void`

##### Parameters

$expected : Countable|iteratable<string|int, mixed>
$actual : Countable|iteratable<string|int, mixed>
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertNotSameSize

##### Return values

void —

#### assertStringMatchesFormat()

Functions.php : 2119

Asserts that a string matches a given format string.

`assertStringMatchesFormat(string $format, string $string[, string $message = '' ]) : void`

##### Parameters

$format : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringMatchesFormat

##### Return values

void —

#### assertStringNotMatchesFormat()

Functions.php : 2136

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

`assertStringNotMatchesFormat(string $format, string $string[, string $message = '' ]) : void`

##### Parameters

$format : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotMatchesFormat

##### Return values

void —

#### assertStringMatchesFormatFile()

Functions.php : 2153

Asserts that a string matches a given format file.

`assertStringMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void`

##### Parameters

$formatFile : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringMatchesFormatFile

##### Return values

void —

#### assertStringNotMatchesFormatFile()

Functions.php : 2170

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

`assertStringNotMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void`

##### Parameters

$formatFile : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotMatchesFormatFile

##### Return values

void —

#### assertStringStartsWith()

Functions.php : 2187

Asserts that a string starts with a given prefix.

`assertStringStartsWith(string $prefix, string $string[, string $message = '' ]) : void`

##### Parameters

$prefix : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringStartsWith

##### Return values

void —

#### assertStringStartsNotWith()

Functions.php : 2207

Asserts that a string starts not with a given prefix.

`assertStringStartsNotWith(string $prefix, string $string[, string $message = '' ]) : void`

##### Parameters

$prefix : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringStartsNotWith

##### Return values

void —

#### assertStringContainsString()

Functions.php : 2222
`assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : string
$haystack : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringContainsString

##### Return values

void —

#### assertStringContainsStringIgnoringCase()

Functions.php : 2237
`assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : string
$haystack : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringContainsStringIgnoringCase

##### Return values

void —

#### assertStringNotContainsString()

Functions.php : 2252
`assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : string
$haystack : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotContainsString

##### Return values

void —

#### assertStringNotContainsStringIgnoringCase()

Functions.php : 2267
`assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void`

##### Parameters

$needle : string
$haystack : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringNotContainsStringIgnoringCase

##### Return values

void —

#### assertStringEndsWith()

Functions.php : 2284

Asserts that a string ends with a given suffix.

`assertStringEndsWith(string $suffix, string $string[, string $message = '' ]) : void`

##### Parameters

$suffix : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringEndsWith

##### Return values

void —

#### assertStringEndsNotWith()

Functions.php : 2301

Asserts that a string ends not with a given suffix.

`assertStringEndsNotWith(string $suffix, string $string[, string $message = '' ]) : void`

##### Parameters

$suffix : string
$string : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertStringEndsNotWith

##### Return values

void —

#### assertXmlFileEqualsXmlFile()

Functions.php : 2319

Asserts that two XML files are equal.

`assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualFile : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlFileEqualsXmlFile

##### Return values

void —

#### assertXmlFileNotEqualsXmlFile()

Functions.php : 2337

Asserts that two XML files are not equal.

`assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualFile : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlFileNotEqualsXmlFile

##### Return values

void —

#### assertXmlStringEqualsXmlFile()

Functions.php : 2357

Asserts that two XML documents are equal.

`assertXmlStringEqualsXmlFile(string $expectedFile, DOMDocument|string $actualXml[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualXml : DOMDocument|string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlStringEqualsXmlFile

##### Return values

void —

#### assertXmlStringNotEqualsXmlFile()

Functions.php : 2377

Asserts that two XML documents are not equal.

`assertXmlStringNotEqualsXmlFile(string $expectedFile, DOMDocument|string $actualXml[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualXml : DOMDocument|string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlStringNotEqualsXmlFile

##### Return values

void —

#### assertXmlStringEqualsXmlString()

Functions.php : 2398

Asserts that two XML documents are equal.

`assertXmlStringEqualsXmlString(DOMDocument|string $expectedXml, DOMDocument|string $actualXml[, string $message = '' ]) : void`

##### Parameters

$expectedXml : DOMDocument|string
$actualXml : DOMDocument|string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlStringEqualsXmlString

##### Return values

void —

#### assertXmlStringNotEqualsXmlString()

Functions.php : 2419

Asserts that two XML documents are not equal.

`assertXmlStringNotEqualsXmlString(DOMDocument|string $expectedXml, DOMDocument|string $actualXml[, string $message = '' ]) : void`

##### Parameters

$expectedXml : DOMDocument|string
$actualXml : DOMDocument|string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
throws
  Exception
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertXmlStringNotEqualsXmlString

##### Return values

void —

#### assertEqualXMLStructure()

Functions.php : 2441

Asserts that a hierarchy of DOMElements matches.

`assertEqualXMLStructure(DOMElement $expectedElement, DOMElement $actualElement[, bool $checkAttributes = false ][, string $message = '' ]) : void`

##### Parameters

$expectedElement : DOMElement
$actualElement : DOMElement
$checkAttributes : bool = false
$message : string = ''

##### Tags

throws
  AssertionFailedError
throws
  ExpectationFailedException
throws
  InvalidArgumentException
codeCoverageIgnore
deprecated

  https://github.com/sebastianbergmann/phpunit/issues/4091

no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertEqualXMLStructure

##### Return values

void —

#### assertThat()

Functions.php : 2458

Evaluates a PHPUnit\Framework\Constraint matcher object.

`assertThat(mixed $value, Constraint $constraint[, string $message = '' ]) : void`

##### Parameters

$value : mixed
$constraint : Constraint
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertThat

##### Return values

void —

#### assertJson()

Functions.php : 2475

Asserts that a string is a valid JSON string.

`assertJson(string $actualJson[, string $message = '' ]) : void`

##### Parameters

$actualJson : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJson

##### Return values

void —

#### assertJsonStringEqualsJsonString()

Functions.php : 2492

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

`assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void`

##### Parameters

$expectedJson : string
$actualJson : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonStringEqualsJsonString

##### Return values

void —

#### assertJsonStringNotEqualsJsonString()

Functions.php : 2512

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

`assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void`

##### Parameters

$expectedJson : string
$actualJson : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonStringNotEqualsJsonString

##### Return values

void —

#### assertJsonStringEqualsJsonFile()

Functions.php : 2529

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

`assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualJson : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonStringEqualsJsonFile

##### Return values

void —

#### assertJsonStringNotEqualsJsonFile()

Functions.php : 2546

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

`assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualJson : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonStringNotEqualsJsonFile

##### Return values

void —

#### assertJsonFileEqualsJsonFile()

Functions.php : 2563

Asserts that two JSON files are equal.

`assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualFile : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonFileEqualsJsonFile

##### Return values

void —

#### assertJsonFileNotEqualsJsonFile()

Functions.php : 2580

Asserts that two JSON files are not equal.

`assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void`

##### Parameters

$expectedFile : string
$actualFile : string
$message : string = ''

##### Tags

throws
  ExpectationFailedException
throws
  InvalidArgumentException
no-named-arguments

  Parameter names are not covered by the backward compatibility promise for PHPUnit

see
  Assert::assertJsonFileNotEqualsJsonFile

##### Return values

void —

#### logicalAnd()

Functions.php : 2587
`logicalAnd() : LogicalAnd`

##### Return values

LogicalAnd —

#### logicalOr()

Functions.php : 2594
`logicalOr() : LogicalOr`

##### Return values

LogicalOr —

#### logicalNot()

Functions.php : 2601
`logicalNot(Constraint $constraint) : LogicalNot`

##### Parameters

$constraint : Constraint

##### Return values

LogicalNot —

#### logicalXor()

Functions.php : 2608
`logicalXor() : LogicalXor`

##### Return values

LogicalXor —

#### anything()

Functions.php : 2615
`anything() : IsAnything`

##### Return values

IsAnything —

#### isTrue()

Functions.php : 2622
`isTrue() : IsTrue`

##### Return values

IsTrue —

#### callback()

Functions.php : 2629
`callback(callable $callback) : Callback`

##### Parameters

$callback : callable

##### Return values

Callback —

#### isFalse()

Functions.php : 2636
`isFalse() : IsFalse`

##### Return values

IsFalse —

#### isJson()

Functions.php : 2643
`isJson() : IsJson`

##### Return values

IsJson —

#### isNull()

Functions.php : 2650
`isNull() : IsNull`

##### Return values

IsNull —

#### isFinite()

Functions.php : 2657
`isFinite() : IsFinite`

##### Return values

IsFinite —

#### isInfinite()

Functions.php : 2664
`isInfinite() : IsInfinite`

##### Return values

IsInfinite —

#### isNan()

Functions.php : 2671
`isNan() : IsNan`

##### Return values

IsNan —

#### containsEqual()

Functions.php : 2678
`containsEqual(mixed $value) : TraversableContainsEqual`

##### Parameters

$value : mixed

##### Return values

TraversableContainsEqual —

#### containsIdentical()

Functions.php : 2685
`containsIdentical(mixed $value) : TraversableContainsIdentical`

##### Parameters

$value : mixed

##### Return values

TraversableContainsIdentical —

#### containsOnly()

Functions.php : 2692
`containsOnly(string $type) : TraversableContainsOnly`

##### Parameters

$type : string

##### Return values

TraversableContainsOnly —

#### containsOnlyInstancesOf()

Functions.php : 2699
`containsOnlyInstancesOf(string $className) : TraversableContainsOnly`

##### Parameters

$className : string

##### Return values

TraversableContainsOnly —

#### arrayHasKey()

Functions.php : 2706
`arrayHasKey(mixed $key) : ArrayHasKey`

##### Parameters

$key : mixed

##### Return values

ArrayHasKey —

#### equalTo()

Functions.php : 2713
`equalTo(mixed $value) : IsEqual`

##### Parameters

$value : mixed

##### Return values

IsEqual —

#### equalToCanonicalizing()

Functions.php : 2720
`equalToCanonicalizing(mixed $value) : IsEqualCanonicalizing`

##### Parameters

$value : mixed

##### Return values

IsEqualCanonicalizing —

#### equalToIgnoringCase()

Functions.php : 2727
`equalToIgnoringCase(mixed $value) : IsEqualIgnoringCase`

##### Parameters

$value : mixed

##### Return values

IsEqualIgnoringCase —

#### equalToWithDelta()

Functions.php : 2734
`equalToWithDelta(mixed $value, float $delta) : IsEqualWithDelta`

##### Parameters

$value : mixed
$delta : float

##### Return values

IsEqualWithDelta —

#### isEmpty()

Functions.php : 2741
`isEmpty() : IsEmpty`

##### Return values

IsEmpty —

#### isWritable()

Functions.php : 2748
`isWritable() : IsWritable`

##### Return values

IsWritable —

#### isReadable()

Functions.php : 2755
`isReadable() : IsReadable`

##### Return values

IsReadable —

#### directoryExists()

Functions.php : 2762
`directoryExists() : DirectoryExists`

##### Return values

DirectoryExists —

#### fileExists()

Functions.php : 2769
`fileExists() : FileExists`

##### Return values

FileExists —

#### greaterThan()

Functions.php : 2776
`greaterThan(mixed $value) : GreaterThan`

##### Parameters

$value : mixed

##### Return values

GreaterThan —

#### greaterThanOrEqual()

Functions.php : 2783
`greaterThanOrEqual(mixed $value) : LogicalOr`

##### Parameters

$value : mixed

##### Return values

LogicalOr —

#### classHasAttribute()

Functions.php : 2790
`classHasAttribute(string $attributeName) : ClassHasAttribute`

##### Parameters

$attributeName : string

##### Return values

ClassHasAttribute —

#### classHasStaticAttribute()

Functions.php : 2797
`classHasStaticAttribute(string $attributeName) : ClassHasStaticAttribute`

##### Parameters

$attributeName : string

##### Return values

ClassHasStaticAttribute —

#### objectHasAttribute()

Functions.php : 2804
`objectHasAttribute(mixed $attributeName) : ObjectHasAttribute`

##### Parameters

$attributeName : mixed

##### Return values

ObjectHasAttribute —

#### identicalTo()

Functions.php : 2811
`identicalTo(mixed $value) : IsIdentical`

##### Parameters

$value : mixed

##### Return values

IsIdentical —

#### isInstanceOf()

Functions.php : 2818
`isInstanceOf(string $className) : IsInstanceOf`

##### Parameters

$className : string

##### Return values

IsInstanceOf —

#### isType()

Functions.php : 2825
`isType(string $type) : IsType`

##### Parameters

$type : string

##### Return values

IsType —

#### lessThan()

Functions.php : 2832
`lessThan(mixed $value) : LessThan`

##### Parameters

$value : mixed

##### Return values

LessThan —

#### lessThanOrEqual()

Functions.php : 2839
`lessThanOrEqual(mixed $value) : LogicalOr`

##### Parameters

$value : mixed

##### Return values

LogicalOr —

#### matchesRegularExpression()

Functions.php : 2846
`matchesRegularExpression(string $pattern) : RegularExpression`

##### Parameters

$pattern : string

##### Return values

RegularExpression —

#### matches()

Functions.php : 2853
`matches(string $string) : StringMatchesFormatDescription`

##### Parameters

$string : string

##### Return values

StringMatchesFormatDescription —

#### stringStartsWith()

Functions.php : 2860
`stringStartsWith(mixed $prefix) : StringStartsWith`

##### Parameters

$prefix : mixed

##### Return values

StringStartsWith —

#### stringContains()

Functions.php : 2867
`stringContains(string $string[, bool $case = true ]) : StringContains`

##### Parameters

$string : string
$case : bool = true

##### Return values

StringContains —

#### stringEndsWith()

Functions.php : 2874
`stringEndsWith(string $suffix) : StringEndsWith`

##### Parameters

$suffix : string

##### Return values

StringEndsWith —

#### countOf()

Functions.php : 2881
`countOf(int $count) : Count`

##### Parameters

$count : int

##### Return values

Count —

#### objectEquals()

Functions.php : 2888
`objectEquals(object $object[, string $method = 'equals' ]) : ObjectEquals`

##### Parameters

$object : object
$method : string = 'equals'

##### Return values

ObjectEquals —

#### any()

Functions.php : 2899

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

`any() : AnyInvokedCount`

##### Return values

AnyInvokedCount —

#### never()

Functions.php : 2909

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

`never() : InvokedCount`

##### Return values

InvokedCount —

#### atLeast()

Functions.php : 2920

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

`atLeast(int $requiredInvocations) : InvokedAtLeastCount`

##### Parameters

$requiredInvocations : int

##### Return values

InvokedAtLeastCount —

#### atLeastOnce()

Functions.php : 2932

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

`atLeastOnce() : InvokedAtLeastOnce`

##### Return values

InvokedAtLeastOnce —

#### once()

Functions.php : 2942

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

`once() : InvokedCount`

##### Return values

InvokedCount —

#### exactly()

Functions.php : 2953

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

`exactly(int $count) : InvokedCount`

##### Parameters

$count : int

##### Return values

InvokedCount —

#### atMost()

Functions.php : 2964

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

`atMost(int $allowedInvocations) : InvokedAtMostCount`

##### Parameters

$allowedInvocations : int

##### Return values

InvokedAtMostCount —

#### at()

Functions.php : 2975

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

`at(int $index) : InvokedAtIndex`

##### Parameters

$index : int

##### Return values

InvokedAtIndex —

#### returnValue()

Functions.php : 2982
`returnValue(mixed $value) : ReturnStub`

##### Parameters

$value : mixed

##### Return values

ReturnStub —

#### returnValueMap()

Functions.php : 2989
`returnValueMap(array<string|int, mixed> $valueMap) : ReturnValueMap`

##### Parameters

$valueMap : array<string|int, mixed>

##### Return values

ReturnValueMap —

#### returnArgument()

Functions.php : 2996
`returnArgument(int $argumentIndex) : ReturnArgument`

##### Parameters

$argumentIndex : int

##### Return values

ReturnArgument —

#### returnCallback()

Functions.php : 3003
`returnCallback(mixed $callback) : ReturnCallback`

##### Parameters

$callback : mixed

##### Return values

ReturnCallback —

#### returnSelf()

Functions.php : 3015

Returns the current object.

`returnSelf() : ReturnSelf`

This method is useful when mocking a fluent interface.

##### Return values

ReturnSelf —

#### throwException()

Functions.php : 3022
`throwException(Throwable $exception) : Exception`

##### Parameters

$exception : Throwable

##### Return values

Exception —

#### onConsecutiveCalls()

Functions.php : 3029
`onConsecutiveCalls() : ConsecutiveCalls`

##### Return values

ConsecutiveCalls —

## Search results