astrotomic/php-conditional-proxy

This package provides a trait and class to allow calling methods based on a condition without breaking the method chain.

0.2.0 2020-06-12 21:13 UTC

README

Latest Version MIT License Offset Earth Larabelles

GitHub Workflow Status StyleCI Total Downloads

This package provides a trait and class to allow calling methods based on a condition without breaking the method chain. This is useful if you want to call a method only if the variable you insert has a value.

Installation

You can install the package via composer:

composer require astrotomic/php-conditional-proxy

Usage

The easiest will be to use the \Astrotomic\ConditionalProxy\HasConditionalCalls trait which adds a when() method. The \Astrotomic\ConditionalProxy\ConditionalProxy is made to work with methods returning $this because otherwise you can get unexpected results and wrong code-completion.

use Astrotomic\ConditionalProxy\HasConditionalCalls;

class MyClass
{
    use HasConditionalCalls;
}

Conditional chained Method

You can call the when() method by only passing the condition and chain the method to call if the condition is true.

// foo() bar() baz() will be called
$class->foo()->when(true)->bar()->baz();

// foo() baz() will be called
$class->foo()->when(false)->bar()->baz();

Conditional Callback

If you want you can also pass a callback as second parameter to the when() method.

// foo() bar() baz() will be called
$class->foo()->when(true, fn($self) => $self->bar())->baz();

// foo() baz() will be called
$class->foo()->when(false, fn($self) => $self->bar())->baz();

Advanced Usage

If you already have an if() or when() method and want to advance it or implement this behavior in any other method you can initialize and return the \Astrotomic\ConditionalProxy\ConditionalProxy yourself.

use Astrotomic\ConditionalProxy\ConditionalProxy;

class MyClass
{
    public function if($condition)
    {
        return new ConditionalProxy($this, $condition);
    }

    public function foo($foo)
    {
        $this->foo = $foo;

        return $this;
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

License

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

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth