functional-php/named-parameters

Named parameters for functions, methods and constructors.

Maintainers

Details

github.com/functional-php/named-parameters

Source

Issues

Installs: 4 770

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 0

Open Issues: 0

0.0.2 2019-03-18 16:33 UTC

Requires

  • php: >=7.1.0

Requires (Dev)

BSD-3-Clause 28cd160de927b7d877b615115ee4c5d0c6130948

  • Gilles Crettenand <gilles.woop@crettenand.info>

functionmethodsconstructorsnamed-parameters

This package is auto-updated.

Last update: 2024-12-19 10:55:55 UTC

README

Build Status Scrutinizer Code Quality Code Coverage Average time to resolve an issue Percentage of issues still open Chat on Gitter

It is often useful to be able to call a function or methods using named parameters. For example to only pass a different value for the nth default parameter.

PHP does not allow to do that, this library ought to change that.

Installation

composer require functional-php/named-parameters

Basic Usage

Say you have the following function:

function return_array($a, $b, $c) {
    return [$a, $b, $c];
}

Any of the following call is equivalent:

use function FunctionalPHP\NamedParameters\call_user_func_array_np;

// traditional call with positional arguments
call_user_func_array_np('return_array', [1, 2, 3]);

// named arguments in the correct order
call_user_func_array_np('return_array', ['a' => 1, 'b' => 2, 'c' => 3]);

// named arguments in random order
call_user_func_array_np('return_array', ['c' => 3, 'a' => 1, 'b' => 2]);
call_user_func_array_np('return_array', ['c' => 3, 'b' => 2, 'a' => 1]);

Testing

You can run the test suite for the library using:

composer test

A test report will be available in the reports directory.

Contributing

Any contribution welcome :

  • Ideas
  • Pull requests
  • Issues

Inspiration