code-distortion/staticall

Run class methods both statically and non-statically

0.2.0 2024-03-23 02:38 UTC

Requires

• php: 7.0.* | 7.1.* | 7.2.* | 7.3.* | 7.4.* | 8.0.* | 8.1.* | 8.2.* | 8.3.*

Requires (Dev)

• infection/infection: ^0.10 | ^0.11 | ^0.12 | ^0.13 | ^0.14 | ^0.15 | ^0.16 | ^0.17 | ^0.18 | ^0.19 | ^0.20 | ^0.21 | ^0.22 | ^0.23 | ^0.24 | ^0.25 | ^0.26 | ^0.27
• phpstan/phpstan: ^0.9 | ^0.10 | ^0.11 | ^0.12 | ^1.0
• phpunit/phpunit: ~4.8 | ^5.0 | ^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0
• squizlabs/php_codesniffer: ^3.8.0

MIT

• Tim Chandler

• static methods

README

code-distortion/staticall is a package for that lets you call methods statically and non-statically.

Installation

Install the package via composer:

composer require code-distortion/staticall

Usage

• Include the Staticall trait in your class
• Add methods to your class, with the prefix staticall

<?php

use CodeDistortion\Staticall\Staticall; // <<<

class MyClass
{
    use Staticall; // <<<

    private function staticallMyMethod(): string // <<<
    {
        return 'hello';
    }
}

MyClass::myMethod(); // "hello"

// is equivalent to

$myObject = new MyClass();
$myObject->myMethod(); // "hello"

When a method is called statically like this, Staticall will instantiate the class first, and call the method against that.

This is useful for classes that have optional methods for chaining and any of the methods can be called first.

MyEmail::recipient('Bob', '[e-mail]')->send();
MyEmail::attach('file.zip')->recipient('Bob', '[e-mail]')->send();

Note: Because Staticall calls your constructor automatically, the constructor must not have any required parameters.

Note: Staticall makes the methods it finds accessible publicly.

You can change the prefix Staticall uses by adding static property $staticallPrefix to your class:

<?php

use CodeDistortion\Staticall\Staticall;

class MyClass
{
    use Staticall;

    protected static string $staticallPrefix = 'xyz'; // <<<

    private function xyzMyMethod(): string // <<<
    {
        return 'hello';
    }
}

Testing This Package

• Clone this package: git clone https://github.com/code-distortion/staticall.git .
• Run composer install to install dependencies
• Run the tests: composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

SemVer

This library uses SemVer 2.0.0 versioning. This means that changes to X indicate a breaking change: 0.0.X, 0.X.y, X.y.z. When this library changes to version 1.0.0, 2.0.0 and so forth, it doesn't indicate that it's necessarily a notable release, it simply indicates that the changes were breaking.

Treeware

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Contributing

Please see CONTRIBUTING for details.

Code of Conduct

Please see CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Tim Chandler

License

The MIT License (MIT). Please see License File for more information.