Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add explicit warning to docs about event registering logic #10475

Closed
tmuic opened this issue Sep 7, 2016 · 3 comments
Closed

Add explicit warning to docs about event registering logic #10475

tmuic opened this issue Sep 7, 2016 · 3 comments
Assignees
@tsteur @mattab
Labels
not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Milestone
3.0.0-b1

Comments

@tmuic
Copy link

tmuic commented Sep 7, 2016

There are two very similar functions listed in this document
https://developer.piwik.org/api-reference/Piwik/Plugin#getlisthooksregistered

registerEvents()

getListHooksRegistered()

If you by mistake implement both in same plugin the latter one will override the former one and events registered in first one will be lost.

Error can happen easily if basing work on different plugins which use either one of this variants.

Also seems that events and hooks terminology is used interchangelably and should be explicitely stated that those two mean the same thing.

It can be very confusin
mattab added a commit that referenced this issue Sep 27, 2016
@mattab
Add @ignore tag to this method so it does not appear in auto generate…
cb74e52 
…d doc, refs #10475
@mattab mattab added this to the 3.0.0-b1 milestone Sep 27, 2016
@mattab mattab self-assigned this Sep 27, 2016
@mattab
Copy link
Member

mattab commented Sep 27, 2016

Thanks for suggestion. Hopefully it will be fixed after adding @ignore the method should be removed from the auto-generated documentation. Will check again in 10min as it runs every 10min

@mattab
Copy link
Member

mattab commented Sep 27, 2016

@tsteur the developer doc was not updated although we added @ignore - any idea maybe?

@tsteur tsteur added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label Sep 29, 2016
@tsteur
Copy link
Member

tsteur commented Sep 29, 2016

fixed in matomo-org/developer-documentation@1107e49 must be a bug in Sami docs parser or so

@tsteur tsteur closed this as completed Sep 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsteur tsteur

@mattab mattab

Labels
not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Milestone
3.0.0-b1
Development

No branches or pull requests
3 participants
@tsteur @mattab @tmuic