rfc:propertygetsetsyntax

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:propertygetsetsyntax [2010/04/25 01:32] – Added an example of property methods being marked final individually. lieutenantclonerfc:propertygetsetsyntax [2017/09/22 13:28] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Request for Comments: Property get/set syntax ====== ====== Request for Comments: Property get/set syntax ======
-  * Version: 0.1+  * Version: 0.3
   * Date: 2009-09-13   * Date: 2009-09-13
   * Author: Dennis Robinson <president at basnetworks dot net>   * Author: Dennis Robinson <president at basnetworks dot net>
Line 176: Line 176:
 echo $time->Hours;// Outputs 12 echo $time->Hours;// Outputs 12
 </code> </code>
 +
 +Note that "get" and "set" as seen above would become new keywords.  Alternatively, "get" and "set" could be made to only have meaning if they are in a prototype, similar to the current type hinting syntax that exists in php-trunk.
  
 **__Alternative Syntax__** **__Alternative Syntax__**
Line 192: Line 194:
         get { return $this->seconds / 3600; }         get { return $this->seconds / 3600; }
         set { $this->seconds = $value * 3600; }// The variable $value holds the incoming value to be "set"         set { $this->seconds = $value * 3600; }// The variable $value holds the incoming value to be "set"
-    }+    };// Note the semi-colon here
 }; };
 +</code>
 +
 +In this syntax, a semi-colon exists at the end of the property definition.  This was suggested by Kalle Nielsen, as it would be simpler to implement into the current implementation of class members in the PHP interpreter.
 +
 +**__Alternative Syntax Suggested By jbondc__**
 +
 +<code php>
 +property Hours {
 + get { return $this->seconds / 3600; }
 + set { $this->seconds = $value * 3600; } // The variable $value holds the incoming value to be "set"
 +}
 +
 +class TimePeriod
 +{
 +    private $seconds;
 +
 +    public [Hours] $hours;
 +}
 +</code>
 +
 +This syntax would favor re-use similar to traits by injecting the set/get code.
 +
 +The implementation would add the keywords 'property', _PROPERTY_, the '[', ']' tokens and the 'readonly' property as part of Spl.
 +
 +A read-only property could be defined in the following ways:
 +
 +<code php>
 +// Spl property
 +property readonly  {
 +    final set { throw Exception(__PROPERTY__ . " is read-only."); }
 +}
 +
 +// Read-only property #1
 +property MyHours1 extends Hours  {
 +     use readonly;
 +}
 +
 +// Read-only property #2
 +property MyHours2 extends Hours  {
 + set { throw Exception(__PROPERTY__ . " is read-only."); }
 +}
 +
 +// Read-only property #3 (if you don't want an exception)
 +property MyHours3 extends Hours  {
 + set { trigger_error(__PROPERTY__ . " is read-only.", E_USER_ERROR); }
 +}
 +</code>
 +
 +Another approach, to reserve the '[', ']' tokens for annotations or something else could be:
 +
 +<code php>
 +// property as some kind of trait
 +class TimePeriod
 +{
 +    private $seconds;
 +
 +    public {use Hours;} $hours;
 +}
 </code> </code>
  
Line 214: Line 274:
     public property Minutes     public property Minutes
     {     {
-        set { $this->minutes = $value * 60; }+        set { $this->seconds = $value * 60; }
     }     }
 }; };
Line 444: Line 504:
 echo TimePeriod::$Hours;// Outputs 12 echo TimePeriod::$Hours;// Outputs 12
 </code> </code>
 +
 +===== Implementation =====
 +
 +An implementation of this proposal is being worked on by Clint Priest <phpdev at zerocue dot com> Information about implementation details can be found here: https://wiki.php.net/rfc/propertygetsetsyntax-as-implemented
  
 ===== References ===== ===== References =====
Line 457: Line 521:
   * [[http://msdn.microsoft.com/en-us/library/x9fsa0sw%28VS.80%29.aspx|Properties (C# Programming Guide)]]   * [[http://msdn.microsoft.com/en-us/library/x9fsa0sw%28VS.80%29.aspx|Properties (C# Programming Guide)]]
   * [[http://msdn.microsoft.com/en-us/library/75e8y5dd%28VS.80%29.aspx|Asymmetric Accessor Accessibility (C# Programming Guide)]]   * [[http://msdn.microsoft.com/en-us/library/75e8y5dd%28VS.80%29.aspx|Asymmetric Accessor Accessibility (C# Programming Guide)]]
 +  * [[http://msdn.microsoft.com/en-us/library/ms229054.aspx|Choosing Between Properties and Methods (MSDN)]]
 +  * [[http://msdn.microsoft.com/en-us/library/ms229006.aspx|Property Design (MSDN)]]
 +  * [[http://c2.com/cgi/wiki?UniformAccessPrinciple|Uniform Access Principle (C2 wiki)]]
 +  * [[http://en.wikipedia.org/wiki/Uniform_access_principle|Uniform Access Principle (Wikipedia)]]
  
 ===== Changelog ===== ===== Changelog =====
Line 470: Line 538:
   - 2010-04-24 Dennis Robinson: Added an alternative syntax.   - 2010-04-24 Dennis Robinson: Added an alternative syntax.
   - 2010-04-24 Dennis Robinson: Added an example of property methods being marked final individually.   - 2010-04-24 Dennis Robinson: Added an example of property methods being marked final individually.
 +  - 2010-11-13 Dennis Robinson: Added a note below the basic syntax about new keywords being created. 
 +  - 2010-11-13 Dennis Robinson: Added a semicolon to the "alternative syntax", as suggested by Kalle Nielsen. 
 +  - 2010-11-29 jbondc: Added another alternative syntax 
 +  - 2010-12-01 Dennis Robinson: Added additional links in the "Further Reading" section 
 +  - 2011-12-22 Dennis Robinson: Added "Implementation" section
rfc/propertygetsetsyntax.1272159147.txt.gz · Last modified: 2017/09/22 13:28 (external edit)