PHP: rfc:closures_in_const_expr

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== PHP RFC: Support Closures in constant expressions ======
  * Version: 1.0
  * Date: 2024-10-24
  * Author: Tim Düsterhus (tim@tideways-gmbh.com), Volker Dusch (volker@tideways-gmbh.com)
  * Status: Implemented
  * Target Version: PHP 8.5
  * Implementation: https://github.com/php/php-src/commit/f6a0bb4d0442d2780c61d32d01c117024eccab57
  * First Published at: https://wiki.php.net/rfc/closures_in_const_expr

===== Introduction =====

Several PHP constructs are limited to accept “constant expressions” only. These expressions may only contain a limited number of operations that can roughly be summarized as “immutable values”. Notably attribute parameters are a construct that only accepts constant expressions and Closures are not currently part of the set of allowed operations in constant expressions.

As Closures are effectively just PHP source code (or rather: PHP Opcodes) they are an immutable value (when limiting some of the features) and as such there is no fundamental reason why they should not be allowed within constant expressions. And indeed there are some use cases that would be enabled by allowing Closures to appear in constant expressions.

As an example, it would enable a userland definition of <php>array_filter()</php> with the default filter callback that checks for emptiness, without needing to make the callback parameter nullable:

<PHP>
<?php

function my_array_filter(
    array $array,
    Closure $callback = static function ($item) { return !empty($item); },
) {
    $result = [];

    foreach ($array as $item) {
        if ($callback($item)) {
            $result[] = $item;
        }
    }

    return $result;
}

var_dump(my_array_filter([
    0, 1, 2,
    '', 'foo', 'bar',
]));

?>
</PHP>

===== Proposal =====

This RFC proposes that it shall be legal to include Closures in constant expressions. This includes:

  * Attribute parameters.
  * Default values of properties and parameters.
  * Constants and Class Constants.

==== Constraints ====

If Closures are placed in constant expressions they are subject to the following constraints:

  * They may not include variables from the surrounding scope using <php>use($foo, $bar)</php>, because except for constants and possibly for default parameter values there is no surrounding scope. This also means that short closures (arrow functions) are not supported, because they perform implicit capturing. This constraint is consistent with how variables may not be part of a constant expression.
  * They must be <php>static</php> (and thus they must not access <php>$this</php>). Semantically <php>$this</php> would only be well-defined for property default values and possibly attribute parameters, but this would require reevaluating the Closure for each object / attribute instance, which would be different to existing constant expressions which are only evaluated once. This constraint is consistent with how <php>new</php>-expressions may not be used in property default values.

Both of these constraints will be verified at compile time.

==== Scoping ====

As with other constant-expressions, Closures defined in constant expressions follow the expected scoping rules of the context they are placed in. This means that Closures in property default values //may// access <php>private</php> properties, methods, and class constants of the class where they are defined, similarly to how a Closure defined in the constructor and stored in a property may access those private members. Likewise are Closures in attribute parameters allowed to access private members of the surrounding class.

==== Closures in sub-expressions ====

Closures behave like any other operation within a constant expression, thus they may be part of a sub-expression of another operation. While it is not particularly useful to use Closures as an operand to mathematical expressions, it will also not break anything.

However the following operations are examples of how Closures can usefully be included in sub-expressions.

Defining a list of Closures in a default parameter:
<PHP>
<?php

function foo(
    string $input,
    array $callbacks = [
        static function ($value) {
            return \strtoupper($value);
        },
        static function ($value) {
            return \preg_replace('/[^A-Z]/', '', $value);
        },
    ]
) {
    foreach ($callbacks as $callback) {
        $input = $callback($input);
    }

    return $input;
}

var_dump(foo('Hello, World!')); // string(10) "HELLOWORLD"
</PHP>

Passing a Closure to a <php>new</php>-expression:

<PHP>
<?php

class MyObject
{
    public function __construct(private Closure $callback) {}
}

const Foo = new MyObject(static function () {
    return 'foo';
});
</PHP>

===== Use Cases =====

Custom field validation for an attribute-based object validation library:

<PHP>
final class Locale
{
    #[Validator\Custom(static function (string $languageCode): bool {
        return \preg_match('/^[a-z][a-z]$/', $languageCode);
    })]
    public string $languageCode;
}
</PHP>

Testcase generation for a testing library:

<PHP>
final class CalculatorTest
{
    #[Test\CaseGenerator(static function (): iterable {
        for ($i = -10; $i <= 10; $i++) {
            yield [$i, $i, 0];
            yield [$i, 0, $i];
            yield [0, $i, ($i * -1)];
        }
    })]
    public function testSubtraction(int $minuend, int $subtrahend, int $result)
    {
        \assert(Calculator::subtract($minuend, $subtrahend) === $result);
    }
}
</PHP>

Custom formatting for an attribute-based serialization library:

<PHP>
final class LogEntry
{
     public string $message;
     
     #[Serialize\Custom(static function (string $severity): string {
         return \strtoupper($severity);
     })]
     public string $severity;
}
</PHP>

===== Backward Incompatible Changes =====

None. Placing Closures into constant-expressions previously resulted in a compile-time error.

Nevertheless, as with every RFC that changes what previously was a compile-time error to be valid PHP code, this RFC requires changes to static analyzers and IDEs to correctly understand the semantics of the code and not erroneously report errors.

===== Proposed PHP Version(s) =====

Next PHP 8.x (8.5).

===== RFC Impact =====

==== To SAPIs ====

None.

==== To Existing Extensions ====

None.

==== To Opcache ====

Opcache needs to be adjusted to correctly store Closures in constant expressions in SHM. The PoC PR includes the necessary Opcache changes and passes all tests with Opcache / JIT enabled.

==== New Constants ====

None.

==== php.ini Defaults ====

None.

===== Open Issues =====

n/a

===== Unaffected PHP Functionality =====

Only constant expression are affected by the change and only in a way that Closure objects may appear in places where they previously could not appear in (e.g. class constants).

===== Future Scope =====

  * Support non-static Closures.
  * Support first-class callables.
  * Support variable capturing if/when variables may appear in constant expressions.

===== Proposed Voting Choices =====

<doodle title="Support Closures in constant expressions as proposed?" auth="timwolla" voteType="single" closed="true" closeon="2024-11-27T14:00:00Z">
   * Yes
   * No
</doodle>

===== Patches and Tests =====

https://github.com/php/php-src/pull/16458

===== Implementation =====

https://github.com/php/php-src/commit/f6a0bb4d0442d2780c61d32d01c117024eccab57

===== References =====


  * https://github.com/php/php-src/pull/16458
  * [[rfc:new_in_initializers|RFC: New in initializers]]
  * https://github.com/php/php-src/issues/12139

===== Rejected Features =====

n/a
Page Tools
