doc:todo:salathe

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
Last revisionBoth sides next revision
doc:todo:salathe [2010/04/07 09:20] – Broken link to spl.iterators salathedoc:todo:salathe [2011/04/06 10:59] – external edit 127.0.0.1
Line 1: Line 1:
 ===== SPL Improvements ===== ===== SPL Improvements =====
  
-  * See [[spldocs|SPL Documentation Thoughts/Ideas]]+See also: [[spldocs|SPL Documentation Thoughts/Ideas]] 
 + 
 +=== Grouping, categorising SPL === 
   * Create book/pages covering common methods:    * Create book/pages covering common methods: 
-    * Iterator +    * Iterator: current, key, next, rewind, valid
-      * current +
-      * key +
-      * next +
-      * rewind +
-      * valid +
-  * More descriptive pages +
-    * What is an Iterator +
-      * [[http://php.net/oop5.iterations|Object Iteration]] +
-      * [[http://php.net/class.iterator|Iterator Interface]] +
-      * [[http://php.net/spl.iterators|SPL Iterators]] +
-    * Recursively iterating +
-      * What, how, why?+
   * Grouping classes by interface or other logical groupings   * Grouping classes by interface or other logical groupings
     * Is the structure simple and hierarchical?     * Is the structure simple and hierarchical?
Line 21: Line 12:
     * E.g. Group recursive iterators together?     * E.g. Group recursive iterators together?
     * Compare [[http://php.net/spl.datastructures|Datastructures]] (grouped) to [[http://php.net/spl.iterators|Iterators]] (not grouped)     * Compare [[http://php.net/spl.datastructures|Datastructures]] (grouped) to [[http://php.net/spl.iterators|Iterators]] (not grouped)
 +
 +=== Examples, tutorials, more verbose documentation ===
 +
 +  * More descriptive pages
 +    * What is an Iterator: [[http://php.net/oop5.iterations|Object Iteration]], [[http://php.net/class.iterator|Iterator Interface]], [[http://php.net/spl.iterators|SPL Iterators]]
 +    * Recursively iterating: What, how, why?
 +
 +=== TODOC ===
 +
   * Remaining undocumented SPL classes/methods   * Remaining undocumented SPL classes/methods
-    * (TODO: share my reflection script to check progress) 
     * Mostly the 'common' methods from (Recursive)Iterator, Serializable, etc.     * Mostly the 'common' methods from (Recursive)Iterator, Serializable, etc.
-  * Repeated documentation +  * SPL Predefined Constants page ([[http://php.net/manual/en/spl.constants.php|manual]]) 
-    * Lots of pages are essentially repeats of one another (E.g. Foo::key(), Bar::key(), Baz::key() all saying "gets the key for the current item")+    * Only lists some RIT and CIT class constants 
 +    * Find, compile a list of and get descriptions (should this page have full descriptions or quicky sentences [is there a difference] thus duplicating what *should* be on the class synopsis page?) 
 +  * Add changelog entries for SplFileObject constants READ_AHEAD, READ_CSV and SKIP_EMPTY  -- they were added in 5.2.0
  
 ===== Random Thoughts ===== ===== Random Thoughts =====
Line 34: Line 35:
     * Class synopsis page does not show inherited methods     * Class synopsis page does not show inherited methods
     * SimpleXMLElement synopsis methods do not link anywhere! (Find out why, cause of above?)     * SimpleXMLElement synopsis methods do not link anywhere! (Find out why, cause of above?)
 +  * OOP5 basic introduction: update valid label regex/description:
 +    * The class name can be any valid label which is a not a PHP reserved word. A valid class name starts with a letter or underscore, followed by any number of letters, numbers, or underscores. As a regular expression, it would be expressed thus: [a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*.
 +    * Unicode.
 +
  

Page Tools