PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Scott Arciszewski   Stern PHP Type Safety   README.md   Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Read me
Class: Stern PHP Type Safety
Make class function calls invoke strict versions
Author: By
Last change:
Date: 3 years ago
Size: 1,722 bytes
 

Contents

Class file image Download

Stern

Build Status Latest Stable Version Latest Unstable Version License

Stern lets you built type-safe PHP projects, even if your project's users aren't writing type-safe code.

Requires PHP 7+

Usage

Using Stern is simply:

  1. Make your class use the `SternTrait`.
  2. Rename your methods from `whateverName` to `strictWhateverName`.
  3. Enjoy strict-typing whether your users like it or not.

Example

  <?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
      {
      }
  }

Docblock Usability

For better usability (especially with type-aware IDEs like PHPStorm), make sure you use @method docblocks.

  <?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
      {
      }
  }