diff options
author | Christian Raue <christian.raue@gmail.com> | 2014-07-23 22:27:56 +0400 |
---|---|---|
committer | Christian Raue <christian.raue@gmail.com> | 2014-07-23 22:27:56 +0400 |
commit | d9adcfe6169c6c10059a670f2ed984908eb4e105 (patch) | |
tree | 25cfca25851214c1b744a07e67e9c120adfd7513 /core/Plugin/Visualization.php | |
parent | 2788e1dad22533f3e0dbddbdd16c51251c4e130a (diff) |
removed lots of trailing whitespace
Diffstat (limited to 'core/Plugin/Visualization.php')
-rw-r--r-- | core/Plugin/Visualization.php | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/core/Plugin/Visualization.php b/core/Plugin/Visualization.php index e86274c5ea..1c5a7a3bd8 100644 --- a/core/Plugin/Visualization.php +++ b/core/Plugin/Visualization.php @@ -24,11 +24,11 @@ use Piwik\ViewDataTable\Manager as ViewDataTableManager; /** * The base class for report visualizations that output HTML and use JavaScript. - * + * * Report visualizations that extend from this class will be displayed like all others in * the Piwik UI. The following extra UI controls will be displayed around the visualization * itself: - * + * * - report documentation, * - a footer message (if {@link Piwik\ViewDataTable\Config::$show_footer_message} is set), * - a list of links to related reports (if {@link Piwik\ViewDataTable\Config::$related_reports} is set), @@ -37,33 +37,33 @@ use Piwik\ViewDataTable\Manager as ViewDataTableManager; * - a limit control that allows users to change the amount of rows displayed (if * {@link Piwik\ViewDataTable\Config::$show_limit_control} is true), * - and more depending on the visualization. - * + * * ### Rendering Process - * + * * The following process is used to render reports: - * + * * - The report is loaded through Piwik's Reporting API. * - The display and request properties that require report data in order to determine a default * value are defaulted. These properties are: - * + * * - {@link Piwik\ViewDataTable\Config::$columns_to_display} * - {@link Piwik\ViewDataTable\RequestConfig::$filter_sort_column} * - {@link Piwik\ViewDataTable\RequestConfig::$filter_sort_order} - * + * * - Priority filters are applied to the report (see {@link Piwik\ViewDataTable\Config::$filters}). * - The filters that are applied to every report in the Reporting API (called **generic filters**) * are applied. (see {@link Piwik\API\Request}) * - The report's queued filters are applied. * - A {@link Piwik\View} instance is created and rendered. - * + * * ### Rendering Hooks - * + * * The Visualization class defines several overridable methods that are called at specific * points during the rendering process. Derived classes can override these methods change * the data that is displayed or set custom properties. - * + * * The overridable methods (called **rendering hooks**) are as follows: - * + * * - **beforeLoadDataTable**: Called at the start of the rendering process before any data * is loaded. * - **beforeGenericFiltersAreAppliedToLoadedDataTable**: Called after data is loaded and after priority @@ -76,20 +76,20 @@ use Piwik\ViewDataTable\Manager as ViewDataTableManager; * - **beforeRender**: Called immediately before a {@link Piwik\View} is created and rendered. * - **isThereDataToDisplay**: Called after a {@link Piwik\View} is created to determine if the report has * data or not. If not, a message is displayed to the user. - * + * * ### The DataTable JavaScript class - * + * * In the UI, visualization behavior is provided by logic in the **DataTable** JavaScript class. * When creating new visualizations, the **DataTable** JavaScript class (or one of its existing * descendants) should be extended. - * + * * To learn more read the [Visualizing Report Data](/guides/visualizing-report-data#creating-new-visualizations) * guide. * * ### Examples - * + * * **Changing the data that is loaded** - * + * * class MyVisualization extends Visualization * { * // load the previous period's data as well as the requested data. this will change @@ -101,20 +101,20 @@ use Piwik\ViewDataTable\Manager as ViewDataTableManager; * * $this->requestConfig->request_parameters_to_modify['date'] = $previousDate . ',' . $date; * } - * + * * // since we load the previous period's data too, we need to override the logic to * // check if there is data or not. * public function isThereDataToDisplay() * { * $tables = $this->dataTable->getDataTables() * $requestedDataTable = end($tables); - * + * * return $requestedDataTable->getRowsCount() != 0; * } * } - * + * * **Force properties to be set to certain values** - * + * * class MyVisualization extends Visualization * { * // ensure that some properties are set to certain values before rendering. @@ -133,9 +133,9 @@ class Visualization extends ViewDataTable { /** * The Twig template file to use when rendering, eg, `"@MyPlugin/_myVisualization.twig"`. - * + * * Must be defined by classes that extend Visualization. - * + * * @api */ const TEMPLATE_FILE = ''; @@ -253,9 +253,9 @@ class Visualization extends ViewDataTable /** * Returns `true` if there is data to display, `false` if otherwise. - * + * * Derived classes should override this method if they change the amount of data that is loaded. - * + * * @api */ protected function isThereDataToDisplay() @@ -507,7 +507,7 @@ class Visualization extends ViewDataTable /** * Hook that is called before loading report data from the API. - * + * * Use this method to change the request parameters that is sent to the API when requesting * data. * @@ -519,7 +519,7 @@ class Visualization extends ViewDataTable /** * Hook that is executed before generic filters are applied. - * + * * Use this method if you need access to the entire dataset (since generic filters will * limit and truncate reports). * |