doc:todo:salathe

This is an old revision of the document!


SPL Improvements

  • Create book/pages covering common methods:
    • Iterator
      • current
      • key
      • next
      • rewind
      • valid
  • More descriptive pages
  • Grouping classes by interface or other logical groupings
    • Is the structure simple and hierarchical?
    • Or a complicated web?
    • E.g. Group recursive iterators together?
    • Compare Datastructures (grouped) to Iterators (not grouped)
  • Remaining undocumented SPL classes/methods
    • (TODO: share my reflection script to check progress)
    • Mostly the 'common' methods from (Recursive)Iterator, Serializable, etc.
  • Repeated documentation
    • 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”)

Random Thoughts

A collection of random thoughts, ideas, suggestions and a scratchpad for miscellaneous doc-related musings.

    • Class synopsis page does not show inherited methods
    • SimpleXMLElement synopsis methods do not link anywhere! (Find out why, cause of above?)

Quickie TODOs

  • Add changelog entries for SplFileObject constants READ_AHEAD, READ_CSV and SKIP_EMPTY -- they were added in 5.2.0

Non-SPL Things (really!)

  • 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.
doc/todo/salathe.1271256400.txt.gz · Last modified: 2017/09/22 13:28 (external edit)