doc:todo:salathe
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
doc:todo:salathe [2010/04/13 09:15] – salathe | doc: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/ | + | See also: [[spldocs|SPL Documentation Thoughts/ |
+ | |||
+ | === Grouping, categorising SPL === | ||
* Create book/pages covering common methods: | * Create book/pages covering common methods: | ||
- | * Iterator | + | * Iterator: current, key, next, rewind, |
- | * current | + | |
- | * key | + | |
- | * next | + | |
- | * rewind | + | |
- | * valid | + | |
- | * More descriptive pages | + | |
- | * What is an Iterator | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | * 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:// | * Compare [[http:// | ||
+ | |||
+ | === Examples, tutorials, more verbose documentation === | ||
+ | |||
+ | * More descriptive pages | ||
+ | * What is an Iterator: [[http:// | ||
+ | * Recursively iterating: What, how, why? | ||
+ | |||
+ | === TODOC === | ||
+ | |||
* Remaining undocumented SPL classes/ | * Remaining undocumented SPL classes/ | ||
- | * (TODO: share my reflection script to check progress) | ||
* Mostly the ' | * Mostly the ' | ||
- | * Repeated documentation | + | * SPL Predefined Constants page ([[http:// |
- | * Lots of pages are essentially repeats of one another | + | * Only lists some RIT and CIT class constants |
+ | * Find, compile a list of and get descriptions | ||
+ | * Add changelog entries for SplFileObject constants READ_AHEAD, READ_CSV and SKIP_EMPTY | ||
===== 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?) | ||
- | |||
- | ===== Non-SPL Things (really!) ====== | ||
- | |||
* OOP5 basic introduction: | * OOP5 basic introduction: | ||
* 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]*. | * 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]*. |