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/DataTable | |
parent | 2788e1dad22533f3e0dbddbdd16c51251c4e130a (diff) |
removed lots of trailing whitespace
Diffstat (limited to 'core/DataTable')
30 files changed, 131 insertions, 131 deletions
diff --git a/core/DataTable/BaseFilter.php b/core/DataTable/BaseFilter.php index 7e8f1c4dd4..fb2dc009f9 100644 --- a/core/DataTable/BaseFilter.php +++ b/core/DataTable/BaseFilter.php @@ -13,7 +13,7 @@ use Piwik\DataTable\Row; /** * A filter is set of logic that manipulates a DataTable. Existing filters do things like, - * + * * - remove rows * - change column values (change string to lowercase, truncate, etc.) * - add/remove columns or metadata (compute percentage values, add an 'icon' metadata based on the label, etc.) @@ -22,10 +22,10 @@ use Piwik\DataTable\Row; * * Filters are called with a DataTable instance and extra parameters that are specified * in {@link Piwik\DataTable::filter()} and {@link Piwik\DataTable::queueFilter()}. - * + * * To see examples of Filters look at the existing ones in the Piwik\DataTable\BaseFilter * namespace. - * + * * @api */ abstract class BaseFilter @@ -37,7 +37,7 @@ abstract class BaseFilter /** * Constructor. - * + * * @param DataTable $table */ public function __construct(DataTable $table) diff --git a/core/DataTable/Filter/AddColumnsProcessedMetrics.php b/core/DataTable/Filter/AddColumnsProcessedMetrics.php index 8ad329e610..f3d8191b1f 100644 --- a/core/DataTable/Filter/AddColumnsProcessedMetrics.php +++ b/core/DataTable/Filter/AddColumnsProcessedMetrics.php @@ -17,22 +17,22 @@ use Piwik\Metrics; * Adds processed metrics columns to a {@link DataTable} using metrics that already exist. * * 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. * - **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 {@link ReplaceColumnNames} is called._ - * + * * **Basic usage example** - * + * * $dataTable->filter('AddColumnsProcessedMetrics'); - * + * * @api */ class AddColumnsProcessedMetrics extends BaseFilter @@ -43,7 +43,7 @@ class AddColumnsProcessedMetrics extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The table to eventually filter. * @param bool $deleteRowsWithNoVisit Whether to delete rows with no visits or not. */ diff --git a/core/DataTable/Filter/AddColumnsProcessedMetricsGoal.php b/core/DataTable/Filter/AddColumnsProcessedMetricsGoal.php index 7f828a1f62..742f1aef6d 100644 --- a/core/DataTable/Filter/AddColumnsProcessedMetricsGoal.php +++ b/core/DataTable/Filter/AddColumnsProcessedMetricsGoal.php @@ -38,17 +38,17 @@ use Piwik\Tracker\GoalManager; * reports. * - **goal_%idGoal%_items**: number of items. Only for ecommerce order and abandoned cart * reports. - * + * * Adding the **filter_update_columns_when_show_all_goals** query parameter to * an API request will trigger the execution of this Filter. - * + * * _Note: This filter must be called before {@link ReplaceColumnNames} is called._ - * + * * **Basic usage example** - * + * * $dataTable->filter('AddColumnsProcessedMetricsGoal', * array($enable = true, $idGoal = Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER)); - * + * * @api */ class AddColumnsProcessedMetricsGoal extends AddColumnsProcessedMetrics @@ -72,7 +72,7 @@ class AddColumnsProcessedMetricsGoal extends AddColumnsProcessedMetrics /** * Constructor. - * + * * @param DataTable $table The table that will eventually filtered. * @param bool $enable Always set to true. * @param string $processOnlyIdGoal Defines what metrics to add (don't process metrics when you don't display them). diff --git a/core/DataTable/Filter/AddSummaryRow.php b/core/DataTable/Filter/AddSummaryRow.php index 09f6725db0..9cb4b3e2f1 100644 --- a/core/DataTable/Filter/AddSummaryRow.php +++ b/core/DataTable/Filter/AddSummaryRow.php @@ -16,12 +16,12 @@ use Piwik\DataTable\Row\DataTableSummaryRow; * Adds a summary row to {@link DataTable}s that contains the sum of all other table rows. * * **Basic usage example** - * + * * $dataTable->filter('AddSummaryRow'); - * + * * // use a human readable label for the summary row (instead of '-1') * $dataTable->filter('AddSummaryRow', array($labelSummaryRow = Piwik::translate('General_Total'))); - * + * * @api */ class AddSummaryRow extends BaseFilter diff --git a/core/DataTable/Filter/BeautifyRangeLabels.php b/core/DataTable/Filter/BeautifyRangeLabels.php index 7f60bdd714..534f484bff 100644 --- a/core/DataTable/Filter/BeautifyRangeLabels.php +++ b/core/DataTable/Filter/BeautifyRangeLabels.php @@ -28,11 +28,11 @@ use Piwik\Piwik; * This filter can be extended to vary exactly how ranges are prettified based * on the range values found in the DataTable. To see an example of this, * take a look at the {@link BeautifyTimeRangeLabels} filter. - * + * * **Basic usage example** - * + * * $dataTable->queueFilter('BeautifyRangeLabels', array("1 visit", "%s visits")); - * + * * @api */ class BeautifyRangeLabels extends ColumnCallbackReplace diff --git a/core/DataTable/Filter/BeautifyTimeRangeLabels.php b/core/DataTable/Filter/BeautifyTimeRangeLabels.php index 1841d94f48..aed7af7d8d 100644 --- a/core/DataTable/Filter/BeautifyTimeRangeLabels.php +++ b/core/DataTable/Filter/BeautifyTimeRangeLabels.php @@ -17,11 +17,11 @@ use Piwik\DataTable; * This filter customizes the behavior of the {@link BeautifyRangeLabels} filter * so range values that are less than one minute are displayed in seconds but * other ranges are displayed in minutes. - * + * * **Basic usage** - * + * * $dataTable->filter('BeautifyTimeRangeLabels', array("%1$s-%2$s min", "1 min", "%s min")); - * + * * @api */ class BeautifyTimeRangeLabels extends BeautifyRangeLabels diff --git a/core/DataTable/Filter/CalculateEvolutionFilter.php b/core/DataTable/Filter/CalculateEvolutionFilter.php index 28022952e0..80f789919e 100755 --- a/core/DataTable/Filter/CalculateEvolutionFilter.php +++ b/core/DataTable/Filter/CalculateEvolutionFilter.php @@ -17,12 +17,12 @@ use Piwik\Site; * it to each row as a percentage. * * **This filter cannot be used as an argument to {@link Piwik\DataTable::filter()}** since - * it requires corresponding data from another DataTable. Instead, + * it requires corresponding data from another DataTable. Instead, * you must manually perform a binary filter (see the **MultiSites** API for an * example). * * The evolution metric is calculated as: - * + * * ((currentValue - pastValue) / pastValue) * 100 * * @api diff --git a/core/DataTable/Filter/ColumnCallbackAddColumn.php b/core/DataTable/Filter/ColumnCallbackAddColumn.php index 0084fd076b..27746c4f28 100755 --- a/core/DataTable/Filter/ColumnCallbackAddColumn.php +++ b/core/DataTable/Filter/ColumnCallbackAddColumn.php @@ -13,13 +13,13 @@ use Piwik\DataTable\BaseFilter; /** * Adds a new column to every row of a {@link DataTable} based on the result of callback. - * + * * **Basic usage example** - * + * * $callback = function ($visits, $timeSpent) { * return round($timeSpent / $visits, 2); * }; - * + * * $dataTable->filter('ColumnCallbackAddColumn', array(array('nb_visits', 'sum_time_spent'), 'avg_time_on_site', $callback)); * * @api @@ -93,7 +93,7 @@ class ColumnCallbackAddColumn extends BaseFilter } $parameters = array_merge($columnValues, $functionParams); - + return call_user_func_array($functionToApply, $parameters); }); diff --git a/core/DataTable/Filter/ColumnCallbackAddColumnPercentage.php b/core/DataTable/Filter/ColumnCallbackAddColumnPercentage.php index de1e5e950a..056c129440 100644 --- a/core/DataTable/Filter/ColumnCallbackAddColumnPercentage.php +++ b/core/DataTable/Filter/ColumnCallbackAddColumnPercentage.php @@ -13,11 +13,11 @@ use Piwik\Piwik; /** * Calculates a percentage value for each row of a {@link DataTable} and adds the result * to each row. - * + * * See {@link ColumnCallbackAddColumnQuotient} for more information. * * **Basic usage example** - * + * * $nbVisits = // ... get the visits for a period ... * $dataTable->queueFilter('ColumnCallbackAddColumnPercentage', array('nb_visits', 'nb_visits_percentage', $nbVisits, 1)); * diff --git a/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php b/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php index d82599be5c..5cc83d8e3d 100644 --- a/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php +++ b/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php @@ -15,14 +15,14 @@ use Piwik\DataTable\Row; /** * Calculates the quotient of two columns and adds the result as a new column * for each row of a DataTable. - * + * * This filter is used to calculate rate values (eg, `'bounce_rate'`), averages * (eg, `'avg_time_on_page'`) and other types of values. * * **Basic usage example** - * + * * $dataTable->queueFilter('ColumnCallbackAddColumnQuotient', array('bounce_rate', 'bounce_count', 'nb_visits', $precision = 2)); - * + * * @api */ class ColumnCallbackAddColumnQuotient extends BaseFilter @@ -38,7 +38,7 @@ class ColumnCallbackAddColumnQuotient extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The DataTable that will eventually be filtered. * @param string $columnNameToAdd The name of the column to add the quotient value to. * @param string $columnValueToRead The name of the column that holds the dividend. diff --git a/core/DataTable/Filter/ColumnCallbackAddMetadata.php b/core/DataTable/Filter/ColumnCallbackAddMetadata.php index 1a2b9b27f7..e89000f8fd 100644 --- a/core/DataTable/Filter/ColumnCallbackAddMetadata.php +++ b/core/DataTable/Filter/ColumnCallbackAddMetadata.php @@ -14,11 +14,11 @@ use Piwik\DataTable\BaseFilter; /** * Executes a callback for each row of a {@link DataTable} and adds the result as a new * row metadata value. - * + * * **Basic usage example** - * + * * $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik\Plugins\MyPlugin\getLogoFromLabel')); - * + * * @api */ class ColumnCallbackAddMetadata extends BaseFilter @@ -31,7 +31,7 @@ class ColumnCallbackAddMetadata extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The DataTable instance that will be filtered. * @param string|array $columnsToRead The columns to read from each row and pass on to the callback. * @param string $metadataToAdd The name of the metadata field that will be added to each row. diff --git a/core/DataTable/Filter/ColumnCallbackDeleteRow.php b/core/DataTable/Filter/ColumnCallbackDeleteRow.php index f5883d1b6a..189fbd3b81 100644 --- a/core/DataTable/Filter/ColumnCallbackDeleteRow.php +++ b/core/DataTable/Filter/ColumnCallbackDeleteRow.php @@ -15,12 +15,12 @@ use Piwik\DataTable\BaseFilter; * Deletes all rows for which a callback returns true. * * **Basic usage example** - * + * * $labelsToRemove = array('label1', 'label2', 'label2'); * $dataTable->filter('ColumnCallbackDeleteRow', array('label', function ($label) use ($labelsToRemove) { * return in_array($label, $labelsToRemove); * })); - * + * * @api */ class ColumnCallbackDeleteRow extends BaseFilter @@ -31,7 +31,7 @@ class ColumnCallbackDeleteRow extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The DataTable that will be filtered eventually. * @param array|string $columnsToFilter The column or array of columns that should be * passed to the callback. diff --git a/core/DataTable/Filter/ColumnCallbackReplace.php b/core/DataTable/Filter/ColumnCallbackReplace.php index bec7d683f5..e33dfa9a14 100644 --- a/core/DataTable/Filter/ColumnCallbackReplace.php +++ b/core/DataTable/Filter/ColumnCallbackReplace.php @@ -15,9 +15,9 @@ use Piwik\DataTable\Row; /** * Replaces one or more column values in each row of a DataTable with the results * of a callback. - * + * * **Basic usage example** - * + * * $truncateString = function ($value, $truncateLength) { * if (strlen($value) > $truncateLength) { * return substr(0, $truncateLength); @@ -25,10 +25,10 @@ use Piwik\DataTable\Row; * return $value; * } * }; - * + * * // label, url and truncate_length are columns in $dataTable * $dataTable->filter('ColumnCallbackReplace', array('label', 'url'), $truncateString, null, array('truncate_length')); - * + * */ class ColumnCallbackReplace extends BaseFilter { @@ -39,7 +39,7 @@ class ColumnCallbackReplace extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The DataTable to filter. * @param array|string $columnsToFilter The columns whose values should be passed to the callback * and then replaced with the callback's result. diff --git a/core/DataTable/Filter/ColumnDelete.php b/core/DataTable/Filter/ColumnDelete.php index 7631c7a9c2..976519c6fa 100644 --- a/core/DataTable/Filter/ColumnDelete.php +++ b/core/DataTable/Filter/ColumnDelete.php @@ -16,15 +16,15 @@ use Piwik\DataTable\BaseFilter; * whitelist or both. * * This filter is used to handle the **hideColumn** and **showColumn** query parameters. - * + * * **Basic usage example** - * + * * $columnsToRemove = array('nb_hits', 'nb_pageviews'); * $dataTable->filter('ColumnDelete', array($columnsToRemove)); - * + * * $columnsToKeep = array('nb_visits'); * $dataTable->filter('ColumnDelete', array(array(), $columnsToKeep)); - * + * * @api */ class ColumnDelete extends BaseFilter diff --git a/core/DataTable/Filter/ExcludeLowPopulation.php b/core/DataTable/Filter/ExcludeLowPopulation.php index e346ea28fc..ee135b59d6 100644 --- a/core/DataTable/Filter/ExcludeLowPopulation.php +++ b/core/DataTable/Filter/ExcludeLowPopulation.php @@ -14,17 +14,17 @@ use Piwik\DataTable\BaseFilter; /** * Deletes all rows for which a specific column has a value that is lower than * specified minimum threshold value. - * + * * **Basic usage examples** - * + * * // remove all countries from UserCountry.getCountry that have less than 3 visits * $dataTable = // ... get a DataTable whose queued filters have been run ... * $dataTable->filter('ExcludeLowPopulation', array('nb_visits', 3)); - * + * * // remove all countries from UserCountry.getCountry whose percent of total visits is less than 5% * $dataTable = // ... get a DataTable whose queued filters have been run ... * $dataTable->filter('ExcludeLowPopulation', array('nb_visits', false, 0.05)); - * + * * // remove all countries from UserCountry.getCountry whose bounce rate is less than 10% * $dataTable = // ... get a DataTable that has a numerical bounce_rate column ... * $dataTable->filter('ExcludeLowPopulation', array('bounce_rate', 0.10)); @@ -50,7 +50,7 @@ class ExcludeLowPopulation extends BaseFilter * @param string $columnToFilter The name of the column whose value will determine whether * a row is deleted or not. * @param number|false $minimumValue The minimum column value. Rows with column values < - * this number will be deleted. If false, + * this number will be deleted. If false, * `$minimumPercentageThreshold` is used. * @param bool|float $minimumPercentageThreshold If supplied, column values must be a greater * percentage of the sum of all column values than diff --git a/core/DataTable/Filter/GroupBy.php b/core/DataTable/Filter/GroupBy.php index d783db8bca..8633fb2e9d 100755 --- a/core/DataTable/Filter/GroupBy.php +++ b/core/DataTable/Filter/GroupBy.php @@ -18,12 +18,12 @@ use Piwik\DataTable\BaseFilter; * _NOTE: This filter should never be queued, it must be applied directly on a {@link DataTable}._ * * **Basic usage example** - * + * * // group URLs by host * $dataTable->filter('GroupBy', array('label', function ($labelUrl) { * return parse_url($labelUrl, PHP_URL_HOST); * })); - * + * * @api */ class GroupBy extends BaseFilter diff --git a/core/DataTable/Filter/Limit.php b/core/DataTable/Filter/Limit.php index c06bac49c5..5cf848a50e 100644 --- a/core/DataTable/Filter/Limit.php +++ b/core/DataTable/Filter/Limit.php @@ -13,9 +13,9 @@ use Piwik\DataTable\BaseFilter; /** * Delete all rows from the table that are not in the given [offset, offset+limit) range. - * + * * **Basic example usage** - * + * * // delete all rows from 5 -> 15 * $dataTable->filter('Limit', array(5, 10)); * diff --git a/core/DataTable/Filter/MetadataCallbackAddMetadata.php b/core/DataTable/Filter/MetadataCallbackAddMetadata.php index 0f7af76a29..7f6aaef123 100644 --- a/core/DataTable/Filter/MetadataCallbackAddMetadata.php +++ b/core/DataTable/Filter/MetadataCallbackAddMetadata.php @@ -16,7 +16,7 @@ use Piwik\DataTable\BaseFilter; * row as a metadata value. Only metadata values are passed to the callback. * * **Basic usage example** - * + * * // add a logo metadata based on the url metadata * $dataTable->filter('MetadataCallbackAddMetadata', array('url', 'logo', 'Piwik\Plugins\MyPlugin\getLogoFromUrl')); * @@ -31,7 +31,7 @@ class MetadataCallbackAddMetadata extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The DataTable that will eventually be filtered. * @param string|array $metadataToRead The metadata to read from each row and pass to the callback. * @param string $metadataToAdd The name of the metadata to add. @@ -57,7 +57,7 @@ class MetadataCallbackAddMetadata extends BaseFilter /** * See {@link MetadataCallbackAddMetadata}. - * + * * @param DataTable $table */ public function filter($table) diff --git a/core/DataTable/Filter/MetadataCallbackReplace.php b/core/DataTable/Filter/MetadataCallbackReplace.php index 50e773c98e..cb04cdb164 100644 --- a/core/DataTable/Filter/MetadataCallbackReplace.php +++ b/core/DataTable/Filter/MetadataCallbackReplace.php @@ -14,9 +14,9 @@ use Piwik\DataTable\Row; /** * Execute a callback for each row of a {@link DataTable} passing certain column values and metadata * as metadata, and replaces row metadata with the callback result. - * + * * **Basic usage example** - * + * * $dataTable->filter('MetadataCallbackReplace', array('url', function ($url) { * return $url . '#index'; * })); @@ -27,7 +27,7 @@ class MetadataCallbackReplace extends ColumnCallbackReplace { /** * Constructor. - * + * * @param DataTable $table The DataTable that will eventually be filtered. * @param array|string $metadataToFilter The metadata whose values should be passed to the callback * and then replaced with the callback's result. diff --git a/core/DataTable/Filter/Pattern.php b/core/DataTable/Filter/Pattern.php index 94893e6d9e..832fb856a2 100644 --- a/core/DataTable/Filter/Pattern.php +++ b/core/DataTable/Filter/Pattern.php @@ -13,9 +13,9 @@ use Piwik\DataTable\BaseFilter; /** * Deletes every row for which a specific column does not match a supplied regex pattern. - * + * * **Example** - * + * * // filter out all rows whose labels doesn't start with piwik * $dataTable->filter('Pattern', array('label', '^piwik')); * @@ -30,7 +30,7 @@ class Pattern extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The table to eventually filter. * @param string $columnToFilter The column to match with the `$patternToSearch` pattern. * @param string $patternToSearch The regex pattern to use. @@ -74,7 +74,7 @@ class Pattern extends BaseFilter /** * See {@link Pattern}. - * + * * @param DataTable $table */ public function filter($table) diff --git a/core/DataTable/Filter/PatternRecursive.php b/core/DataTable/Filter/PatternRecursive.php index 10bf918f68..697403c2e3 100644 --- a/core/DataTable/Filter/PatternRecursive.php +++ b/core/DataTable/Filter/PatternRecursive.php @@ -16,9 +16,9 @@ use Piwik\DataTable\Manager; /** * Deletes rows that do not contain a column that matches a regex pattern and do not contain a * subtable that contains a column that matches a regex pattern. - * + * * **Example** - * + * * // only display index pageviews in Actions.getPageUrls * $dataTable->filter('PatternRecursive', array('label', 'index')); * @@ -32,7 +32,7 @@ class PatternRecursive extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The table to eventually filter. * @param string $columnToFilter The column to match with the `$patternToSearch` pattern. * @param string $patternToSearch The regex pattern to use. @@ -48,7 +48,7 @@ class PatternRecursive extends BaseFilter /** * See {@link PatternRecursive}. - * + * * @param DataTable $table * @return int The number of deleted rows. */ diff --git a/core/DataTable/Filter/ReplaceColumnNames.php b/core/DataTable/Filter/ReplaceColumnNames.php index 4dd3218902..27875db41a 100644 --- a/core/DataTable/Filter/ReplaceColumnNames.php +++ b/core/DataTable/Filter/ReplaceColumnNames.php @@ -18,15 +18,15 @@ use Piwik\Tracker\GoalManager; /** * Replaces column names in each row of a table using an array that maps old column * names new ones. - * + * * If no mapping is provided, this column will use one that maps index metric names * (which are integers) with their string column names. In the database, reports are * stored with integer metric names because it results in blobs that take up less space. * When loading the reports, the column names must be replaced, which is handled by this * class. (See {@link Piwik\Metrics} for more information about integer metric names.) - * + * * **Basic example** - * + * * // filter use in a plugin's API method * public function getMyReport($idSite, $period, $date, $segment = false, $expanded = false) * { @@ -34,7 +34,7 @@ use Piwik\Tracker\GoalManager; * $dataTable->queueFilter('ReplaceColumnNames'); * return $dataTable; * } - * + * * @api */ class ReplaceColumnNames extends BaseFilter @@ -43,14 +43,14 @@ class ReplaceColumnNames extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The table that will be eventually filtered. * @param array|null $mappingToApply The name mapping to apply. Must map old column names * with new ones, eg, - * + * * array('OLD_COLUMN_NAME' => 'NEW_COLUMN NAME', * 'OLD_COLUMN_NAME2' => 'NEW_COLUMN NAME2') - * + * * If null, {@link Piwik\Metrics::$mappingFromIdToName} is used. */ public function __construct($table, $mappingToApply = null) diff --git a/core/DataTable/Filter/ReplaceSummaryRowLabel.php b/core/DataTable/Filter/ReplaceSummaryRowLabel.php index 23a5926691..3c1e31e2d0 100644 --- a/core/DataTable/Filter/ReplaceSummaryRowLabel.php +++ b/core/DataTable/Filter/ReplaceSummaryRowLabel.php @@ -15,24 +15,24 @@ use Piwik\Piwik; /** * Replaces the label of the summary row with a supplied label. - * + * * This filter is only used to prettify the summary row label and so it should * always be queued on a {@link DataTable}. - * + * * This filter always recurses. In other words, this filter will always apply itself to * all subtables in the given {@link DataTable}'s table hierarchy. - * + * * **Basic example** - * + * * $dataTable->queueFilter('ReplaceSummaryRowLabel', array(Piwik::translate('General_Others'))); - * + * * @api */ class ReplaceSummaryRowLabel extends BaseFilter { /** * Constructor. - * + * * @param DataTable $table The table that will eventually be filtered. * @param string|null $newLabel The new label for summary row. If null, defaults to * `Piwik::translate('General_Others')`. diff --git a/core/DataTable/Filter/SafeDecodeLabel.php b/core/DataTable/Filter/SafeDecodeLabel.php index 8922482398..f2629618b1 100644 --- a/core/DataTable/Filter/SafeDecodeLabel.php +++ b/core/DataTable/Filter/SafeDecodeLabel.php @@ -13,7 +13,7 @@ use Piwik\DataTable\BaseFilter; /** * Sanitizes DataTable labels as an extra precaution. Called internally by Piwik. - * + * */ class SafeDecodeLabel extends BaseFilter { diff --git a/core/DataTable/Filter/Sort.php b/core/DataTable/Filter/Sort.php index e11749a0e4..6ba2cd1ff0 100644 --- a/core/DataTable/Filter/Sort.php +++ b/core/DataTable/Filter/Sort.php @@ -16,7 +16,7 @@ use Piwik\Metrics; /** * Sorts a {@link DataTable} based on the value of a specific column. - * + * * It is possible to specify a natural sorting (see [php.net/natsort](http://php.net/natsort) for details). * * @api @@ -28,7 +28,7 @@ class Sort extends BaseFilter /** * Constructor. - * + * * @param DataTable $table The table to eventually filter. * @param string $columnToSort The name of the column to sort by. * @param string $order order `'asc'` or `'desc'`. diff --git a/core/DataTable/Filter/Truncate.php b/core/DataTable/Filter/Truncate.php index 13d2a619c0..192d85b82f 100644 --- a/core/DataTable/Filter/Truncate.php +++ b/core/DataTable/Filter/Truncate.php @@ -16,26 +16,26 @@ use Piwik\Piwik; /** * Truncates a {@link DataTable} by merging all rows after a certain index into a new summary * row. If the count of rows is less than the index, nothing happens. - * + * * The {@link ReplaceSummaryRowLabel} filter will be queued after the table is truncated. - * + * * ### Examples - * + * * **Basic usage** - * + * * $dataTable->filter('Truncate', array($truncateAfter = 500)); - * + * * **Using a custom summary row label** - * + * * $dataTable->filter('Truncate', array($truncateAfter = 500, $summaryRowLabel = Piwik::translate('General_Total'))); - * + * * @api */ class Truncate extends BaseFilter { /** * Constructor. - * + * * @param DataTable $table The table that will be filtered eventually. * @param int $truncateAfter The row index to truncate at. All rows passed this index will * be removed. diff --git a/core/DataTable/Map.php b/core/DataTable/Map.php index 028c40b480..dd8bec7ca5 100644 --- a/core/DataTable/Map.php +++ b/core/DataTable/Map.php @@ -15,10 +15,10 @@ use Piwik\DataTable\Renderer\Console; /** * Stores an array of {@link DataTable}s indexed by one type of {@link DataTable} metadata (such as site ID * or period). - * + * * DataTable Maps are returned on all queries that involve multiple sites and/or multiple * periods. The Maps will contain a {@link DataTable} for each site and period combination. - * + * * The Map implements some {@link DataTable} such as {@link queueFilter()} and {@link getRowsCount}. * * @@ -73,7 +73,7 @@ class Map implements DataTableInterface /** * Queue a filter to {@link DataTable} child of contained by this instance. - * + * * See {@link Piwik\DataTable::queueFilter()} for more information.. * * @param string|Closure $className Filter name, eg. `'Limit'` or a Closure. @@ -142,7 +142,7 @@ class Map implements DataTableInterface /** * Returns the last element in the Map's array. - * + * * @return DataTable|Map|false */ public function getLastRow() @@ -188,7 +188,7 @@ class Map implements DataTableInterface * Renames the given column in each contained {@link DataTable}. * * See {@link DataTable::renameColumn()}. - * + * * @param string $oldName * @param string $newName */ @@ -203,7 +203,7 @@ class Map implements DataTableInterface * Deletes the specified columns in each contained {@link DataTable}. * * See {@link DataTable::deleteColumns()}. - * + * * @param array $columns The columns to delete. * @param bool $deleteRecursiveInSubtables This param is currently not used. */ @@ -216,7 +216,7 @@ class Map implements DataTableInterface /** * Deletes a table from the array of DataTables. - * + * * @param string $id The label associated with {@link DataTable}. */ public function deleteRow($id) @@ -263,19 +263,19 @@ class Map implements DataTableInterface * The result of this function is determined by the type of DataTable * this instance holds. If this DataTable\Map instance holds an array * of DataTables, this function will transform it from: - * + * * Label 0: * DataTable(row1) * Label 1: * DataTable(row2) - * + * * to: - * + * * DataTable(row1[label = 'Label 0'], row2[label = 'Label 1']) * * If this instance holds an array of DataTable\Maps, this function will * transform it from: - * + * * Outer Label 0: // the outer DataTable\Map * Inner Label 0: // one of the inner DataTable\Maps * DataTable(row1) @@ -286,9 +286,9 @@ class Map implements DataTableInterface * DataTable(row3) * Inner Label 1: * DataTable(row4) - * + * * to: - * + * * Inner Label 0: * DataTable(row1[label = 'Outer Label 0'], row3[label = 'Outer Label 1']) * Inner Label 1: @@ -366,11 +366,11 @@ class Map implements DataTableInterface /** * Sums a DataTable to all the tables in this array. - * + * * _Note: Will only add `$tableToSum` if the childTable has some rows._ * * See {@link Piwik\DataTable::addDataTable()}. - * + * * @param DataTable $tableToSum */ public function addDataTable(DataTable $tableToSum) diff --git a/core/DataTable/Row.php b/core/DataTable/Row.php index 18a7228359..3612cbe96a 100644 --- a/core/DataTable/Row.php +++ b/core/DataTable/Row.php @@ -14,7 +14,7 @@ use Piwik\Metrics; /** * This is what a {@link Piwik\DataTable} is composed of. - * + * * DataTable rows contain columns, metadata and a subtable ID. Columns and metadata * are stored as an array of name => value mappings. * @@ -59,7 +59,7 @@ class Row * Constructor. * * @param array $row An array with the following structure: - * + * * array( * Row::COLUMNS => array('label' => 'Piwik', * 'column1' => 42, @@ -264,7 +264,7 @@ class Row * Returns the array containing all the columns. * * @return array Example: - * + * * array( * 'column1' => VALUE, * 'label' => 'www.php.net' @@ -315,9 +315,9 @@ class Row /** * Sums a DataTable to this row's subtable. If this row has no subtable a new * one is created. - * + * * See {@link Piwik\DataTable::addDataTable()} to learn how DataTables are summed. - * + * * @param DataTable $subTable Table to sum to this row's subtable. */ public function sumSubtable(DataTable $subTable) @@ -495,7 +495,7 @@ class Row * Sums the given `$rowToSum` columns values to the existing row column values. * Only the int or float values will be summed. Label columns will be ignored * even if they have a numeric value. - * + * * Columns in `$rowToSum` that don't exist in `$this` are added to `$this`. * * @param \Piwik\DataTable\Row $rowToSum The row to sum to this row. @@ -573,7 +573,7 @@ class Row /** * Sums the metadata in `$rowToSum` with the metadata in `$this` row. - * + * * @param Row $rowToSum */ public function sumRowMetadata($rowToSum) @@ -597,7 +597,7 @@ class Row /** * Returns `true` if this row is the summary row, `false` if otherwise. This function * depends on the label of the row, and so, is not 100% accurate. - * + * * @return bool */ public function isSummaryRow() @@ -679,10 +679,10 @@ class Row * Helper function that tests if two rows are equal. * * Two rows are equal if: - * + * * - they have exactly the same columns / metadata * - they have a subDataTable associated, then we check that both of them are the same. - * + * * Column order is not important. * * @param \Piwik\DataTable\Row $row1 first to compare diff --git a/core/DataTable/Row/DataTableSummaryRow.php b/core/DataTable/Row/DataTableSummaryRow.php index 480631f2b8..7d477a304c 100644 --- a/core/DataTable/Row/DataTableSummaryRow.php +++ b/core/DataTable/Row/DataTableSummaryRow.php @@ -14,9 +14,9 @@ use Piwik\DataTable\Row; /** * A special row whose column values are the aggregate of the row's subtable. - * + * * This class creates sets its own columns to the sum of each row in the row's subtable. - * + * * Non-numeric columns are bypassed during summation and do not appear in this * rows columns. * @@ -27,7 +27,7 @@ class DataTableSummaryRow extends Row { /** * Constructor. - * + * * @param DataTable|null $subTable The subtable of this row. This parameter is mostly for * convenience. If set, its rows will be summed to this one, * but it will not be set as this row's subtable (so diff --git a/core/DataTable/Simple.php b/core/DataTable/Simple.php index f21aa62b9d..018818c203 100644 --- a/core/DataTable/Simple.php +++ b/core/DataTable/Simple.php @@ -12,7 +12,7 @@ use Piwik\DataTable; /** * A {@link Piwik\DataTable} where every row has two columns: **label** and **value**. - * + * * Simple DataTables are only used to slightly alter the output of some renderers * (notably the XML renderer). * @@ -25,7 +25,7 @@ class Simple extends DataTable * values. * * @param array $array Array containing the rows, eg, - * + * * array( * 'Label row 1' => $value1, * 'Label row 2' => $value2, |