Named parameters in generic proxy API events #10764
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsteur
changed the title
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When an API method is called, we post some generic events:
API.Request.dispatch,API.Request.dispatch.end,API.$plugin.$apiAction, andAPI.$plugin.$apiAction.endseehttps://developer.piwik.org/api-reference/events#apipluginnamemethodname
Those events are meant to change API parameters, the response and to perform other logic when any API method is called. As an argument they post a parameter
$finalParameters = array(5, 10, 'foo', 'bar')meaning a plugin needs to access those parameters like$finalParameters[0].This is quite fragile if the order of an API method ever changes and it is very hard to read the code as it is not clear which value is behind that key. Therefore we will now pass named parameters there and it will now look like:
$finalParameters = array('idSite' => 5, 'idGoal' => 10, 'name' => 'foo', 'attribute' => 'bar').This way it is better to read and easier to access parameters and less fragile as the order of parameters in our API methods could always change.