diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-11-26 02:17:56 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-11-26 06:29:03 +0400 |
commit | c8880f4afe791835584e2e1580807d232591ded0 (patch) | |
tree | f8c784a962e9746a3489b9f34e885a998c7f02d0 /core | |
parent | 88b7991cb3f3eafadf5834e300152ca917ec5792 (diff) |
Refs #4200, fixing typo in method name and tweaking docs.
Diffstat (limited to 'core')
-rw-r--r-- | core/ArchiveProcessor.php | 2 | ||||
-rw-r--r-- | core/DataTable.php | 2 | ||||
-rw-r--r-- | core/DataTable/Filter/AddColumnsProcessedMetrics.php | 11 | ||||
-rw-r--r-- | core/Piwik.php | 2 | ||||
-rw-r--r-- | core/Plugin/ConsoleCommand.php | 1 | ||||
-rw-r--r-- | core/Plugin/Visualization.php | 4 |
6 files changed, 11 insertions, 11 deletions
diff --git a/core/ArchiveProcessor.php b/core/ArchiveProcessor.php index b901c7fb6a..11aba86122 100644 --- a/core/ArchiveProcessor.php +++ b/core/ArchiveProcessor.php @@ -70,8 +70,6 @@ use Piwik\Period; * * $maxRowsInTable = Config::getInstance()->General['datatable_archiving_maximum_rows_standard'];j * - * $myDataTable = // ... use LogAggregator to generate a report about some log data ... - * * $dataTable = // ... build by aggregating visits ... * $serializedData = $dataTable->getSerialized($maxRowsInTable, $maxRowsInSubtable = $maxRowsInTable, * $columnToSortBy = Metrics::INDEX_NB_VISITS); diff --git a/core/DataTable.php b/core/DataTable.php index 94500e08d1..c842887274 100644 --- a/core/DataTable.php +++ b/core/DataTable.php @@ -50,7 +50,7 @@ require_once PIWIK_INCLUDE_PATH . '/core/Common.php'; * * ### Populating DataTables * - * Data can be added to DataTables in a couple different ways. You can either: + * Data can be added to DataTables in three different ways. You can either: * * 1. create rows one by one and add them through [addRow](#addRow) then truncate if desired, * 2. create an array of DataTable\Row instances or an array of arrays and add them using diff --git a/core/DataTable/Filter/AddColumnsProcessedMetrics.php b/core/DataTable/Filter/AddColumnsProcessedMetrics.php index b4a6980b1b..58fabac1e4 100644 --- a/core/DataTable/Filter/AddColumnsProcessedMetrics.php +++ b/core/DataTable/Filter/AddColumnsProcessedMetrics.php @@ -16,19 +16,20 @@ use Piwik\DataTable; use Piwik\Metrics; /** - * Adds the processed metrics columns to a DataTable using metrics that already exist. + * Adds processed metrics columns to a DataTable using metrics that already exist. * - * Columns processed are: - * - **conversion_rate**: percent value of `nb_conversions / nb_visits + * Columns added are: + * + * - **conversion_rate**: percent value of `nb_visits_converted / nb_visits * - **nb_actions_per_visit**: `nb_actions / nb_visits` * - **avg_time_on_site**: in number of seconds, `round(visit_length / nb_visits)`. not - * pretty formatted + * pretty formatted. * - **bounce_rate**: percent value of `bounce_count / nb_visits` * * Adding the **filter_add_columns_when_show_all_columns** query parameter to * an API request will trigger the execution of this Filter. * - * Note: This filter must be called before [ReplaceColumnNames](#) is called. + * _Note: This filter must be called before [ReplaceColumnNames](#) is called._ * * **Basic usage example** * diff --git a/core/Piwik.php b/core/Piwik.php index 6a7cec9004..840f29b428 100644 --- a/core/Piwik.php +++ b/core/Piwik.php @@ -691,7 +691,7 @@ class Piwik * need to use this function. * * @param string $eventName The event name. - * @param callable $function The observer. + * @param callable|array $function The observer. * @api */ public static function addAction($eventName, $function) diff --git a/core/Plugin/ConsoleCommand.php b/core/Plugin/ConsoleCommand.php index 14371ddd22..4c0169ae33 100644 --- a/core/Plugin/ConsoleCommand.php +++ b/core/Plugin/ConsoleCommand.php @@ -19,6 +19,7 @@ use Symfony\Component\Console\Input\InputInterface; * The base class for console commands. * * @package Piwik_Console + * @api */ class ConsoleCommand extends SymfonyCommand { diff --git a/core/Plugin/Visualization.php b/core/Plugin/Visualization.php index b36b2dbc6f..9cdfb65f7b 100644 --- a/core/Plugin/Visualization.php +++ b/core/Plugin/Visualization.php @@ -65,7 +65,7 @@ class Visualization extends ViewDataTable $requestPropertiesAfterLoadDataTable = $this->requestConfig->getProperties(); $this->applyFilters(); - $this->afterAllFilteresAreApplied(); + $this->afterAllFiltersAreApplied(); $this->beforeRender(); $this->logMessageIfRequestPropertiesHaveChanged($requestPropertiesAfterLoadDataTable); @@ -410,7 +410,7 @@ class Visualization extends ViewDataTable * This hook is executed after the data table is loaded and after all filteres are applied. * Format the data that you want to pass to the view here. */ - public function afterAllFilteresAreApplied() + public function afterAllFiltersAreApplied() { } |