paragonie/stern

Stern 允许您构建类型安全的 PHP 项目，即使您的项目用户没有编写类型安全的代码

维护者

详细信息

github.com/paragonie/stern

源代码

问题

安装次数: 1,414

依赖项: 1

建议者: 0

安全性: 0

星标: 21

关注者: 6

分支: 1

开放问题: 0

v1.0.1 2021-04-19 03:01 UTC

Requires

  • php: ^7|^8

Requires (Dev)

MIT 21359fc45c4fb0ba09fbfb3b23bd13353b31a739

This package is auto-updated.

Last update: 2024-09-12 09:49:20 UTC

README

Build Status Latest Stable Version Latest Unstable Version License

Stern 允许您构建类型安全的 PHP 项目，即使您的项目用户没有编写类型安全的代码。

需要 PHP 7+

用法

使用 Stern 非常简单

  1. 让您的类使用 SternTrait。
  2. 将方法名从 whateverName 重命名为 strictWhateverName。
  3. 无论用户是否喜欢，都能享受严格的类型检查。

示例

  <?php
  declare(strict_types=1);
  namespace YourVendor\YourNamespace;

  class YourClassThatUsesStrictTypes
  {
+      use \ParagonIE\Stern\SternTrait;
  
      /* ... */
  
-     public function foo(string $param = ''): bool
+     public function strictFoo(string $param = ''): bool
      {
      }
  }

文档块易用性

为了更好的易用性（特别是与 PHPStorm 等类型感知 IDE 一起使用），请确保您使用了 @method 文档块。

  <?php
  declare(strict_types=1);
  namespace YourVendor\YourNamespace;

+   /**
+    * @method bool foo(string $param = '')
+    */
  class YourClassThatUsesStrictTypes
  {
+      use \ParagonIE\Stern\SternTrait;
  
      /* ... */
  
-     public function foo(string $param = ''): bool
+     public function strictFoo(string $param = ''): bool
      {
      }
  }