grifart / phpstan-rules
Fills missing pieces of the PHP type system.
dev-master
2019-12-05 15:04 UTC
Requires
- php: ^7.1 || ^7.2 || ^7.3
- phpstan/phpstan: ^0.12.0
This package is auto-updated.
Last update: 2024-11-06 02:03:17 UTC
README
@overrides
or must call parent
If there is overriding method, it must either has annotation @overrides
or must call parent method.
class BasePresenter { private $dep; public function injectFoo(Dependency $dep): void { $this->dep = $dep } } class LoginPresenter extends BasePresenter { private $dep; public function injectFoo(Dependency $dep): void { $this->dep = $dep } }
Requires LoginPresenter
to be explicitly tell that you are intentionally overriding method:
class LoginPresenter extends BasePresenter { private $dep; /** * @overrides */ public function injectFoo(Dependency $dep): void { $this->dep = $dep } }
or call parent function:
class LoginPresenter extends BasePresenter { private $dep; public function injectFoo(Dependency $dep): void { $this->dep = $dep parent::injectFoo($dep); } }
Sealed classes
Sealed classes are used for representing restricted class hierarchies.
// file: enum.php /** * @sealed */ abstract class EnumFoo { } final class Value1 extends EnumFoo {} final class Value2 extends EnumFoo {} final class Value3 extends EnumFoo {} // file: other.php final class Value4 extends EnumFoo {} // not allowed
This restricts declaring any other sub-type of EnumFoo
, then Value1
, Value2
, Value3
. This is usefull, because it should then understand that:
\assert($value instanceof EnumFoo); switch (getclass($value)): { case Value1::class: break; case Value2::class: break; case Value3::class: break; default: echo "unreachable code!"; break; }
Type system should know that default case is unreachable, because there cannot be any other type decalared anywhere.
Overriding property in child class
class BasePresenter { /** @var Dependency */ public $dep; } class LoginPresenter extends BasePresenter { /** @var Dependency2 */ public $dep; // error }
require_once return value used
This is usually not what you expect.