diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-06 01:49:56 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-06 01:49:56 +0400 |
commit | 777ca60440aa67e436fb15bb0fc1bd445d32ce78 (patch) | |
tree | e3557a53472016259873109e2932f99b764be42c /core/ViewDataTable | |
parent | b6c2cf90277b6abeabe13910b04ef286c66a4b67 (diff) |
Fixes #4199, revising event docs and closing ticket.
Diffstat (limited to 'core/ViewDataTable')
-rw-r--r-- | core/ViewDataTable/Factory.php | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/core/ViewDataTable/Factory.php b/core/ViewDataTable/Factory.php index 44b601478f..0a9510372a 100644 --- a/core/ViewDataTable/Factory.php +++ b/core/ViewDataTable/Factory.php @@ -151,18 +151,22 @@ class Factory if (null === self::$defaultViewTypes) { self::$defaultViewTypes = array(); /** - * Triggered when gathering the default view types for all available reports. By default the HtmlTable - * visualization is used. If you define your own report, you may want to subscribe to this event to - * make sure another Visualization is used (for example, a pie graph, bar graph, or something else). + * Triggered when gathering the default view types for all available reports. + * + * If you define your own report, you may want to subscribe to this event to + * make sure the correct default Visualization is used (for example, a pie graph, + * bar graph, or something else). * + * If there is no default type associated with a report, the **table** visualization + * used. + * * **Example** - * ``` - * public function getDefaultTypeViewDataTable(&$defaultViewTypes) - * { - * $defaultViewTypes['Referrers.getSocials'] = HtmlTable::ID; - * $defaultViewTypes['Referrers.getUrlsForSocial'] = Pie::ID; - * } - * ``` + * + * public function getDefaultTypeViewDataTable(&$defaultViewTypes) + * { + * $defaultViewTypes['Referrers.getSocials'] = HtmlTable::ID; + * $defaultViewTypes['Referrers.getUrlsForSocial'] = Pie::ID; + * } * * @param array &$defaultViewTypes The array mapping report IDs with visualization IDs. */ |