Docs For Class PHPUnit2_Framework

[line 92]
A TestSuite is a composite of Tests. It runs a collection of test cases.

Here is an example using the dynamic test definition.

 <?php

 $suite = new PHPUnit2_Framework_TestSuite;
 $suite->addTest(new MathTest('testPass'));
 ?>

Alternatively, a TestSuite can extract the tests to be run automatically. To do so you pass a ReflectionClass instance for your PHPUnit2_Framework_TestCase class to the PHPUnit2_Framework_TestSuite constructor.

 <?php

 $suite = new PHPUnit2_Framework_TestSuite(
   new ReflectionClass('MathTest')
 );
 ?>

This constructor creates a suite with all the methods starting with "test" that take no arguments.

Author: Sebastian Bergmann <sb@sebastian-bergmann.de>
Version: Release: @package_version@
Copyright: 2002-2006 Sebastian Bergmann <sb@sebastian-bergmann.de>
Link: http://pear.php.net/package/PHPUnit2
Since: Class available since Release 2.0.0
License: BSD License

__construct (Constructor) [line 131]

PHPUnit2_Framework_TestSuite __construct(
[mixed
$theClass = ''], [string
$name = ''])

Constructs a new TestSuite:

PHPUnit2_Framework_TestSuite() constructs an empty TestSuite.

PHPUnit2_Framework_TestSuite(ReflectionClass) constructs a TestSuite from the given class.

PHPUnit2_Framework_TestSuite(ReflectionClass, String) constructs a TestSuite from the given class with the given name.

PHPUnit2_Framework_TestSuite(String) either constructs a TestSuite from the given class (if the passed string is the name of an existing class) or constructs an empty TestSuite with the given name.

Throws: Exception
Access: public

Parameters:

mixed	`$theClass`	—
string	`$name`	—

[ Top ]

addTest [line 217]

void addTest(
PHPUnit2_Framework_Test
$test)

Adds a test to the suite.

Access: public

Parameters:

PHPUnit2_Framework_Test $test —

[ Top ]

addTestFile [line 253]

void addTestFile(
string
$filename)

Wraps both

addTest()

and

addTestSuite

as well as the separate import statements for the user's convenience.

If the named file cannot be read or there are no new tests that can be added, a

PHPUnit2_Framework_Warning

will be created instead, leaving the current test run untouched.

Author: Stefano F. Rausch <stefano@rausch-e.net>
Since: Method available since Release 2.3.0
Throws: Exception
Access: public

Parameters:

string $filename —

[ Top ]

addTestFiles [line 299]

void addTestFiles(
Array
$filenames)

Wrapper for addTestFile() that adds multiple test files.

Throws: Exception
Since: Method available since Release 2.3.0
Access: public

Parameters:

Array $filenames —

[ Top ]

addTestSuite [line 227]

void addTestSuite(
mixed
$testClass)

Adds the tests from the given class to the suite.

Access: public

Parameters:

mixed $testClass —

[ Top ]

countTestCases [line 311]

integer countTestCases(
)

Counts the number of test cases that will be run by this test.

Access: public

[ Top ]

createResult [line 375]

PHPUnit2_Framework_TestResult createResult(
)

Creates a default TestResult object.

Access: protected

[ Top ]

createTest [line 328]

PHPUnit2_Framework_Test createTest(
ReflectionClass
$theClass, string
$name)

Access: public

Parameters:

ReflectionClass	`$theClass`	—
string	`$name`	—

[ Top ]

getName [line 385]

string getName(
)

Returns the name of the suite.

Access: public

[ Top ]

run [line 397]

PHPUnit2_Framework_TestResult run(
[PHPUnit2_Framework_TestResult
$result = NULL])

Runs the tests and collects their result in a TestResult.

Throws: Exception
Access: public

Parameters:

PHPUnit2_Framework_TestResult $result —

[ Top ]

runTest [line 431]

void runTest(
PHPUnit2_Framework_Test
$test, PHPUnit2_Framework_TestResult
$result, PHPUnit2_Framework_TestResult
$testResult)

Runs a test.

Access: public

Parameters:

PHPUnit2_Framework_Test	`$test`	—
PHPUnit2_Framework_TestResult	`$testResult`	—
PHPUnit2_Framework_TestResult	`$result`	—

[ Top ]

setName [line 441]

void setName(
string
$name)

Sets the name of the suite.

Access: public

Parameters:

string $name —

[ Top ]

testAt [line 452]

PHPUnit2_Framework_Test testAt(
integer
$index)

Returns the test at the given index.

Access: public

Parameters:

integer $index —

[ Top ]

testCount [line 466]

integer testCount(
)

Returns the number of tests in this suite.

Access: public

[ Top ]

tests [line 476]

array tests(
)

Returns the tests as an enumeration.

Access: public

[ Top ]

toString [line 207]

string toString(
)

Returns a string representation of the test suite.

Access: public

[ Top ]

Class: PHPUnit2_Framework_TestSuite

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 131]

Parameters:

addTest [line 217]

Parameters:

addTestFile [line 253]

Parameters:

addTestFiles [line 299]

Parameters:

addTestSuite [line 227]

Parameters:

countTestCases [line 311]

createResult [line 375]

createTest [line 328]

Parameters:

getName [line 385]

run [line 397]

Parameters:

runTest [line 431]

Parameters:

setName [line 441]

Parameters:

testAt [line 452]

Parameters:

testCount [line 466]

tests [line 476]

toString [line 207]