Index
A
- Assert — Class in namespace Tester
Assertion test helpers.
- AssertException — Class in namespace Tester
Assertion exception.
- $ AssertException#actual — Property in class AssertException
- AbstractGenerator — Class in namespace Tester\CodeCoverage\Generators
Code coverage report generator.
- $ AbstractGenerator#acceptFiles — Property in class AbstractGenerator
- Expect::and() — Method in class Expect
- Expect::andSame() — Method in class Expect
- Expect::andNotSame() — Method in class Expect
- Expect::andEqual() — Method in class Expect
- Expect::andNotEqual() — Method in class Expect
- Expect::andContains() — Method in class Expect
- Expect::andNotContains() — Method in class Expect
- Expect::andTrue() — Method in class Expect
- Expect::andFalse() — Method in class Expect
- Expect::andNull() — Method in class Expect
- Expect::andNan() — Method in class Expect
- Expect::andTruthy() — Method in class Expect
- Expect::andFalsey() — Method in class Expect
- Expect::andCount() — Method in class Expect
- Expect::andType() — Method in class Expect
- Expect::andMatch() — Method in class Expect
- Expect::andMatchFile() — Method in class Expect
- FileMutator::addMutator() — Method in class FileMutator
- Runner::addPhpIniOption() — Method in class Runner
- Runner::addJob() — Method in class Runner
Appends new job to queue.
- TestHandler::assess() — Method in class TestHandler
B
- Environment::bypassFinals() — Method in class Environment
Removes keyword final from source codes.
- OutputHandler::begin() — Method in class OutputHandler
- ConsolePrinter::begin() — Method in class ConsolePrinter
- JUnitPrinter::begin() — Method in class JUnitPrinter
- Logger::begin() — Method in class Logger
- TapPrinter::begin() — Method in class TapPrinter
C
- $ Assert#counter — Property in class Assert
- Assert::contains() — Method in class Assert
Asserts that a haystack (string or array) contains an expected needle.
- Assert::count() — Method in class Assert
Asserts the number of items in an array or Countable.
- Collector — Class in namespace Tester\CodeCoverage
Code coverage collector.
- $ AbstractGenerator#coveredSum — Property in class AbstractGenerator
- CloverXMLGenerator — Class in namespace Tester\CodeCoverage\Generators
- DomQuery::css2xpath() — Method in class DomQuery
Transforms CSS expression to XPath.
- Dumper::color() — Method in class Dumper
Applies color to string.
- $ Environment#checkAssertions — Property in class Environment
- Expect::contains() — Method in class Expect
- Expect::count() — Method in class Expect
- $ FileMock#context — Property in class FileMock
- FileMock::create() — Method in class FileMock
- $ FileMutator#context — Property in class FileMutator
- CliTester — Class in namespace Tester\Runner
CLI Tester.
- CommandLine — Class in namespace Tester\Runner
Stupid command line arguments parser.
- CommandLine::checkArg() — Method in class CommandLine
- ConsolePrinter — Class in namespace Tester\Runner\Output
Console printer.
D
- Collector::detectEngines() — Method in class Collector
- $ AbstractGenerator#data — Property in class AbstractGenerator
- DataProvider — Class in namespace Tester
Data provider helpers.
- DomQuery — Class in namespace Tester
DomQuery simplifies querying (X)HTML documents.
- Dumper — Class in namespace Tester
Dumps PHP variables.
- $ Dumper#dumpDir — Property in class Dumper
- Dumper::dumpException() — Method in class Dumper
- Expect::dump() — Method in class Expect
- FileMutator::dir_closedir() — Method in class FileMutator
- FileMutator::dir_opendir() — Method in class FileMutator
- FileMutator::dir_readdir() — Method in class FileMutator
- FileMutator::dir_rewinddir() — Method in class FileMutator
E
- $ Assert#expandPatterns — Property in class Assert
- Assert::equal() — Method in class Assert
Asserts that two values are equal and checks expectations. The identity of objects, the order of keys in the arrays and marginally different floats are ignored.
- Assert::exception() — Method in class Assert
Asserts that a function throws exception of given type and its message matches given pattern.
- Assert::error() — Method in class Assert
Asserts that a function generates one or more PHP errors or throws exceptions.
- Assert::expandMatchingPatterns() — Method in class Assert
- $ AssertException#expected — Property in class AssertException
- Environment — Class in namespace Tester
Testing environment.
- Environment::exit() — Method in class Environment
- Expect — Class in namespace Tester
Expectations for more complex assertions formulation.
- Expect::equal() — Method in class Expect
- Helpers::errorTypeToString() — Method in class Helpers
- Helpers::escapeArg() — Method in class Helpers
Escape a string to be used as a shell argument.
- OutputHandler::end() — Method in class OutputHandler
- ConsolePrinter::end() — Method in class ConsolePrinter
- JUnitPrinter::end() — Method in class JUnitPrinter
- Logger::end() — Method in class Logger
- TapPrinter::end() — Method in class TapPrinter
F
- Assert::false() — Method in class Assert
Asserts that a value is false.
- Assert::falsey() — Method in class Assert
Asserts that a value is falsey.
- Assert::fail() — Method in class Assert
Assertion that fails.
- Collector::flush() — Method in class Collector
Flushes all gathered information. Effective only with PHPDBG collector.
- DomQuery::fromHtml() — Method in class DomQuery
- DomQuery::fromXml() — Method in class DomQuery
- DomQuery::find() — Method in class DomQuery
Returns array of descendants filtered by a selector.
- Expect::false() — Method in class Expect
- Expect::falsey() — Method in class Expect
- FileMock — Class in namespace Tester
Mock files.
- $ FileMock#files — Property in class FileMock
- FileMutator — Class in namespace Tester
PHP file mutator.
- Helpers::findCommonDirectory() — Method in class Helpers
Find common directory for given paths. All files or directories must exist.
- OutputHandler::finish() — Method in class OutputHandler
- ConsolePrinter::finish() — Method in class ConsolePrinter
- JUnitPrinter::finish() — Method in class JUnitPrinter
- Logger::finish() — Method in class Logger
- TapPrinter::finish() — Method in class TapPrinter
- Runner::finishTest() — Method in class Runner
Writes to output handlers.
G
- AbstractGenerator::getCoveredPercent() — Method in class AbstractGenerator
- AbstractGenerator::getSourceIterator() — Method in class AbstractGenerator
- AbstractGenerator::getCommonFilesPath() — Method in class AbstractGenerator
- Environment::getTestAnnotations() — Method in class Environment
Returns current test annotations.
- Job::getEnvironmentVariable() — Method in class Job
- Job::getTest() — Method in class Job
- Job::getExitCode() — Method in class Job
Returns exit code.
- Job::getHeaders() — Method in class Job
Returns output headers.
- Job::getDuration() — Method in class Job
Returns process duration in seconds.
- PhpInterpreter::getCommandLine() — Method in class PhpInterpreter
- PhpInterpreter::getVersion() — Method in class PhpInterpreter
- PhpInterpreter::getCodeCoverageEngines() — Method in class PhpInterpreter
- PhpInterpreter::getStartupError() — Method in class PhpInterpreter
- PhpInterpreter::getShortInfo() — Method in class PhpInterpreter
- Runner::getEnvironmentVariables() — Method in class Runner
- Runner::getInterpreter() — Method in class Runner
- Test::getFile() — Method in class Test
- Test::getArguments() — Method in class Test
- Test::getSignature() — Method in class Test
- Test::getResult() — Method in class Test
- Test::getDuration() — Method in class Test
Duration in seconds.
- TestCase::getData() — Method in class TestCase
H
- Assert::hasKey() — Method in class Assert
Asserts that a haystack has an expected key.
- Assert::hasNotKey() — Method in class Assert
Asserts that a haystack doesn't have an expected key.
- HtmlGenerator — Class in namespace Tester\CodeCoverage\Generators
Code coverage report generator.
- DomQuery::has() — Method in class DomQuery
Check the current document against a selector.
- Environment::handleException() — Method in class Environment
- Helpers — Class in namespace Tester
Test helpers.
- CommandLine::help() — Method in class CommandLine
- PhpInterpreter::hasExtension() — Method in class PhpInterpreter
- Test::hasResult() — Method in class Test
I
- Assert::isMatching() — Method in class Assert
Compares using mask.
- Collector::isStarted() — Method in class Collector
- CommandLine::isEmpty() — Method in class CommandLine
- InterruptException — Class in namespace Tester\Runner
- Job::isRunning() — Method in class Job
Checks if the test is still running.
- PhpInterpreter::isCgi() — Method in class PhpInterpreter
- $ Runner#ignoreDirs — Property in class Runner
- TestHandler::initiate() — Method in class TestHandler
J
- Job — Class in namespace Tester\Runner
Single test job.
- JUnitPrinter — Class in namespace Tester\Runner\Output
JUnit xml format printer.
L
- DataProvider::load() — Method in class DataProvider
- Environment::lock() — Method in class Environment
Locks the parallel tests.
- Environment::loadData() — Method in class Environment
Loads data according to the file annotation or specified by Tester\Runner\TestHandler::initiateDataProvider()
- Logger — Class in namespace Tester\Runner\Output
Verbose logger.
M
- Assert::match() — Method in class Assert
Asserts that a string matches a given pattern.
- Assert::matchFile() — Method in class Assert
Asserts that a string matches a given pattern stored in file.
- $ Dumper#maxLength — Property in class Dumper
- $ Dumper#maxDepth — Property in class Dumper
- $ Dumper#maxPathSegments — Property in class Dumper
- Expect::match() — Method in class Expect
- Expect::matchFile() — Method in class Expect
- FileMutator::mkdir() — Method in class FileMutator
- $ Test#message — Property in class Test
N
- Assert::notSame() — Method in class Assert
Asserts that two values are not equal or do not have the same type and identity of objects.
- Assert::notEqual() — Method in class Assert
Asserts that two values are not equal and checks expectations. The identity of objects, the order of keys in the arrays and marginally different floats are ignored.
- Assert::notContains() — Method in class Assert
Asserts that a haystack (string or array) does not contain an expected needle.
- Assert::null() — Method in class Assert
Asserts that a value is null.
- Assert::notNull() — Method in class Assert
Asserts that a value is not null.
- Assert::nan() — Method in class Assert
Asserts that a value is Not a Number.
- Assert::noError() — Method in class Assert
Asserts that a function does not generate PHP errors and does not throw exceptions.
- Expect::notSame() — Method in class Expect
- Expect::notEqual() — Method in class Expect
- Expect::notContains() — Method in class Expect
- Expect::null() — Method in class Expect
- Expect::nan() — Method in class Expect
O
- $ Assert#onFailure — Property in class Assert
- $ AssertException#origMessage — Property in class AssertException
- $ AssertException#outputName — Property in class AssertException
- OutputHandler — Class in namespace Tester\Runner
Runner output.
- $ Runner#outputHandlers — Property in class Runner
P
- $ Assert#patterns — Property in class Assert
used by match(); in values, each $ followed by number is backreference
- PhpParser — Class in namespace Tester\CodeCoverage
Parses PHP source code and returns:
- the start/end line information about functions, classes, interfaces, traits and their methods
- the count of code lines
- the count of commented code lines
- PhpParser::parse() — Method in class PhpParser
Returned structure is: stdClass { linesOfCode: int, linesOfComments: int, functions: [functionName => $functionInfo], classes: [className => $info], traits: [traitName => $info], interfaces: [interfaceName => $info], }
- DataProvider::parseAnnotation() — Method in class DataProvider
- $ Dumper#pathSeparator — Property in class Dumper
- Helpers::purge() — Method in class Helpers
Purges directory.
- Helpers::parseDocComment() — Method in class Helpers
Parse phpDoc comment.
- CommandLine::parse() — Method in class CommandLine
- OutputHandler::prepare() — Method in class OutputHandler
- ConsolePrinter::prepare() — Method in class ConsolePrinter
- JUnitPrinter::prepare() — Method in class JUnitPrinter
- Logger::prepare() — Method in class Logger
- TapPrinter::prepare() — Method in class TapPrinter
- PhpInterpreter — Class in namespace Tester\Runner
PHP command-line executable.
- $ Runner#paths — Property in class Runner
- Runner::prepareTest() — Method in class Runner
R
- AbstractGenerator::render() — Method in class AbstractGenerator
- AbstractGenerator::renderSelf() — Method in class AbstractGenerator
- CloverXMLGenerator::renderSelf() — Method in class CloverXMLGenerator
- HtmlGenerator::renderSelf() — Method in class HtmlGenerator
- Dumper::removeColors() — Method in class Dumper
- FileMock::register() — Method in class FileMock
- FileMutator::rename() — Method in class FileMutator
- FileMutator::rmdir() — Method in class FileMutator
- CliTester::run() — Method in class CliTester
- Job::run() — Method in class Job
Runs single test.
- Runner — Class in namespace Tester\Runner
Test runner.
- Runner::run() — Method in class Runner
Runs all tests.
- TestCase::run() — Method in class TestCase
Runs the test case.
- TestCase::runTest() — Method in class TestCase
Runs the test method.
S
- Assert::same() — Method in class Assert
Asserts that two values are equal and have the same type and identity of objects.
- AssertException::setMessage() — Method in class AssertException
- Collector::start() — Method in class Collector
Starts gathering the information for code coverage.
- Collector::save() — Method in class Collector
Saves information about code coverage. Can be called repeatedly to free memory.
- $ AbstractGenerator#sources — Property in class AbstractGenerator
- Dumper::saveOutput() — Method in class Dumper
Dumps data to folder 'output'.
- Environment::setup() — Method in class Environment
Configures testing environment.
- Environment::setupColors() — Method in class Environment
Configures colored output.
- Environment::setupErrors() — Method in class Environment
Configures PHP error handling.
- Environment::skip() — Method in class Environment
Skips this test.
- Expect::same() — Method in class Expect
- FileMock::stream_open() — Method in class FileMock
- FileMock::stream_read() — Method in class FileMock
- FileMock::stream_write() — Method in class FileMock
- FileMock::stream_tell() — Method in class FileMock
- FileMock::stream_eof() — Method in class FileMock
- FileMock::stream_seek() — Method in class FileMock
- FileMock::stream_truncate() — Method in class FileMock
- FileMock::stream_set_option() — Method in class FileMock
- FileMock::stream_stat() — Method in class FileMock
- FileMock::stream_lock() — Method in class FileMock
- FileMock::stream_metadata() — Method in class FileMock
- FileMutator::stream_cast() — Method in class FileMutator
- FileMutator::stream_close() — Method in class FileMutator
- FileMutator::stream_eof() — Method in class FileMutator
- FileMutator::stream_flush() — Method in class FileMutator
- FileMutator::stream_lock() — Method in class FileMutator
- FileMutator::stream_metadata() — Method in class FileMutator
- FileMutator::stream_open() — Method in class FileMutator
- FileMutator::stream_read() — Method in class FileMutator
- FileMutator::stream_seek() — Method in class FileMutator
- FileMutator::stream_set_option() — Method in class FileMutator
- FileMutator::stream_stat() — Method in class FileMutator
- FileMutator::stream_tell() — Method in class FileMutator
- FileMutator::stream_truncate() — Method in class FileMutator
- FileMutator::stream_write() — Method in class FileMutator
- Job::setEnvironmentVariable() — Method in class Job
- $ Runner#stopOnFail — Property in class Runner
- Runner::setEnvironmentVariable() — Method in class Runner
- Runner::setTempDirectory() — Method in class Runner
- $ Test#stdout — Property in class Test
- $ Test#stderr — Property in class Test
- TestHandler::setTempDirectory() — Method in class TestHandler
- TestCase::setUp() — Method in class TestCase
This method is called before a test is executed.
- TestCase::skip() — Method in class TestCase
Skips the test.
T
- Assert::true() — Method in class Assert
Asserts that a value is true.
- Assert::truthy() — Method in class Assert
Asserts that a value is truthy.
- Assert::type() — Method in class Assert
Asserts that a value is of given class, interface or built-in type.
- Assert::throws() — Method in class Assert
Asserts that a function throws exception of given type and its message matches given pattern. Alias for exception().
- $ AbstractGenerator#totalSum — Property in class AbstractGenerator
- DataProvider::testQuery() — Method in class DataProvider
- Dumper::toLine() — Method in class Dumper
Dumps information about a variable in readable format.
- Dumper::toPhp() — Method in class Dumper
Dumps variable in PHP format.
- Expect::that() — Method in class Expect
- Expect::true() — Method in class Expect
- Expect::truthy() — Method in class Expect
- Expect::type() — Method in class Expect
- TapPrinter — Class in namespace Tester\Runner\Output
Test Anything Protocol, http://testanything.org
- $ Runner#threadCount — Property in class Runner
- $ Runner#testHandler — Property in class Runner
- Test — Class in namespace Tester\Runner
Test represents one result.
- $ Test#title — Property in class Test
- TestHandler — Class in namespace Tester\Runner
Default test behavior.
- TestCase — Class in namespace Tester
Single test case.
- TestCase::tearDown() — Method in class TestCase
This method is called after a test is executed.
- TestCaseException — Class in namespace Tester
- TestCaseSkippedException — Class in namespace Tester
U
- $ Environment#useColors — Property in class Environment
- FileMock::url_stat() — Method in class FileMock
- FileMock::unlink() — Method in class FileMock
- FileMutator::unlink() — Method in class FileMutator
- FileMutator::url_stat() — Method in class FileMutator
W
- Assert::with() — Method in class Assert
Executes function that can access private and protected members of given object via $this.
- PhpInterpreter::withPhpIniOption() — Method in class PhpInterpreter
- Test::withArguments() — Method in class Test
- Test::withResult() — Method in class Test
_
- AssertException::__construct() — Method in class AssertException
- AbstractGenerator::__construct() — Method in class AbstractGenerator
- CloverXMLGenerator::__construct() — Method in class CloverXMLGenerator
- HtmlGenerator::__construct() — Method in class HtmlGenerator
- Expect::__callStatic() — Method in class Expect
- Expect::__call() — Method in class Expect
- Expect::__invoke() — Method in class Expect
Checks the expectations.
- CommandLine::__construct() — Method in class CommandLine
- Job::__construct() — Method in class Job
- ConsolePrinter::__construct() — Method in class ConsolePrinter
- JUnitPrinter::__construct() — Method in class JUnitPrinter
- Logger::__construct() — Method in class Logger
- TapPrinter::__construct() — Method in class TapPrinter
- PhpInterpreter::__construct() — Method in class PhpInterpreter
- Runner::__construct() — Method in class Runner
- Test::__construct() — Method in class Test
- TestHandler::__construct() — Method in class TestHandler