diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:33 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:42 +0400 |
commit | 145fcb57614297bc9be5cbb9597c0820416640be (patch) | |
tree | 616e20edb4eb8665f67444c739347930789dbaf1 /core/Plugin/ViewDataTable.php | |
parent | 6d4d87e81984e68a7f792ea964e9464a9d984231 (diff) |
Refs #4200 revised event docs for core/* files.
Diffstat (limited to 'core/Plugin/ViewDataTable.php')
-rw-r--r-- | core/Plugin/ViewDataTable.php | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/core/Plugin/ViewDataTable.php b/core/Plugin/ViewDataTable.php index 82444bcd7f..49ef36c6e8 100644 --- a/core/Plugin/ViewDataTable.php +++ b/core/Plugin/ViewDataTable.php @@ -102,19 +102,25 @@ abstract class ViewDataTable implements ViewInterface $this->requestConfig->apiMethodToRequestDataTable = $apiMethodToRequestDataTable; /** - * This event is triggered to gather the report display properties for each available report. If you define - * your own report, you want to subscribe to this event to define how your report shall be displayed in the - * Piwik UI. + * Triggered during [ViewDataTable](#) is constructed. Subscribers should customize + * the view based on the report that it is displaying. + * + * Plugins that define their own reports must subscribe to this event in order to + * customize how the Piwik UI will display and navigate the report. + * + * **Example** * - * public function configureViewDataTable(ViewDataTable $view) - * { - * switch ($view->requestConfig->apiMethodToRequestDataTable) { - * case 'VisitTime.getVisitInformationPerServerTime': - * $view->config->enable_sort = true; - * $view->requestConfig->filter_limit = 10; - * break; + * public function configureViewDataTable(ViewDataTable $view) + * { + * switch ($view->requestConfig->apiMethodToRequestDataTable) { + * case 'VisitTime.getVisitInformationPerServerTime': + * $view->config->enable_sort = true; + * $view->requestConfig->filter_limit = 10; + * break; + * } * } - * } + * + * @param ViewDataTable $view The instance to configure. */ Piwik::postEvent('ViewDataTable.configure', array($this)); |