[TYPO3-core] [TYPO3-dev] RFC: php-doc for hooks

Bernhard Kraft kraftb at kraftb.at
Sat Nov 17 17:41:53 CET 2007


Hi !


This is an RFC.


Problem:
Just by a single grep I could find about 50 hooks in the TYPO3 core.
There is no common place where all hooks are at least a little bit documented.


Solution:
Add a php-doc header in front of each hook.

Example:

      /*
       * @hook       makeControl: Allows to change control icons of records in list-module
       * @date       2007-11-17
       * @request    Bernhard Kraft  <krafbt at kraftb.at>
       */

What fields should also get added (@doc probably) and it would be good if we could
give each hook a kind of "UID" ... so it is possible to "identify" each hook.


Please share your comments and ideas.


I could take care of adding the php-docs.
There should be some people who document each hook and usage (Probably in the wiki first)
Which then should get moved into some maintained document on typo3.org


greets,
Bernhard


More information about the TYPO3-team-core mailing list