Asserts¶
The list of asserts available are a sub-set of the PHPUnit Assert available.
Some of the methods have been remove since they are replicable trough a combination of path and another assert. Other are not available either for compatibility issues. If you think that some must be added just open a issue in the git repository.
For a more exhaustive documentation please refer to PHPUnit Documentation. Do not forgot that all the asserts are not available and that the $this->getData() replace the data you want to test that is normally pass trough the PHPUnit Assert methods.
assertArraySubset¶
p
/**
* Asserts that an array has a specified subset.
*
* @param array|ArrayAccess $subset
* @param bool $strict Check for object identity
* @param string $message
* @return $this
*/
public function assertArraySubset($subset, $strict = false, $message = '')
{
Assert::assertArraySubset($subset, $this->getData(), $strict, $message);
return $this;
}
assertContains¶
p
/**
* Asserts that a haystack contains a needle.
*
* @param mixed $needle
* @param string $message
* @param bool $ignoreCase
* @param bool $checkForObjectIdentity
* @param bool $checkForNonObjectIdentity
* @return $this
*/
public function assertContains($needle, $message = '', $ignoreCase = false, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false)
{
Assert::assertContains($needle, $this->getData(), $message, $ignoreCase, $checkForObjectIdentity, $checkForNonObjectIdentity);
return $this;
}
assertNotContains¶
p
/**
* Asserts that a haystack does not contain a needle.
*
* @param mixed $needle
* @param string $message
* @param bool $ignoreCase
* @param bool $checkForObjectIdentity
* @param bool $checkForNonObjectIdentity
* @return $this
*/
public function assertNotContains($needle, $message = '', $ignoreCase = false, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false)
{
Assert::assertNotContains($needle, $this->getData(), $message, $ignoreCase, $checkForObjectIdentity, $checkForNonObjectIdentity);
return $this;
}
assertContainsOnly¶
p
/**
* Asserts that a haystack contains only values of a given type.
*
* @param string $type
* @param bool $isNativeType
* @param string $message
* @return $this
*/
public function assertContainsOnly($type, $isNativeType = NULL, $message = '')
{
Assert::assertContainsOnly($type, $this->getData(), $isNativeType, $message);
return $this;
}
assertContainsOnlyInstancesOf¶
p
/**
* Asserts that a haystack contains only instances of a given classname
*
* @param string $classname
* @param string $message
* @return $this
*/
public function assertContainsOnlyInstancesOf($classname, $message = '')
{
Assert::assertContainsOnlyInstancesOf($classname, $this->getData(), $message);
return $this;
}
assertNotContainsOnly¶
p
/**
* Asserts that a haystack does not contain only values of a given type.
*
* @param string $type
* @param bool $isNativeType
* @param string $message
* @return $this
*/
public function assertNotContainsOnly($type, $isNativeType = NULL, $message = '')
{
Assert::assertNotContainsOnly($type, $this->getData(), $isNativeType, $message);
return $this;
}
assertCount¶
p
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param int $expectedCount
* @param string $message
* @return $this
*/
public function assertCount($expectedCount, $message = '')
{
Assert::assertCount($expectedCount, $this->getData(), $message);
return $this;
}
assertNotCount¶
p
/**
* Asserts the number of elements of an array, Countable or Traversable.
*
* @param int $expectedCount
* @param string $message
* @return $this
*/
public function assertNotCount($expectedCount, $message = '')
{
Assert::assertNotCount($expectedCount, $this->getData(), $message);
return $this;
}
assertEquals¶
p
/**
* Asserts that two variables are equal.
*
* @param mixed $expected
* @param string $message
* @param float $delta
* @param int $maxDepth
* @param bool $canonicalize
* @param bool $ignoreCase
* @return $this
*/
public function assertEquals($expected, $message = '', $delta = 0.0, $maxDepth = 10, $canonicalize = false, $ignoreCase = false)
{
Assert::assertEquals($expected, $this->getData(), $message, $delta, $maxDepth, $canonicalize, $ignoreCase);
return $this;
}
assertNotEquals¶
p
/**
* Asserts that two variables are not equal.
*
* @param mixed $expected
* @param string $message
* @param float $delta
* @param int $maxDepth
* @param bool $canonicalize
* @param bool $ignoreCase
* @return $this
*/
public function assertNotEquals($expected, $message = '', $delta = 0.0, $maxDepth = 10, $canonicalize = false, $ignoreCase = false)
{
Assert::assertNotEquals($expected, $this->getData(), $message, $delta, $maxDepth, $canonicalize, $ignoreCase);
return $this;
}
assertEmpty¶
p
/**
* Asserts that a variable is empty.
*
* @param string $message
*
* @return $this
*/
public function assertEmpty($message = '')
{
Assert::assertEmpty($this->getData(), $message);
return $this;
}
assertNotEmpty¶
p
/**
* Asserts that a variable is not empty.
*
* @param string $message
*
* @return $this
*/
public function assertNotEmpty($message = '')
{
Assert::assertNotEmpty($this->getData(), $message);
return $this;
}
assertGreaterThan¶
p
/**
* Asserts that a value is greater than another value.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertGreaterThan($expected, $message = '')
{
Assert::assertGreaterThan($expected, $this->getData(), $message);
return $this;
}
assertGreaterThanOrEqual¶
p
/**
* Asserts that a value is greater than or equal to another value.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertGreaterThanOrEqual($expected, $message = '')
{
Assert::assertGreaterThanOrEqual($expected, $this->getData(), $message);
return $this;
}
assertLessThan¶
p
/**
* Asserts that a value is smaller than another value.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertLessThan($expected, $message = '')
{
Assert::assertLessThan($expected, $this->getData(), $message);
return $this;
}
assertLessThanOrEqual¶
p
/**
* Asserts that a value is smaller than or equal to another value.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertLessThanOrEqual($expected, $message = '')
{
Assert::assertLessThanOrEqual($expected, $this->getData(), $message);
return $this;
}
assertTrue¶
p
/**
* Asserts that a condition is true.
*
* @param string $message
*
* @return $this
*/
public function assertTrue($message = '')
{
Assert::assertTrue($this->getData(), $message);
return $this;
}
assertNotTrue¶
p
/**
* Asserts that a condition is not true.
*
* @param string $message
*
* @return $this
*/
public function assertNotTrue($message = '')
{
Assert::assertNotTrue($this->getData(), $message);
return $this;
}
assertFalse¶
p
/**
* Asserts that a condition is false.
*
* @param string $message
*
* @return $this
*/
public function assertFalse($message = '')
{
Assert::assertFalse($this->getData(), $message);
return $this;
}
assertNotFalse¶
p
/**
* Asserts that a condition is not false.
*
* @param string $message
*
* @return $this
*/
public function assertNotFalse($message = '')
{
Assert::assertNotFalse($this->getData(), $message);
return $this;
}
assertNull¶
p
/**
* Asserts that a variable is null.
*
* @param string $message
* @return $this
*/
public function assertNull($message = '')
{
Assert::assertNull($this->getData(), $message);
return $this;
}
assertNotNull¶
p
/**
* Asserts that a variable is not null.
*
* @param string $message
* @return $this
*/
public function assertNotNull($message = '')
{
Assert::assertNotNull($this->getData(), $message);
return $this;
}
assertFinite¶
p
/**
* Asserts that a variable is finite.
*
* @param string $message
* @return $this
*/
public function assertFinite($message = '')
{
Assert::assertFinite($this->getData(), $message);
return $this;
}
assertInfinite¶
p
/**
* Asserts that a variable is infinite.
*
* @param string $message
* @return $this
*/
public function assertInfinite($message = '')
{
Assert::assertInfinite($this->getData(), $message);
return $this;
}
assertNan¶
p
/**
* Asserts that a variable is nan.
*
* @param string $message
* @return $this
*/
public function assertNan($message = '')
{
Assert::assertNan($this->getData(), $message);
return $this;
}
assertSame¶
p
/**
* Asserts that two variables have the same type and value.
* Used on objects, it asserts that two variables reference
* the same object.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertSame($expected, $message = '')
{
Assert::assertSame($expected, $this->getData(), $message);
return $this;
}
assertNotSame¶
p
/**
* Asserts that two variables do not have the same type and value.
* Used on objects, it asserts that two variables do not reference
* the same object.
*
* @param mixed $expected
* @param string $message
* @return $this
*/
public function assertNotSame($expected, $message = '')
{
Assert::assertNotSame($expected, $this->getData(), $message);
return $this;
}
assertInstanceOf¶
p
/**
* Asserts that a variable is of a given type.
*
* @param string $expected
* @param string $message
* @return $this
*/
public function assertInstanceOf($expected, $message = '')
{
Assert::assertInstanceOf($expected, $this->getData(), $message);
return $this;
}
assertNotInstanceOf¶
p
/**
* Asserts that a variable is not of a given type.
*
* @param string $expected
* @param string $message
* @return $this
*/
public function assertNotInstanceOf($expected, $message = '')
{
Assert::assertNotInstanceOf($expected, $this->getData(), $message);
return $this;
}
assertInternalType¶
p
/**
* Asserts that a variable is of a given type.
*
* @param string $expected
* @param string $message
* @return $this
*/
public function assertInternalType($expected, $message = '')
{
Assert::assertInternalType($expected, $this->getData(), $message);
return $this;
}
assertNotInternalType¶
p
/**
* Asserts that a variable is not of a given type.
*
* @param string $expected
* @param string $message
* @return $this
*/
public function assertNotInternalType($expected, $message = '')
{
Assert::assertNotInternalType($expected, $this->getData(), $message);
return $this;
}
assertRegExp¶
p
/**
* Asserts that a string matches a given regular expression.
*
* @param string $pattern
* @param string $message
* @return $this
*/
public function assertRegExp($pattern, $message = '')
{
Assert::assertRegExp($pattern, $this->getData(), $message);
return $this;
}
assertNotRegExp¶
p
/**
* Asserts that a string does not match a given regular expression.
*
* @param string $pattern
* @param string $message
* @return $this
*/
public function assertNotRegExp($pattern, $message = '')
{
Assert::assertNotRegExp($pattern, $this->getData(), $message);
return $this;
}
assertSameSize¶
p
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is the same.
*
* @param array|Countable|Traversable $expected
* @param string $message
* @return $this
*/
public function assertSameSize($expected, $message = '')
{
Assert::assertSameSize($expected, $this->getData(), $message);
return $this;
}
assertNotSameSize¶
p
/**
* Assert that the size of two arrays (or `Countable` or `Traversable` objects)
* is not the same.
*
* @param array|Countable|Traversable $expected
* @param string $message
* @return $this
*/
public function assertNotSameSize($expected, $message = '')
{
Assert::assertNotSameSize($expected, $this->getData(), $message);
return $this;
}
assertStringMatchesFormat¶
p
/**
* Asserts that a string matches a given format string.
*
* @param string $format
* @param string $message
* @return $this
*/
public function assertStringMatchesFormat($format, $message = '')
{
Assert::assertStringMatchesFormat($format, $this->getData(), $message);
return $this;
}
assertStringNotMatchesFormat¶
p
/**
* Asserts that a string does not match a given format string.
*
* @param string $format
* @param string $message
* @return $this
*/
public function assertStringNotMatchesFormat($format, $message = '')
{
Assert::assertStringNotMatchesFormat($format, $this->getData(), $message);
return $this;
}
assertStringStartsNotWith¶
p
/**
* Asserts that a string starts not with a given prefix.
*
* @param string $prefix
* @param string $message
* @return $this
*/
public function assertStringStartsNotWith($prefix, $message = '')
{
Assert::assertStringStartsNotWith($prefix, $this->getData(), $message);
return $this;
}
assertStringEndsWith¶
p
/**
* Asserts that a string ends with a given suffix.
*
* @param string $suffix
* @param string $message
* @return $this
*/
public function assertStringEndsWith($suffix, $message = '')
{
Assert::assertStringEndsWith($suffix, $this->getData(), $message);
return $this;
}
assertStringEndsNotWith¶
p
/**
* Asserts that a string ends not with a given suffix.
*
* @param string $suffix
* @param string $message
* @return $this
*/
public function assertStringEndsNotWith($suffix, $message = '')
{
Assert::assertStringEndsNotWith($suffix, $this->getData(), $message);
return $this;
}
assertJson¶
p
/**
* Asserts that a string is a valid JSON string.
*
* @param string $message
* @return $this
*/
public function assertJson($message = '')
{
Assert::assertJson($this->getData(), $message);
return $this;
}
assertJsonStringEqualsJsonString¶
p
/**
* Asserts that two given JSON encoded objects or arrays are equal.
*
* @param string $expectedJson
* @param string $message
* @return $this
*/
public function assertJsonStringEqualsJsonString($expectedJson, $message = '')
{
Assert::assertJsonStringEqualsJsonString($expectedJson, $this->getData(), $message);
return $this;
}
assertJsonStringNotEqualsJsonString¶
p
/**
* Asserts that two given JSON encoded objects or arrays are not equal.
*
* @param string $expectedJson
* @param string $message
* @return $this
*/
public function assertJsonStringNotEqualsJsonString($expectedJson, $message = '')
{
Assert::assertJsonStringNotEqualsJsonString($expectedJson, $this->getData(), $message);
return $this;
}