Sync with sebastianbergmann/phpunit-documentation-english@14b42e7

Added return value type hints to code snippets where overrideable methods such as setUp, tearDown etc. are shown.

This avoids a fatal error when overriding those methods in a test class, for example:

PHP Fatal error:  Declaration of ExampleTest::setUpBeforeClass() must be compatible with PHPUnit\Framework\TestCase::setUpBeforeClass(): void in /home/dave/tests/ExampleTest.php on line 3

Also updated where the onNotSuccessfulTest method is shown, updating the argument from an Exception to a Throwable, to match the source code.

Author: m-takagi

src/code-coverage-analysis.rst

@@ -209,7 +209,7 @@ PHPUnit でこれを実現するには、
     {
         protected $ba;
 
-        protected function setUp()
+        protected function setUp(): void
         {
             $this->ba = new BankAccount;
         }

src/fixtures.rst

@@ -55,7 +55,7 @@ producer-consumer の関係を使って複数のテストでフィクスチャ
     {
         protected $stack;
 
-        protected function setUp()
+        protected function setUp(): void
         {
             $this->stack = [];
         }
@@ -100,7 +100,7 @@ producer-consumer の関係を使って複数のテストでフィクスチャ
 
     class TemplateMethodsTest extends TestCase
     {
-        public static function setUpBeforeClass()
+        public static function setUpBeforeClass(): void
         {
             fwrite(STDOUT, __METHOD__ . "\n");
         }
@@ -110,7 +110,7 @@ producer-consumer の関係を使って複数のテストでフィクスチャ
             fwrite(STDOUT, __METHOD__ . "\n");
         }
 
-        protected function assertPreConditions()
+        protected function assertPreConditions(): void
         {
             fwrite(STDOUT, __METHOD__ . "\n");
         }
@@ -127,7 +127,7 @@ producer-consumer の関係を使って複数のテストでフィクスチャ
             $this->assertTrue(false);
         }
 
-        protected function assertPostConditions()
+        protected function assertPostConditions(): void
         {
             fwrite(STDOUT, __METHOD__ . "\n");
         }
@@ -137,15 +137,15 @@ producer-consumer の関係を使って複数のテストでフィクスチャ
             fwrite(STDOUT, __METHOD__ . "\n");
         }
 
-        public static function tearDownAfterClass()
+        public static function tearDownAfterClass(): void
         {
             fwrite(STDOUT, __METHOD__ . "\n");
         }
 
-        protected function onNotSuccessfulTest(Exception $e)
+        protected function onNotSuccessfulTest(Throwable $t): void
         {
             fwrite(STDOUT, __METHOD__ . "\n");
-            throw $e;
+            throw $t;
         }
     }
 
@@ -245,12 +245,12 @@ tearDown() よりも setUp()
     {
         protected static $dbh;
 
-        public static function setUpBeforeClass()
+        public static function setUpBeforeClass(): void
         {
             self::$dbh = new PDO('sqlite::memory:');
         }
 
-        public static function tearDownAfterClass()
+        public static function tearDownAfterClass(): void
         {
             self::$dbh = null;
         }

src/incomplete-and-skipped-tests.rst

@@ -133,7 +133,7 @@ MySQLi 拡張モジュールが使用可能かを調べたうえで、もし使
 
     class DatabaseTest extends TestCase
     {
-        protected function setUp()
+        protected function setUp(): void
         {
             if (!extension_loaded('mysqli')) {
                 $this->markTestSkipped(

src/test-doubles.rst

@@ -1045,7 +1045,7 @@ vfsStream のような仮想ファイルシステムがなければ、外部へ
 
     class ExampleTest extends TestCase
     {
-        protected function setUp()
+        protected function setUp(): void
         {
             if (file_exists(dirname(__FILE__) . '/id')) {
                 rmdir(dirname(__FILE__) . '/id');
@@ -1061,7 +1061,7 @@ vfsStream のような仮想ファイルシステムがなければ、外部へ
             $this->assertTrue(file_exists(dirname(__FILE__) . '/id'));
         }
 
-        protected function tearDown()
+        protected function tearDown(): void
         {
             if (file_exists(dirname(__FILE__) . '/id')) {
                 rmdir(dirname(__FILE__) . '/id');
@@ -1096,7 +1096,7 @@ vfsStream のような仮想ファイルシステムがなければ、外部へ
 
     class ExampleTest extends TestCase
     {
-        public function setUp()
+        public function setUp(): void
         {
             vfsStreamWrapper::register();
             vfsStreamWrapper::setRoot(new vfsStreamDirectory('exampleDir'));