Zend Framework

• Type: Coding Standards Violation
• Status: Resolved
• Priority: Trivial
• Resolution: Not an Issue
• Affects Version/s: 0.2.0
• Fix Version/s: Next Minor Release
• Component/s: None
• Labels:

  None

Ralph Schindler proposed a series of class member organizational conventions that we can adopt for improving the readability and consistency of the framework code base. I've modified them slightly for clarity and to include others' responses to the mailing list thread:

http://www.nabble.com/Class-member-orgainizational-conventions-tf2508874s16154.html#a6996153

1. Properties should appear at the top of the class definition followed by methods.
2. Class members (both properties and methods) should be organized by visibility: public first, protected second, and private last.
3. Special methods such as __construct(), __destruct(), __clone(), __sleep(), __wakeup(), __get(), __set(), __isset(), __isset(), __unset(), __call(), __toString(), and __set_state() should appear first in the list of methods, in the order presented here, as needed by the class.
4. Static methods should be listed before instance methods.
5. Static methods should have the visibility written first, as illustrated in the php manual at http://php.net/manual/en/language.oop5.static.php:

   public static $myStatic = 'foo';
   public static function aStaticMethod()
   {}

6. Finally, methods should be grouped logically by execution order, developer need, etc., where appropriate. For example: setOptions() appears before start(), which appears before stop(), since this is the most logical order of usage.

• Assignee:

  Ralph Schindler

  Reporter:

  Darby Felton

• Created:

  07/Nov/06 7:46 PM

  Updated:

  17/Feb/11 1:01 PM

  Resolved:

  17/Feb/11 1:01 PM