Improve type hints

enumag · enumag · commit b67536ee0694 · 2017-09-29T14:07:07.000+02:00
diff --git a/src/Connector/NetteConnector.php b/src/Connector/NetteConnector.php
@@ -32,10 +32,8 @@ public function setContainerAccessor(callable $containerAccessor): void
 
     /**
      * @param Request $request
-     *
-     * @return Response
      */
-    public function doRequest($request)
+    public function doRequest($request): Response
     {
         $_COOKIE = $request->getCookies();
         $_SERVER = $request->getServer();
diff --git a/src/Http/Request.php b/src/Http/Request.php
@@ -71,12 +71,12 @@ public function getMethod(): string
         return $this->request->getMethod();
     }
 
-    public function getPost(string $key = null)
+    public function getPost(?string $key = null)
     {
         return $this->request->getPost(...func_get_args());
     }
 
-    public function getQuery(string $key = null)
+    public function getQuery(?string $key = null)
     {
         return $this->request->getQuery(...func_get_args());
     }
diff --git a/src/Http/Response.php b/src/Http/Response.php
@@ -31,69 +31,39 @@ public function reset(): void
         $this->headers = [];
     }
 
-    /**
-     * @param int $code
-     *
-     * @return static
-     */
-    public function setCode(int $code)
+    public function setCode(int $code): Response
     {
         $this->code = $code;
 
         return $this;
     }
 
-    /**
-     * @return int
-     */
     public function getCode(): int
     {
         return $this->code;
     }
 
-    /**
-     * @param string $name
-     * @param string $value
-     *
-     * @return static
-     */
-    public function setHeader(string $name, string $value)
+    public function setHeader(string $name, string $value): Response
     {
         $this->headers[$name] = $value;
 
         return $this;
     }
 
-    /**
-     * @param string $name
-     * @param string $value
-     *
-     * @return static
-     */
-    public function addHeader(string $name, string $value)
+    public function addHeader(string $name, string $value): Response
     {
         $this->headers[$name] = $value;
 
         return $this;
     }
 
-    /**
-     * @param string $type
-     * @param string $charset
-     *
-     * @return static
-     */
-    public function setContentType(string $type, string $charset = null)
+    public function setContentType(string $type, ?string $charset = null): Response
     {
         $this->setHeader('Content-Type', $type.($charset ? '; charset='.$charset : ''));
 
         return $this;
     }
 
-    /**
-     * @param string $url
-     * @param int    $code
-     */
     public function redirect(string $url, int $code = self::S302_FOUND): void
     {
         $this->setCode($code);
@@ -102,10 +72,8 @@ public function redirect(string $url, int $code = self::S302_FOUND): void
 
     /**
      * @param string|int|DateTime $time
-     *
-     * @return static
      */
-    public function setExpiration($time)
+    public function setExpiration($time): Response
     {
         if (!$time) {
             $this->setHeader('Cache-Control', 's-maxage=0, max-age=0, must-revalidate');
@@ -121,55 +89,30 @@ public function setExpiration($time)
         return $this;
     }
 
-    /**
-     * @return bool
-     */
     public function isSent(): bool
     {
         return false;
     }
 
-    /**
-     * @param string $name
-     *
-     * @return mixed
-     */
     public function getHeader(string $name): ?string
     {
         return $this->headers[$name] ?? null;
     }
 
-    /**
-     * @return array
-     */
     public function getHeaders(): array
     {
         return $this->headers;
     }
 
     /**
-     * @param string              $name
-     * @param string              $value
      * @param string|int|DateTime $time
-     * @param string              $path
-     * @param string              $domain
-     * @param bool                $secure
-     * @param bool                $httpOnly
-     *
-     * @return self
      */
-    public function setCookie(string $name, string $value, $time, string $path = null, string $domain = null, bool $secure = null, bool $httpOnly = null, string $sameSite = null)
+    public function setCookie(string $name, string $value, $time, ?string $path = null, ?string $domain = null, ?bool $secure = null, ?bool $httpOnly = null, ?string $sameSite = null): Response
     {
         return $this;
     }
 
-    /**
-     * @param string $name
-     * @param string $path
-     * @param string $domain
-     * @param bool   $secure
-     */
-    public function deleteCookie(string $name, string $path = null, string $domain = null, bool $secure = null): void
+    public function deleteCookie(string $name, ?string $path = null, ?string $domain = null, ?bool $secure = null): void
     {
     }
 }
diff --git a/src/Module/NetteApplicationModule.php b/src/Module/NetteApplicationModule.php
@@ -32,12 +32,12 @@ class NetteApplicationModule extends Framework
      */
     private $path;
 
-    public function _beforeSuite($settings = [])
+    public function _beforeSuite($settings = []): void
     {
         $this->path = $settings['path'];
     }
 
-    public function _before(TestInterface $test)
+    public function _before(TestInterface $test): void
     {
         $this->client = new NetteConnector();
         $this->client->setContainerAccessor(
@@ -53,7 +53,7 @@ function () {
         parent::_before($test);
     }
 
-    public function _after(TestInterface $test)
+    public function _after(TestInterface $test): void
     {
         parent::_after($test);
 
@@ -64,17 +64,11 @@ public function _after(TestInterface $test)
         $_COOKIE = [];
     }
 
-    /**
-     * @param bool $followRedirects
-     */
     public function followRedirects(bool $followRedirects): void
     {
         $this->client->followRedirects($followRedirects);
     }
 
-    /**
-     * @param string $url
-     */
     public function seeRedirectTo(string $url): void
     {
         if ($this->client->isFollowingRedirects()) {
diff --git a/src/Module/NetteDIModule.php b/src/Module/NetteDIModule.php
@@ -23,6 +23,9 @@ class NetteDIModule extends Module
      */
     public $onCreateContainer = [];
 
+    /**
+     * @var array
+     */
     protected $config = [
         'configFiles' => [],
         'appDir' => null,
@@ -33,6 +36,9 @@ class NetteDIModule extends Module
         'newContainerForEachTest' => false,
     ];
 
+    /**
+     * @var array
+     */
     protected $requiredFields = [
         'tempDir',
     ];
@@ -52,13 +58,13 @@ class NetteDIModule extends Module
      */
     private $container;
 
-    public function _beforeSuite($settings = [])
+    public function _beforeSuite($settings = []): void
     {
         $this->path = $settings['path'];
         $this->clearTempDir();
     }
 
-    public function _before(TestInterface $test)
+    public function _before(TestInterface $test): void
     {
         if ($this->config['newContainerForEachTest']) {
             $this->clearTempDir();
@@ -67,12 +73,12 @@ public function _before(TestInterface $test)
         }
     }
 
-    public function _afterSuite()
+    public function _afterSuite(): void
     {
         $this->stopContainer();
     }
 
-    public function _after(TestInterface $test)
+    public function _after(TestInterface $test): void
     {
         if ($this->config['newContainerForEachTest']) {
             $this->stopContainer();
@@ -90,9 +96,6 @@ public function useConfigFiles(array $configFiles): void
         $this->configFiles = $configFiles;
     }
 
-    /**
-     * @return Container
-     */
     public function getContainer(): Container
     {
         if (!$this->container) {
@@ -103,8 +106,6 @@ public function getContainer(): Container
     }
 
     /**
-     * @param string $service
-     *
      * @return object
      */
     public function grabService(string $service)
diff --git a/src/Tracy/Logger.php b/src/Tracy/Logger.php
@@ -22,13 +22,13 @@ public function __construct($config, $options)
         Debugger::$logDirectory = $this->getLogDir();
     }
 
-    public function testFail(FailEvent $e)
+    public function testFail(FailEvent $event): void
     {
-        Debugger::log($e->getFail());
+        Debugger::log($event->getFail());
     }
 
-    public function testError(FailEvent $e)
+    public function testError(FailEvent $event): void
     {
-        Debugger::log($e->getFail());
+        Debugger::log($event->getFail());
     }
 }
diff --git a/tests/functional/src/Fixtures/RouterFactory.php b/tests/functional/src/Fixtures/RouterFactory.php
@@ -13,9 +13,6 @@
  */
 class RouterFactory
 {
-    /**
-     * @return IRouter
-     */
     public function create(): IRouter
     {
         $router = new RouteList();

Original file line number	Diff line number	Diff line change
`@@ -71,12 +71,12 @@ public function getMethod(): string`
`71`	`71`	`return $this->request->getMethod();`
`72`	`72`	`}`
`73`	`73`
`74`		`- public function getPost(string $key = null)`
	`74`	`+ public function getPost(?string $key = null)`
`75`	`75`	`{`
`76`	`76`	`return $this->request->getPost(...func_get_args());`
`77`	`77`	`}`
`78`	`78`
`79`		`- public function getQuery(string $key = null)`
	`79`	`+ public function getQuery(?string $key = null)`
`80`	`80`	`{`
`81`	`81`	`return $this->request->getQuery(...func_get_args());`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,69 +31,39 @@ public function reset(): void`
`31`	`31`	`$this->headers = [];`
`32`	`32`	`}`
`33`	`33`
`34`		`- /**`
`35`		`- * @param int $code`
`36`		`- *`
`37`		`- * @return static`
`38`		`- */`
`39`		`- public function setCode(int $code)`
	`34`	`+ public function setCode(int $code): Response`
`40`	`35`	`{`
`41`	`36`	`$this->code = $code;`
`42`	`37`
`43`	`38`	`return $this;`
`44`	`39`	`}`
`45`	`40`
`46`		`- /**`
`47`		`- * @return int`
`48`		`- */`
`49`	`41`	`public function getCode(): int`
`50`	`42`	`{`
`51`	`43`	`return $this->code;`
`52`	`44`	`}`
`53`	`45`
`54`		`- /**`
`55`		`- * @param string $name`
`56`		`- * @param string $value`
`57`		`- *`
`58`		`- * @return static`
`59`		`- */`
`60`		`- public function setHeader(string $name, string $value)`
	`46`	`+ public function setHeader(string $name, string $value): Response`
`61`	`47`	`{`
`62`	`48`	`$this->headers[$name] = $value;`
`63`	`49`
`64`	`50`	`return $this;`
`65`	`51`	`}`
`66`	`52`
`67`		`- /**`
`68`		`- * @param string $name`
`69`		`- * @param string $value`
`70`		`- *`
`71`		`- * @return static`
`72`		`- */`
`73`		`- public function addHeader(string $name, string $value)`
	`53`	`+ public function addHeader(string $name, string $value): Response`
`74`	`54`	`{`
`75`	`55`	`$this->headers[$name] = $value;`
`76`	`56`
`77`	`57`	`return $this;`
`78`	`58`	`}`
`79`	`59`
`80`		`- /**`
`81`		`- * @param string $type`
`82`		`- * @param string $charset`
`83`		`- *`
`84`		`- * @return static`
`85`		`- */`
`86`		`- public function setContentType(string $type, string $charset = null)`
	`60`	`+ public function setContentType(string $type, ?string $charset = null): Response`
`87`	`61`	`{`
`88`	`62`	`$this->setHeader('Content-Type', $type.($charset ? '; charset='.$charset : ''));`
`89`	`63`
`90`	`64`	`return $this;`
`91`	`65`	`}`
`92`	`66`
`93`		`- /**`
`94`		`- * @param string $url`
`95`		`- * @param int $code`
`96`		`- */`
`97`	`67`	`public function redirect(string $url, int $code = self::S302_FOUND): void`
`98`	`68`	`{`
`99`	`69`	`$this->setCode($code);`
`@@ -102,10 +72,8 @@ public function redirect(string $url, int $code = self::S302_FOUND): void`
`102`	`72`
`103`	`73`	`/**`
`104`	`74`	`* @param string\|int\|DateTime $time`
`105`		`- *`
`106`		`- * @return static`
`107`	`75`	`*/`
`108`		`- public function setExpiration($time)`
	`76`	`+ public function setExpiration($time): Response`
`109`	`77`	`{`
`110`	`78`	`if (!$time) {`
`111`	`79`	`$this->setHeader('Cache-Control', 's-maxage=0, max-age=0, must-revalidate');`
`@@ -121,55 +89,30 @@ public function setExpiration($time)`
`121`	`89`	`return $this;`
`122`	`90`	`}`
`123`	`91`
`124`		`- /**`
`125`		`- * @return bool`
`126`		`- */`
`127`	`92`	`public function isSent(): bool`
`128`	`93`	`{`
`129`	`94`	`return false;`
`130`	`95`	`}`
`131`	`96`
`132`		`- /**`
`133`		`- * @param string $name`
`134`		`- *`
`135`		`- * @return mixed`
`136`		`- */`
`137`	`97`	`public function getHeader(string $name): ?string`
`138`	`98`	`{`
`139`	`99`	`return $this->headers[$name] ?? null;`
`140`	`100`	`}`
`141`	`101`
`142`		`- /**`
`143`		`- * @return array`
`144`		`- */`
`145`	`102`	`public function getHeaders(): array`
`146`	`103`	`{`
`147`	`104`	`return $this->headers;`
`148`	`105`	`}`
`149`	`106`
`150`	`107`	`/**`
`151`		`- * @param string $name`
`152`		`- * @param string $value`
`153`	`108`	`* @param string\|int\|DateTime $time`
`154`		`- * @param string $path`
`155`		`- * @param string $domain`
`156`		`- * @param bool $secure`
`157`		`- * @param bool $httpOnly`
`158`		`- *`
`159`		`- * @return self`
`160`	`109`	`*/`
`161`		`- public function setCookie(string $name, string $value, $time, string $path = null, string $domain = null, bool $secure = null, bool $httpOnly = null, string $sameSite = null)`
	`110`	`+ public function setCookie(string $name, string $value, $time, ?string $path = null, ?string $domain = null, ?bool $secure = null, ?bool $httpOnly = null, ?string $sameSite = null): Response`
`162`	`111`	`{`
`163`	`112`	`return $this;`
`164`	`113`	`}`
`165`	`114`
`166`		`- /**`
`167`		`- * @param string $name`
`168`		`- * @param string $path`
`169`		`- * @param string $domain`
`170`		`- * @param bool $secure`
`171`		`- */`
`172`		`- public function deleteCookie(string $name, string $path = null, string $domain = null, bool $secure = null): void`
	`115`	`+ public function deleteCookie(string $name, ?string $path = null, ?string $domain = null, ?bool $secure = null): void`
`173`	`116`	`{`
`174`	`117`	`}`
`175`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,12 +32,12 @@ class NetteApplicationModule extends Framework`
`32`	`32`	`*/`
`33`	`33`	`private $path;`
`34`	`34`
`35`		`- public function _beforeSuite($settings = [])`
	`35`	`+ public function _beforeSuite($settings = []): void`
`36`	`36`	`{`
`37`	`37`	`$this->path = $settings['path'];`
`38`	`38`	`}`
`39`	`39`
`40`		`- public function _before(TestInterface $test)`
	`40`	`+ public function _before(TestInterface $test): void`
`41`	`41`	`{`
`42`	`42`	`$this->client = new NetteConnector();`
`43`	`43`	`$this->client->setContainerAccessor(`
`@@ -53,7 +53,7 @@ function () {`
`53`	`53`	`parent::_before($test);`
`54`	`54`	`}`
`55`	`55`
`56`		`- public function _after(TestInterface $test)`
	`56`	`+ public function _after(TestInterface $test): void`
`57`	`57`	`{`
`58`	`58`	`parent::_after($test);`
`59`	`59`
`@@ -64,17 +64,11 @@ public function _after(TestInterface $test)`
`64`	`64`	`$_COOKIE = [];`
`65`	`65`	`}`
`66`	`66`
`67`		`- /**`
`68`		`- * @param bool $followRedirects`
`69`		`- */`
`70`	`67`	`public function followRedirects(bool $followRedirects): void`
`71`	`68`	`{`
`72`	`69`	`$this->client->followRedirects($followRedirects);`
`73`	`70`	`}`
`74`	`71`
`75`		`- /**`
`76`		`- * @param string $url`
`77`		`- */`
`78`	`72`	`public function seeRedirectTo(string $url): void`
`79`	`73`	`{`
`80`	`74`	`if ($this->client->isFollowingRedirects()) {`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ class NetteDIModule extends Module`
`23`	`23`	`*/`
`24`	`24`	`public $onCreateContainer = [];`
`25`	`25`
	`26`	`+ /**`
	`27`	`+ * @var array`
	`28`	`+ */`
`26`	`29`	`protected $config = [`
`27`	`30`	`'configFiles' => [],`
`28`	`31`	`'appDir' => null,`
`@@ -33,6 +36,9 @@ class NetteDIModule extends Module`
`33`	`36`	`'newContainerForEachTest' => false,`
`34`	`37`	`];`
`35`	`38`
	`39`	`+ /**`
	`40`	`+ * @var array`
	`41`	`+ */`
`36`	`42`	`protected $requiredFields = [`
`37`	`43`	`'tempDir',`
`38`	`44`	`];`
`@@ -52,13 +58,13 @@ class NetteDIModule extends Module`
`52`	`58`	`*/`
`53`	`59`	`private $container;`
`54`	`60`
`55`		`- public function _beforeSuite($settings = [])`
	`61`	`+ public function _beforeSuite($settings = []): void`
`56`	`62`	`{`
`57`	`63`	`$this->path = $settings['path'];`
`58`	`64`	`$this->clearTempDir();`
`59`	`65`	`}`
`60`	`66`
`61`		`- public function _before(TestInterface $test)`
	`67`	`+ public function _before(TestInterface $test): void`
`62`	`68`	`{`
`63`	`69`	`if ($this->config['newContainerForEachTest']) {`
`64`	`70`	`$this->clearTempDir();`
`@@ -67,12 +73,12 @@ public function _before(TestInterface $test)`
`67`	`73`	`}`
`68`	`74`	`}`
`69`	`75`
`70`		`- public function _afterSuite()`
	`76`	`+ public function _afterSuite(): void`
`71`	`77`	`{`
`72`	`78`	`$this->stopContainer();`
`73`	`79`	`}`
`74`	`80`
`75`		`- public function _after(TestInterface $test)`
	`81`	`+ public function _after(TestInterface $test): void`
`76`	`82`	`{`
`77`	`83`	`if ($this->config['newContainerForEachTest']) {`
`78`	`84`	`$this->stopContainer();`
`@@ -90,9 +96,6 @@ public function useConfigFiles(array $configFiles): void`
`90`	`96`	`$this->configFiles = $configFiles;`
`91`	`97`	`}`
`92`	`98`
`93`		`- /**`
`94`		`- * @return Container`
`95`		`- */`
`96`	`99`	`public function getContainer(): Container`
`97`	`100`	`{`
`98`	`101`	`if (!$this->container) {`
`@@ -103,8 +106,6 @@ public function getContainer(): Container`
`103`	`106`	`}`
`104`	`107`
`105`	`108`	`/**`
`106`		`- * @param string $service`
`107`		`- *`
`108`	`109`	`* @return object`
`109`	`110`	`*/`
`110`	`111`	`public function grabService(string $service)`
Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,13 @@ public function __construct($config, $options)`
`22`	`22`	`Debugger::$logDirectory = $this->getLogDir();`
`23`	`23`	`}`
`24`	`24`
`25`		`- public function testFail(FailEvent $e)`
	`25`	`+ public function testFail(FailEvent $event): void`
`26`	`26`	`{`
`27`		`- Debugger::log($e->getFail());`
	`27`	`+ Debugger::log($event->getFail());`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function testError(FailEvent $e)`
	`30`	`+ public function testError(FailEvent $event): void`
`31`	`31`	`{`
`32`		`- Debugger::log($e->getFail());`
	`32`	`+ Debugger::log($event->getFail());`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,6 @@`
`13`	`13`	`*/`
`14`	`14`	`class RouterFactory`
`15`	`15`	`{`
`16`		`- /**`
`17`		`- * @return IRouter`
`18`		`- */`
`19`	`16`	`public function create(): IRouter`
`20`	`17`	`{`
`21`	`18`	`$router = new RouteList();`