関数の部分適用

部分適用は、PHP 8.6.0 以降で使えます。 関数やメソッドの呼び出しで引数の一部だけを渡し、残りはプレースホルダにすると、 関数は呼び出されず、プレースホルダにした引数を受け取る Closure が生成されます。 第一級callableを生成する記法 は、引数を 1 つも渡さない部分適用にあたります。 部分適用はこの記法を拡張したもので、呼び出し可能な式であれば何にでも使えます。 その式で呼び出される関数やメソッドは、Closure の生成時に決まります。

  • ? はちょうど 1 つの引数を表します。 このプレースホルダに対応する Closure の引数は、 元の関数の引数が省略可能であっても常に必須です。
  • ... は、残りの引数をすべて表します。 これらの引数のデフォルト値は保たれ、可変長引数もそのままです。 このプレースホルダは、引数の最後に 1 回しか書けません。

例1 部分適用

<?php
function volume(int $length, int $width, int $height): int
{
    return $length * $width * $height;
}

// "?" はちょうど 1 つの引数を表します
$closure = volume(2, ?, 4);
// static fn(int $width): int => volume(2, $width, 4) と同等です
var_dump($closure(3));

$closure = volume(?, 3, ?);
// static fn(int $length, int $height): int => volume($length, 3, $height) と同等です
var_dump($closure(2, 4));

// "..." は残りの引数をすべて表します
$closure = volume(2, ...);
// static fn(int $width, int $height): int => volume(2, $width, $height) と同等です
var_dump($closure(3, 4));

// 引数をすべて渡した場合、"..." は呼び出しを遅らせるだけです
$closure = volume(2, 3, 4, ...);
// static fn(): int => volume(2, 3, 4) と同等です
var_dump($closure());
?>

上の例の出力は以下となります。

int(24)
int(24)
int(24)
int(24)

パイプ演算子 に渡す、引数を 1 つだけ受け取る callable は、部分適用で手軽に作れます。

例2 |> と部分適用を組み合わせる

<?php
echo ' Hello  World '
    |> trim(...)
    |> str_replace(' ', '', ?)
    |> strtoupper(...)
    |> str_pad(?, 12, '*', STR_PAD_BOTH);
?>

上の例の出力は以下となります。

*HELLOWORLD*

Closure の引数の名前、型宣言、リファレンス渡しかどうかは、 元の関数のものを引き継ぎます。戻り値の型も同様です。 部分適用は、渡す引数自体が定数式であれば、定数式の中でも使えます。

名前付きプレースホルダ

引数は 名前付き引数 で渡すこともでき、プレースホルダにも name: ? のように名前を付けられます。 通常の呼び出しと同じく、これらは位置を指定した引数の後に書かなければなりません。 Closure の引数は名前付きプレースホルダを書いた順に並ぶので、 引数の順番を入れ替えられます。

例3 名前付きプレースホルダ

<?php
// クロージャの引数は $subject、$search の順になります
$remove = str_replace(subject: ?, search: ?, replace: '');

var_dump($remove('a-b-c', '-'));
?>

上の例の出力は以下となります。

string(3) "abc"

引数の評価

部分適用で渡した引数は、Closure の生成時に 1 回だけ評価され、 呼び出すたびに評価し直されることはありません。 同じ呼び出しを アロー関数 で包んだ場合とは、この点が異なります。アロー関数では、呼び出すたびに本体が評価されます。

例4 引数は Closure の生成時に評価される

<?php
function now(): string
{
    echo "now() called\n";
    return '12:00';
}

function greet(string $name, string $time): string
{
    return "Hello $name, it is $time\n";
}

$arrow = fn(string $name) => greet($name, now());
echo "Arrow function created\n";
echo $arrow('Alice');

$partial = greet(?, now());
echo "Partial application created\n";
echo $partial('Bob');
?>

上の例の出力は以下となります。

Arrow function created
now() called
Hello Alice, it is 12:00
now() called
Partial application created
Hello Bob, it is 12:00

余分な引数

... プレースホルダを使わない場合、 Closure を呼び出すときに、その引数の数を超えて渡した引数は無視されます。 使った場合は、元の関数に渡されます。 この違いが重要になるのは、Closure をコールバックとして受け取る関数が、 配列のキーなどを余分な引数としてコールバックに渡す場合です。 ... を使うと、それらの値は元の関数の省略可能な引数に渡されます。

例5 余分な引数は ... を使った場合のみ元の関数に渡される

<?php
function greet(string $name, string $greeting = 'Hello'): string
{
    return "$greeting $name\n";
}

// 2 番目の引数は無視されます
$closure = greet(?);
echo $closure('Alice', 'Goodbye');

// 2 番目の引数は greet() に渡されます
$closure = greet(?, ...);
echo $closure('Alice', 'Goodbye');
?>

上の例の出力は以下となります。

Hello Alice
Goodbye Alice

制限

  • new Foo() は呼び出しとは見なされないため、 部分適用によるオブジェクトの生成 (例: new Foo(1, ?)) はサポートされていません。
  • プレースホルダは、 nullsafe 演算子 と組み合わせて使えません。
  • プレースホルダは、 引数の展開 と組み合わせて使えません。
  • compact、extract、 func_get_args、get_defined_vars など、呼び出し元のスコープを調べる関数は部分適用できません。 Error がスローされます。

例6 コンパイルエラーになる不正な使い方

<?php
new Foo(1, ?);             // Cannot create Closure for new expression

$obj?->method(1, ?);       // Cannot combine nullsafe operator with Closure creation

foo(?, ...$array);         // Cannot combine partial application and unpacking

foo(..., ?);               // Variadic placeholder must be last
foo(a: 1, ?);              // Cannot use positional argument after named argument

渡した引数とプレースホルダの合計が、関数が受け取る引数の数と合わない場合、 Closure の生成時に ArgumentCountError がスローされます。