Funkcje anonimowe i domknięcia w PHP: słowo kluczowe use

Funkcja anonimowa, nazywana też domknięciem (closure), to funkcja bez nazwy. Piszesz function ($param) { ... } tam, gdzie oczekiwana jest wartość: przypisujesz ją do zmiennej, przekazujesz do innej funkcji albo zwracasz. Może przenosić zmienne z otaczającego kodu przez use ($var).

<?php
$greet = function (string $name): string {
    return "Hello, $name";
};   // the semicolon ends the assignment

echo $greet('Ada'), "\n";

$greeting = 'Welcome';
$welcome = function (string $name) use ($greeting): string {
    return "$greeting, $name";
};
echo $welcome('Linus'), "\n";

var_dump($greet instanceof Closure);

Każda funkcja anonimowa jest obiektem wbudowanej klasy Closure, dlatego można ją zapisać, przekazywać i wywołać później przez $greet(...).

Słowo kluczowe use przechwytuje przez wartość

Domknięcie samo nie widzi zmiennych z zewnątrz. use ($x) kopiuje wartość $x do domknięcia w chwili jego utworzenia, a nie wtedy, gdy się wykonuje:

<?php
$discount = 10;

$apply = function (float $price) use ($discount): float {
    return $price - $discount;
};

$discount = 50;            // changed after the closure was created
echo $apply(100), "\n";    // still uses 10

// Several variables
$currency = 'EUR';
$rate = 1.08;
$convert = function (float $usd) use ($rate, $currency): string {
    return number_format($usd / $rate, 2) . " $currency";
};
echo $convert(54), "\n";

use przez referencję: &$var

use (&$x) daje domknięciu samą zmienną, a nie kopię. Zmiany wewnątrz domknięcia są widoczne na zewnątrz, a zmiany na zewnątrz są widoczne wewnątrz. Tak callback dodaje do sumy albo prowadzi licznik.

<?php
$total = 0;
$addToTotal = function (int $amount) use (&$total): void {
    $total += $amount;
};

$addToTotal(10);
$addToTotal(32);
echo $total, "\n";

// A counter that remembers its state between calls
function makeCounter(): Closure
{
    $count = 0;
    return function () use (&$count): int {
        return ++$count;
    };
}

$next = makeCounter();
echo $next(), $next(), $next(), "\n";

$other = makeCounter();     // its own $count
echo $other(), "\n";

Każde wywołanie makeCounter() tworzy nowe $count, a zwrócone domknięcie utrzymuje je przy życiu po zakończeniu funkcji. Właśnie do tego odnosi się nazwa „domknięcie”: funkcja domyka się nad zmiennymi, których potrzebuje.

Domknięcie jako callback

Funkcje takie jak array_map(), array_filter(), usort() i array_walk() przyjmują funkcję jako argument. Domknięcie pozwala napisać ją w miejscu, z tyloma instrukcjami, ile wymaga zadanie:

<?php
$products = [
    ['name' => 'Laptop', 'price' => 1200, 'stock' => 3],
    ['name' => 'Mouse', 'price' => 25, 'stock' => 0],
    ['name' => 'Monitor', 'price' => 300, 'stock' => 7],
];

$minPrice = 100;
$available = array_filter($products, function ($p) use ($minPrice) {
    return $p['stock'] > 0 && $p['price'] >= $minPrice;
});

usort($available, function ($a, $b) {
    return $b['price'] <=> $a['price'];   // most expensive first
});

$labels = array_map(function ($p) {
    $label = strtoupper($p['name']);
    return "$label ({$p['stock']} left)";
}, $available);

print_r($labels);

Gdy treść to jedno wyrażenie, funkcja strzałkowa, taka jak fn($p) => $p['price'], jest krótsza i nie potrzebuje use.

Callable: nazwy funkcji, metody i strlen(...)

Parametr z typem callable przyjmuje więcej niż domknięcia. Liczy się string z nazwą funkcji, tablica z obiektem i nazwą metody oraz tablica z nazwą klasy i nazwą metody statycznej. Od PHP 8.1 składnia first-class callable strlen(...) zamienia każde z nich bezpośrednio w Closure.

<?php
class Formatter
{
    public function shout(string $s): string { return strtoupper($s) . '!'; }
    public static function whisper(string $s): string { return strtolower($s) . '...'; }
}

$words = ['Hello', 'World'];
$f = new Formatter();

print_r(array_map('strtoupper', $words));                   // function name
print_r(array_map([$f, 'shout'], $words));                  // object method
print_r(array_map([Formatter::class, 'whisper'], $words));  // static method

// PHP 8.1 first-class callable syntax
$len = strlen(...);
$shout = $f->shout(...);
$whisper = Formatter::whisper(...);
echo $len('closure'), ' ', $shout('hey'), ' ', $whisper('PSST'), "\n";

function apply(callable $fn, string $value): string
{
    return $fn($value);
}
echo apply('ucfirst', 'php'), "\n";
var_dump(is_callable('no_such_function'));

Forma (...) jest sprawdzana w chwili wykonania linii: literówka od razu rzuca Error. String taki jak 'strtoupr' jest tylko stringiem, dopóki ktoś nie spróbuje go wywołać.

Domknięcia w klasie: $this i static

Domknięcie utworzone wewnątrz metody ma automatycznie powiązane $this, więc może używać właściwości obiektu. Oznacz je jako static function, gdy nie potrzebuje $this; dzięki temu nie utrzymuje też obiektu przy życiu.

<?php
class Cart
{
    private array $items = [];
    private float $taxRate = 0.2;

    public function add(string $name, float $price): void
    {
        $this->items[$name] = $price;
    }

    public function pricesWithTax(): array
    {
        // $this is available inside the closure
        return array_map(function (float $price): float {
            return round($price * (1 + $this->taxRate), 2);
        }, $this->items);
    }

    public function names(): array
    {
        return array_map(static function (string $name): string {
            return ucfirst($name);
        }, array_keys($this->items));
    }
}

$cart = new Cart();
$cart->add('book', 12.5);
$cart->add('pen', 1.99);
print_r($cart->pricesWithTax());
print_r($cart->names());

Zapomniane use

Najczęstszy błąd z domknięciami to użycie zmiennej z zewnątrz bez wymienienia jej w use. Wewnątrz domknięcia ta zmienna nie istnieje:

$minAge = 18;
$adults = array_filter($people, function ($p) {
    return $p['age'] >= $minAge;   // $minAge is not in use (...)
});

PHP prints: Warning: Undefined variable $minAge

$minAge ma w środku wartość null, każdy wiek porównany przez >= null daje true i każda osoba przechodzi przez filtr. Na serwerze ukrywającym ostrzeżenia nic ci o tym nie powie. Dodaj zmienną do use:

<?php
$people = [['name' => 'Ada', 'age' => 36], ['name' => 'Tom', 'age' => 12]];
$minAge = 18;

$adults = array_filter($people, function ($p) use ($minAge) {
    return $p['age'] >= $minAge;
});
print_r(array_column($adults, 'name'));

// Or an arrow function, which captures $minAge automatically
$adults2 = array_filter($people, fn($p) => $p['age'] >= $minAge);
print_r(array_column($adults2, 'name'));