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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
rfc:code_free_constructor [2019/01/23 14:15]
rfc:code_free_constructor [2019/01/29 12:17] (current)
Line 1: Line 1:
 ====== PHP RFC: Code free constructor ====== ====== PHP RFC: Code free constructor ======
-  * Version: 0.1 +  * Version: 0.2 
-  * Date: 2019-01-14+  * Date: 2019-01-29
   * Author: Andrey Gromov, andrewgrom@rambler.ru, rjhdby@php.net   * Author: Andrey Gromov, andrewgrom@rambler.ru, rjhdby@php.net
   * Proposed version: PHP 8   * Proposed version: PHP 8
   * Status: draft   * Status: draft
   * First Published at: https://wiki.php.net/rfc/code_free_constructor   * First Published at: https://wiki.php.net/rfc/code_free_constructor
-  * ML thread: -+  * ML thread: https://externals.io/message/103793 
 +===== Changelog ===== 
 +**v 0.2**  
 +  * Added visibility modificators syntax. 
 +  * Changed behavior for parameters that need to be forwarded to parent. 
 +  * Added "anonymous class" section. 
 +  * Added "Q&A, Discussion" section. 
 +  * Improved description of realization.
 ===== Introduction ===== ===== Introduction =====
Line 20: Line 28:
 ===== Proposal ===== ===== Proposal =====
 Proposal is to add alternate syntax for "code free" constructors. Proposal is to add alternate syntax for "code free" constructors.
 +There is two generals parts of proposal.
 +=== First. Automatic property initialization ===
 Current syntax: Current syntax:
 <code php> <code php>
 class MotorCycle { class MotorCycle {
-    public $vendor; +    protected $vendor; 
-    public $cc+    public $driver
-    public $whells = 2;+    private int $cc;
-    public function __construct($vendor, $cc) {+    public function __construct(string $vendor, Person $driver, int $cc = 600) {
         $this->vendor = $vendor;         $this->vendor = $vendor;
 +        $this->driver = $driver;
         $this->cc     = $cc;         $this->cc     = $cc;
     }     }
-    //other methods 
 } }
 +Proposed syntax:
 +<code php>
 +class MotorCycle(protected string $vendor, Person $driver, private int $cc = 600){ };
 +If no visibility modifier defined it casts as "public".
 +Under the hood, at AST-creation phase, will be silently created right properties declaration and added "_ _ construct" method similar to showed above. So following compilation and runtime will work standard way.
 +=== Second. Automatic passing args to parent constructor ===
 +For this example I will use class "MotorCycle" from previous section.
 +Current syntax:
 +<code php>
 class MyCustomMotorCycle extends MotorCycle { class MyCustomMotorCycle extends MotorCycle {
-    public function __construct($cc, $whells) { +    public $passenger; 
-        parent::__construct("Custom", $cc); +     
-     // $this->cc = $cc;  this statement will be added within proposed realisation +    public function __construct(Person $driverPerson $passenger) { 
-        $this->whells = $whells;+        parent::__construct("Custom", $driver); 
 +        $this->passenger = $passenger;
     }     }
 } }
Line 47: Line 73:
 Proposed syntax: Proposed syntax:
 <code php> <code php>
-class MotorCycle($vendor, $cc){ +class MyCustomMotorCycle(Person $driverPerson $passenger)  
-    public $whells = 2; +    extends MotorCycle("Custom", $driver) { };
-     +
-    //other methods +
-}; +
- +
-class MyCustomMotorCycle($cc, $whells) extends MotorCycle("Custom", $cc){ };+
 </code> </code>
 +In this case, if some params must be forwarded to parent then they will not be declared and set in child. This behavior is disputable.
-By the way, current realization simply add "_ _construct" method into class via AST injection.  +Realisation is similar to described above with additional checks and parent call.
-Another words, code "($cc, $whells)" considered  as zend_ast node "parameter_list" and accordingly processed by standart way. You can declare property type like you declare them inside standard method. Also you can declare defaults for parameters, use "..." notation (there is a nuance) and do everything else.+
-<code php> +Note that you can use all standard syntax constructions like default parameters and splat operator ("...")
-class MyCustomMotorCycle(int $cc, int $whells = 3, ...$otherParams) extends MotorCycle("Custom", $cc){ }; +
-===== Restrictions ===== +{{:rfc:joined.png?400|}}
-This syntax can't be used with anonymous classes because those classes instantiated at once they declared and same syntax is used for forwarding parameters directly into constructor.+
-===== Possible Issue =====+===== Anonymous classes ===== 
 +Since the syntax for declaring an anonymous class is what it is, the only option that I can imagine is not very beautiful.
-Child constructor will silently rewrite parent's properties with same name. 
 <code php> <code php>
-class Parent+$a = new class($mDriver, $mPassenger) extends MotorCycle { 
-    public function __construct($prop){ +    private $passenger; 
-        $this->prop = $prop * 2;+    public function __construct(Person $driver, Person $passenger) { 
 +        parent::__construct("Custom", $driver); 
 +        $this->passenger = $passenger;
     }     }
-class Child($prop) extends Parent($prop) {};+
-$child = new Child(5); +//            |------arguments------||-----------constructor params------------| 
- +$a = new class($mDriver, $mPassenger)(Person $driver, private Person $passenger)  
-var_dump($child); +        extends MotorCycle("Custom", $driver){};
- +
----------------- +
- +
-object(Child{ +
-    ["prop"] => 5 // instead expected 10 +
 </code> </code>
 ===== Backward Incompatible Changes ===== ===== Backward Incompatible Changes =====
Line 97: Line 112:
 Not thinking so Not thinking so
-===== Future Scope =====+===== Implementation =====
-Maybe simplified "destructuring declaration" for those class types? Not sure.+Draft implementation, need to be reviewed**Outdated!** 
-<code php> +===== Q&A, Discussion ===== 
-class A($first, $second) {}; +**Stanislav Malyshev**<blockquote>This looks like unobvious magic. PHP approach has traditionally been to avoid unobvious magic, and be explicit about what is happening. This functionality does not seem no be enabling anything different, and seems to be pretty obscure as to what is going on. Also, $prop can not be documented this way, and assigning default value to it may be bit weird too. I am all for paving the walkways, but this particular case seems to be a bit too narrow to have a special language syntax for, and the syntax seems to be not exactly obvious as to what's going on there.</blockquote>
-$a new A(1,2); +
-[$first, $second] = $a+
-===== Implementation ===== +**Nikita Popov**<blockquote>Two alternatives you might want to consider: 
-Implemented via injecting generated "__construct"'s ast node into class statements listSo it will be compiled with all checks.+ 
 +=> Proposed function public function _ _ construct(int $this->x, int $this->y) {}, which avoids the need for explicit property assignments in the ctorHowever, the property still needs to be declared separately.
-Draft implementation, need to be reviewed. +https://docs.hhvm.com/hack/other-features/constructor-parameter-promotion 
-https://github.com/php/php-src/compare/master...rjhdby:constructor+=> Uses public function _ _ construct(public int $x, public int $y) {} to declare properties in-line in the constructor.
 +I think that *if* we want to add some kind of sugar of this type, then I'd strongly prefer the syntax used by Hack than the one proposed here. It makes a lot more sense to me intuitively, probably because the property declarations still looks like normal property declarations, they just occur in-line in the ctor.</blockquote>
 +A matter of habit and documentation. There is a lot of really strange and magical behavior in the language. It seems to me that the proposed concept is quite simple and transparent for understanding. IMHO this syntax make behavior more strict. No need to 
 +read constructor's body, because you know exactly what's going on.
 ===== References ===== ===== References =====
rfc/code_free_constructor.1548252938.txt.gz · Last modified: 2019/01/23 14:15 by rjhdby