@mattab opened this Issue on October 7th 2013 Member

Plugin developers can extend Piwik and change its functionality using Events. Plugins can "listen" to specific events and execute code, and/or read optional parameters and/or modify input parameter object

We shall prepare a documentation, the content will be fetched from the phpdoc comments of each hook.

  • Generated doc will list all hooks and for each:
    • Hook name
    • Link to see the code on github, where the hook is called
    • One sentence description explaining when the hook is called.
    • List the parameters sent with this event, their type
  • The Doc should also contain the list of hooks that do not yet have a phpdoc. This way core developers will know which ones are left to comment.

From a Piwik core team developer point of view, such doc should be automated. The current version was not automated and is not up to date as a result.

From a Plugin Developer point of view, having access to the up to date list of hooks is very important: the list is a clear overview of the possibilities offered by the Piwik platform.

This ticket scope is:

  • Script to generate documentation
  • Document all existing hooks so this doc looks nice and useful
  • Check that Tracker.* hooks make sense and are complete (ie. plugin developers should be able to do anything they want in tracker, using a tracker hook)

See also: Auto generated doc for classes and methods #4194

@tsteur commented on October 8th 2013 Member

In 73c9b97d16080a9a288ea1a0b7f1f348b3b93d32: refs #4199 inline this event name as we cannot automatically resolve it in hook doc generator

@tsteur commented on October 8th 2013 Member

In 66de2222946391f847da3341f069997c9d93fb7b: refs #4199 the signature will be autogenerated by the hooks doc generator

@tsteur commented on October 8th 2013 Member

In 7657881d5d5595e1f1386a65b3b9ebe1aae4aec4: refs #4199 inline the event documentation, renamed $this -> $logger to have a nice signature in documentation

@tsteur commented on October 8th 2013 Member

In c42bd694fa366f467b642a51f6989a608808af00: refs #4199 our hooks doc generator supports Markdown

@tsteur commented on October 8th 2013 Member

In 81f4c9e5a670876a017d03a674dcb732ec09f09d: refs #4199 inline some more PostEvent doc blocks

@tsteur commented on October 8th 2013 Member

In 9bfd1ae2fefcb896b46573de64b62a7fc5980f8f: refs #4199 documented some events

@tsteur commented on October 8th 2013 Member

In 3f39037b271208f458131a08a45ce1d841b176fd: refs #4199 documented some more events

@tsteur commented on October 8th 2013 Member

In c2cb04094b439f50911d5656400e002f6f1563db: refs #4199 documented some more events

@tsteur commented on October 8th 2013 Member

In e73621f51220092a5dabdb152a7d96b0f80d2bf2: refs #4199 forgot one backtick

@tsteur commented on October 8th 2013 Member

In 61d54537fae127aaf7b6384fc831f3128e6ab2e9: refs #4199 added more PostEvent documentations and removed one unused event

@mattab commented on October 8th 2013 Member

added to scope:

  • Check that Tracker.* hooks make sense and are complete (ie. plugin developers should be able to do anything they want in tracker, using a tracker hook)
@tsteur commented on October 8th 2013 Member

In e846e3518a661219d22e4c8a4883454a817ae4d2: refs #4199 more event documentations

@tsteur commented on October 9th 2013 Member

In 4b74c5c44d37c2269991b5a8dc185db0fc40136a: refs #4199 updated some event docs and removed some more unused events

@tsteur commented on October 9th 2013 Member

In 0c9cf80a406d3b608b40671e6f0e5091730fd1a9: refs #4199 added method to get all reports with goal metrics, otherwise it appears twice in the hooks documentation

@tsteur commented on October 9th 2013 Member

done what is possible so far. Can you have a look over all "@matt" comments?

@tsteur commented on October 9th 2013 Member

In f76c20a6da8bfba698e959296c9b385ffcd44659: refs #4199 mark event as internal

@mattab commented on October 9th 2013 Member

In 60949f65ad526ee87ca06b4c79533ab1dc0ced1e: Refs #4199 minor doc

@anonymous-matomo-user commented on October 14th 2013

In 81f519743d13c9a0962f8cb15722e5ddaa1a8218: refs #4199 ScheduledReports hooks' documentation

@diosmosis commented on December 5th 2013 Member

In 777ca60440aa67e436fb15bb0fc1bd445d32ce78: Fixes #4199, revising event docs and closing ticket.

This Issue was closed on December 5th 2013
Powered by GitHub Issue Mirror