sevavietl/overloaded-function

Function overloading wrapper for php.

dev-master 2019-03-09 20:27 UTC

Requires

• php: >=7.2
• thorough-php/type-guard: ^1.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpstan/phpstan: ^0.10.3
• phpunit/phpunit: ^6.3

MIT

• sevavietl

• php
• function
• overloading

README

PHP actually does not support function overloading, as functions distinguished but name only. This is a class that helps to imulate function overloading in PHP.

Table of Contents

• General usage
  • 1. Simple signature
  • 2. Union types
  • 3. Intersection types
  • 4. Typed arrays
  • 5. Optional parameters

General usage

Function cases provided as an array of callables, where key is a signature of parameters types.

1. Simple signature:

Parameters signature is a list of types separeted by comma.

    $func = new OverloadedFunction([
        'integer, integer' => function ($a, $b) { return $a + $b; },
        'string, string' => function ($a, $b) { return $a . $b; }
    ]);

    var_dump($func(1, 1)) // => 2
    var_dump($func('1', '1')) // => '11'

2. Union types:

Sometimes your parameter need to be of a kind, that implements not one interface, but several.

    $func = new OverloadedFunction([
        'ArrayAccess&Countable' => function ($i) { return true; }
    ]);

    var_dump($func(new ArrayIterator)) // => bool(true)

3. Intersection types:

Sometimes you allow parameter to be not of one type, but of several types.

    $func = new OverloadedFunction([
        'string|integer' => function ($i) { return true; }
    ]);

    var_dump($func(1)) // => bool(true)
    var_dump($func('1')) // => bool(true)

4. Typed arrays:

You can restrict your parameter to be an array of elements of certain types.

    $func = new OverloadedFunction([
        'integer[]' => function ($arr) { return 'integer'; },
        'integer|string[]' => function ($arr) { return 'mixed'; }
    ]);

    var_dump($func([1, 2, 3])) // => string(7) "integer"
    var_dump($func([1, 2, '3'])) // => string(5) "mixed"

5. Optional parameters:

Sometimes you allow parameter to be optional. Make sure you provide default values for such cases.

    $func = new OverloadedFunction([
        '?integer' => function ($i = 1) { return $i; }
    ]);

    var_dump($func(1)) // => bool(true)
    var_dump($func()) // => bool(true)