rfc:closures_in_const_expr

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
rfc:closures_in_const_expr [2024/10/25 10:11] – timwollarfc:closures_in_const_expr [2024/11/13 13:35] (current) – Voting timwolla
Line 2: Line 2:
   * Version: 1.0   * Version: 1.0
   * Date: 2024-10-24   * Date: 2024-10-24
-  * Author: Tim Düsterhus, tim@tideways-gmbh.com +  * Author: Tim Düsterhus (tim@tideways-gmbh.com), Volker Dusch (volker@tideways-gmbh.com) 
-  * Status: Draft+  * Status: In Voting
   * First Published at: https://wiki.php.net/rfc/closures_in_const_expr   * First Published at: https://wiki.php.net/rfc/closures_in_const_expr
  
Line 11: Line 11:
  
 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 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 ===== ===== Proposal =====
Line 17: Line 45:
  
   * Attribute parameters.   * Attribute parameters.
-  * Default values of properties, parameters, and static variables.+  * Default values of properties and parameters.
   * Constants and Class Constants.   * Constants and Class Constants.
- 
-The primary use case is making Closures legal within attribute parameters, the other constructs restricted to constant expressions will implicitly work and this RFC makes no effort to arbitrarily limit Closures to attribute parameters only. 
  
 ==== Constraints ==== ==== Constraints ====
Line 26: Line 52:
 If Closures are placed in constant expressions they are subject to the following constraints: If Closures are placed in constant expressions they are subject to the following constraints:
  
-  * They must not include variables from the surrounding scope using <php>use($foo, $bar)</php>, because except for constants and static variables 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 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.+  * 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 ==== ==== Scoping ====
Line 64: Line 92:
 </PHP> </PHP>
  
-Passing a Closure to a new expression:+Passing a Closure to a <php>new</php>-expression:
  
 <PHP> <PHP>
Line 79: Line 107:
 </PHP> </PHP>
  
-==== Use Cases ====+===== Use Cases =====
  
 Custom field validation for an attribute-based object validation library: Custom field validation for an attribute-based object validation library:
Line 105: Line 133:
         }         }
     })]     })]
-    public function testSubtraction(int $minuend, float $subtrahend, int $result)+    public function testSubtraction(int $minuend, int $subtrahend, int $result)
     {     {
         \assert(Calculator::subtract($minuend, $subtrahend) === $result);         \assert(Calculator::subtract($minuend, $subtrahend) === $result);
Line 112: Line 140:
 </PHP> </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 ===== ===== Backward Incompatible Changes =====
Line 157: Line 198:
   * Support non-static Closures.   * Support non-static Closures.
   * Support first-class callables.   * Support first-class callables.
 +  * Support variable capturing if/when variables may appear in constant expressions.
  
 ===== Proposed Voting Choices ===== ===== Proposed Voting Choices =====
  
-<doodle title="Support Closures in constant expressions as proposed?" auth="timwolla" voteType="single" closed="true" closeon="2024-06-05T08:00:00Z">+<doodle title="Support Closures in constant expressions as proposed?" auth="timwolla" voteType="single" closed="false" closeon="2024-11-27T14:00:00Z">
    * Yes    * Yes
    * No    * No
rfc/closures_in_const_expr.1729851060.txt.gz · Last modified: 2024/10/25 10:11 by timwolla

Page Tools