diff --git a/docs/3.x/generated/Piwik/ArchiveProcessor.md b/docs/3.x/generated/Piwik/ArchiveProcessor.md index 65d7b4932..719500b0f 100644 --- a/docs/3.x/generated/Piwik/ArchiveProcessor.md +++ b/docs/3.x/generated/Piwik/ArchiveProcessor.md @@ -169,7 +169,7 @@ and segment. - It accepts the following parameter(s): - `$numericRecords` (`array`) — A name-value mapping of numeric values that should be archived, eg, array('Referrers_distinctKeywords' => 23, 'Referrers_distinctCampaigns' => 234) -- It does not return anything. +- It does not return anything or a mixed result. @@ -187,7 +187,7 @@ Numeric values are not inserted if they equal `0`. The name of the numeric value, eg, `'Referrers_distinctKeywords'`. - `$value` (`float`) — The numeric value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -203,5 +203,5 @@ and segment. The name of the record, eg, 'Referrers_type'. - `$values` (`string`|`array`) — A blob string or an array of blob strings. If an array is used, the first element in the array will be inserted with the `$name` name. The others will be inserted with `$name . '_' . $index` as the record name (where $index is the index of the blob record in `$values`). -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Auth.md b/docs/3.x/generated/Piwik/Auth.md index 994a24402..19dff173d 100644 --- a/docs/3.x/generated/Piwik/Auth.md +++ b/docs/3.x/generated/Piwik/Auth.md @@ -71,7 +71,7 @@ Sets the authentication token to authenticate with. - It accepts the following parameter(s): - `$token_auth` (`string`) — authentication token -- It does not return anything. +- It does not return anything or a mixed result. @@ -110,7 +110,7 @@ Sets the login name to authenticate with. - It accepts the following parameter(s): - `$login` (`string`) — The username. -- It does not return anything. +- It does not return anything or a mixed result. @@ -123,7 +123,7 @@ Sets the password to authenticate with. - It accepts the following parameter(s): - `$password` (`string`) — Password (not hashed). -- It does not return anything. +- It does not return anything or a mixed result. @@ -136,7 +136,7 @@ Sets the hash of the password to authenticate with. The hash will be an MD5 hash - It accepts the following parameter(s): - `$passwordHash` (`string`) — The hashed password. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if authentication by hashed password is not supported. diff --git a/docs/3.x/generated/Piwik/Columns/Dimension.md b/docs/3.x/generated/Piwik/Columns/Dimension.md index 589389530..49f3ec57b 100644 --- a/docs/3.x/generated/Piwik/Columns/Dimension.md +++ b/docs/3.x/generated/Piwik/Columns/Dimension.md @@ -302,7 +302,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -357,7 +357,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -370,7 +370,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -419,7 +419,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -437,7 +437,7 @@ already. - It accepts the following parameter(s): - `$segment` ([`Segment`](../../Piwik/Plugin/Segment.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -504,7 +504,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Columns/Discriminator.md b/docs/3.x/generated/Piwik/Columns/Discriminator.md index 2f5923fd0..9161a0e82 100644 --- a/docs/3.x/generated/Piwik/Columns/Discriminator.md +++ b/docs/3.x/generated/Piwik/Columns/Discriminator.md @@ -40,7 +40,7 @@ Join constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Columns/MetricsList.md b/docs/3.x/generated/Piwik/Columns/MetricsList.md index 3d4f9e873..9699923da 100644 --- a/docs/3.x/generated/Piwik/Columns/MetricsList.md +++ b/docs/3.x/generated/Piwik/Columns/MetricsList.md @@ -29,7 +29,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$metric` ([`Metric`](../../Piwik/Plugin/Metric.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -54,7 +54,7 @@ Removes one or more metrics from the metrics list. The metric category id. Can be a translation token eg 'General_Visits' see Metric::getCategory(). - `$metricName` (`string`|`false`) — The name of the metric to remove eg 'nb_visits'. If not supplied, all metrics within that category will be removed. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Columns/Updater.md b/docs/3.x/generated/Piwik/Columns/Updater.md index f4f0ce110..fd739857c 100644 --- a/docs/3.x/generated/Piwik/Columns/Updater.md +++ b/docs/3.x/generated/Piwik/Columns/Updater.md @@ -46,5 +46,5 @@ See \Piwik\Plugins\ExamplePlugin\Updates\Updates\_0\_0\_2 for an example. - It accepts the following parameter(s): - `$updater` ([`Updater`](../../Piwik/Updater.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Common.md b/docs/3.x/generated/Piwik/Common.md index 4e44260e3..614bdad33 100644 --- a/docs/3.x/generated/Piwik/Common.md +++ b/docs/3.x/generated/Piwik/Common.md @@ -296,5 +296,5 @@ For more information: [https://github.com/piwik/piwik/issues/374](https://github - It accepts the following parameter(s): - `$var` (`mixed`) — The object to destroy. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Config.md b/docs/3.x/generated/Piwik/Config.md index abe74ea4f..bbf02b9e2 100644 --- a/docs/3.x/generated/Piwik/Config.md +++ b/docs/3.x/generated/Piwik/Config.md @@ -66,7 +66,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -88,7 +88,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -103,7 +103,7 @@ Sets a configuration value or section. This section name or value name to set. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,5 +114,5 @@ values are different from the default. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable.md b/docs/3.x/generated/Piwik/DataTable.md index 052920773..efe4b9f22 100644 --- a/docs/3.x/generated/Piwik/DataTable.md +++ b/docs/3.x/generated/Piwik/DataTable.md @@ -259,7 +259,7 @@ Destructor. Makes sure DataTable memory will be cleaned up. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -279,7 +279,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -294,7 +294,7 @@ Sorts the DataTable rows using the supplied callback function. A comparison callback compatible with usort. - `$columnSortedBy` (`string`) — The column name `$functionCallback` sorts by. This is stored so we can determine how the DataTable was sorted in the future. -- It does not return anything. +- It does not return anything or a mixed result. @@ -305,7 +305,7 @@ Sorts the DataTable rows using the supplied callback function. - It accepts the following parameter(s): - `$totalsRow` ([`Row`](../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -313,7 +313,7 @@ Sorts the DataTable rows using the supplied callback function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -338,7 +338,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -349,7 +349,7 @@ will apply filters to every subtable in addition to this instance. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -367,7 +367,7 @@ to all subtables as well. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -382,7 +382,7 @@ Applies a filter to all subtables but not to this datatable. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -401,7 +401,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -420,7 +420,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -431,7 +431,7 @@ for more information. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -454,7 +454,7 @@ metadata can be used to specify a different type of operation. - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -596,7 +596,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array(Row::COLUMNS => array('visits' => 13, 'test' => 'toto'), Row::METADATA => array('mymetadata' => 'myvalue'))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -611,7 +611,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array('name' => 'google analytics', 'license' => 'commercial')` -- It does not return anything. +- It does not return anything or a mixed result. @@ -744,7 +744,7 @@ subtables. - It accepts the following parameter(s): - `$name` (`string`) — Column name to delete. -- It does not return anything. +- It does not return anything or a mixed result. @@ -752,7 +752,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -767,7 +767,7 @@ Rename a column in every row. This change is applied recursively to all subtable Old column name. - `$newName` (`string`) — New column name. -- It does not return anything. +- It does not return anything or a mixed result. @@ -782,7 +782,7 @@ Deletes several columns by name in every row. List of column names to delete. - `$deleteRecursiveInSubtables` (`bool`) — Whether to apply this change to all subtables or not. -- It does not return anything. +- It does not return anything or a mixed result. @@ -795,7 +795,7 @@ Deletes a row by ID. - It accepts the following parameter(s): - `$id` (`int`) — The row ID. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the row `$id` cannot be found. @@ -827,7 +827,7 @@ Deletes a set of rows by ID. - It accepts the following parameter(s): - `$rowIds` (`array`) — The list of row IDs to delete. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If a row ID cannot be found. @@ -923,7 +923,7 @@ _Note: This function will successfully load DataTables serialized by Piwik 1.X._ - It accepts the following parameter(s): - `$serialized` (`string`) — A string with the format of a string in the array returned by [serialize()](http://php.net/function.serialize()). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$serialized` is invalid. @@ -940,7 +940,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure array( // row1 array( Row::COLUMNS => array( col1_name => value1, col2_name => value2, ...), Row::METADATA => array( metadata1_name => value1, ...), // see Row ), // row2 array( ... ), ) -- It does not return anything. +- It does not return anything or a mixed result. @@ -955,7 +955,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure: array( array( col1_name => valueA, col2_name => valueC, ...), array( col1_name => valueB, col2_name => valueD, ...), ) -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$array` is in an incorrect format. @@ -1016,7 +1016,7 @@ have subtables, but the subtables are not. - It accepts the following parameter(s): - `$atLeastLevel` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1046,7 +1046,7 @@ Sets a metadata value by name. The metadata name. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1069,7 +1069,7 @@ Sets several metadata values by name. - It accepts the following parameter(s): - `$values` (`array`) — Array mapping metadata names with metadata values. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1082,7 +1082,7 @@ Sets metadata, erasing existing values. - It accepts the following parameter(s): - `$metadata` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1097,7 +1097,7 @@ rows are summed to the summary row. - It accepts the following parameter(s): - `$maximumAllowedRows` (`int`) — If `0`, the maximum number of rows is unset. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1184,7 +1184,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1192,7 +1192,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1213,7 +1213,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1224,7 +1224,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1237,7 +1237,7 @@ Unsets all queued filters. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1248,5 +1248,5 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/BaseFilter.md b/docs/3.x/generated/Piwik/DataTable/BaseFilter.md index 14ec21ae1..63acca5c8 100644 --- a/docs/3.x/generated/Piwik/DataTable/BaseFilter.md +++ b/docs/3.x/generated/Piwik/DataTable/BaseFilter.md @@ -50,7 +50,7 @@ Manipulates a DataTable in some way. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md index f4fa7f161..11b2cfa74 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md @@ -58,7 +58,7 @@ more information. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md index 8dde300a6..7ff5dab73 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md @@ -76,7 +76,7 @@ more information. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -103,5 +103,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md index 7b6517e79..2cdefb8d0 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md @@ -47,7 +47,7 @@ See [AddSegmentByLabel](/api-reference/Piwik/DataTable/Filter/AddSegmentByLabel) - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md index 0e8709017..58b244f4e 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md @@ -47,7 +47,7 @@ See [AddSegmentByLabelMapping](/api-reference/Piwik/DataTable/Filter/AddSegmentB - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md index 4bb8ec78c..bd6da6ba1 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md @@ -42,7 +42,7 @@ Generates a segment filter based on the label column and the given segment name - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md index f841c7d69..44a243c5f 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md @@ -42,7 +42,7 @@ See [AddSegmentBySegmentValue](/api-reference/Piwik/DataTable/Filter/AddSegmentB - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md index 05e6e9078..86d49022a 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md @@ -48,7 +48,7 @@ See [ColumnCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/ColumnCall - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -62,7 +62,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,5 +75,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md b/docs/3.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md index e3b44cc04..bcd8f92ab 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md @@ -47,7 +47,7 @@ Executes the filter. See [AddSummaryRow](/api-reference/Piwik/DataTable/Filter/A - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md b/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md index dd92d75ec..296b4981a 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md @@ -64,7 +64,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,7 +78,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -91,7 +91,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md b/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md index a5ef78a51..2034b4c8f 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md @@ -56,7 +56,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -70,7 +70,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -83,7 +83,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md b/docs/3.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md index 808309f15..e3db0336b 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md @@ -58,7 +58,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,7 +85,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ Calculates the evolution percentage for two arbitrary values. - It accepts the following parameter(s): - `$number` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,5 +128,5 @@ Calculates the evolution percentage for two arbitrary values. - It accepts the following parameter(s): - `$number` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md index 1d2f090be..e27d3dd5d 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md @@ -54,7 +54,7 @@ See [ColumnCallbackAddColumn](/api-reference/Piwik/DataTable/Filter/ColumnCallba - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -68,7 +68,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,5 +81,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md index 95cf8da8c..a8953bea6 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md @@ -57,7 +57,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -84,5 +84,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md index 955c8d0d0..bbe1a443a 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md @@ -57,7 +57,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -84,5 +84,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md index ae5d99677..cebc68527 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md @@ -52,7 +52,7 @@ See [ColumnCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/ColumnCall - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,5 +79,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md index 3e6ee53c3..e1b3d1db4 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md @@ -44,7 +44,7 @@ See [ColumnCallbackDeleteMetadata](/api-reference/Piwik/DataTable/Filter/ColumnC - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -58,7 +58,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,5 +71,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md index 39b43db9f..978f521f5 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md @@ -51,7 +51,7 @@ Filters the given data table - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -65,7 +65,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,5 +78,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md index 9c6ff76ba..996cbc2fd 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md @@ -59,7 +59,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -73,7 +73,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -86,5 +86,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnDelete.md b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnDelete.md index 3bdd25366..628b69c9a 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ColumnDelete.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ColumnDelete.md @@ -67,7 +67,7 @@ See [ColumnDelete](/api-reference/Piwik/DataTable/Filter/ColumnDelete). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,7 +81,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -94,5 +94,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md b/docs/3.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md index 90ed99598..6472a4013 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md @@ -58,7 +58,7 @@ See [ExcludeLowPopulation](/api-reference/Piwik/DataTable/Filter/ExcludeLowPopul - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/GroupBy.md b/docs/3.x/generated/Piwik/DataTable/Filter/GroupBy.md index 817535170..958219c21 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/GroupBy.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/GroupBy.md @@ -53,7 +53,7 @@ See [GroupBy](/api-reference/Piwik/DataTable/Filter/GroupBy). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -67,7 +67,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -80,5 +80,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/Limit.md b/docs/3.x/generated/Piwik/DataTable/Filter/Limit.md index 1fd66d0fd..045040bea 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/Limit.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/Limit.md @@ -49,7 +49,7 @@ See [Limit](/api-reference/Piwik/DataTable/Filter/Limit). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -63,7 +63,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -76,5 +76,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md b/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md index 551f44a5c..97019df0e 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md @@ -51,7 +51,7 @@ See [MetadataCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/Metadata - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -65,7 +65,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,5 +78,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md b/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md index 24f0b3bc6..771d93366 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md @@ -52,7 +52,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,5 +79,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/Pattern.md b/docs/3.x/generated/Piwik/DataTable/Filter/Pattern.md index cbd7caa03..ba1b8c3b6 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/Pattern.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/Pattern.md @@ -50,7 +50,7 @@ See [Pattern](/api-reference/Piwik/DataTable/Filter/Pattern). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/PatternRecursive.md b/docs/3.x/generated/Piwik/DataTable/Filter/PatternRecursive.md index 28f37b205..5a9687aa2 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/PatternRecursive.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/PatternRecursive.md @@ -47,7 +47,7 @@ See [PatternRecursive](/api-reference/Piwik/DataTable/Filter/PatternRecursive). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/PrependSegment.md b/docs/3.x/generated/Piwik/DataTable/Filter/PrependSegment.md index e8a091199..0acd1e9a9 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/PrependSegment.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/PrependSegment.md @@ -42,7 +42,7 @@ See [PrependValueToMetadata](/api-reference/Piwik/DataTable/Filter/PrependValueT - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md b/docs/3.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md index ccc296b11..8e163116b 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md @@ -44,7 +44,7 @@ See [PrependValueToMetadata](/api-reference/Piwik/DataTable/Filter/PrependValueT - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -58,7 +58,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,5 +71,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md b/docs/3.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md index 196988321..1ed2a9152 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md @@ -42,7 +42,7 @@ See [Limit](/api-reference/Piwik/DataTable/Filter/Limit). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md b/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md index 45ad664d5..31ac170aa 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md @@ -56,7 +56,7 @@ See [ReplaceColumnNames](/api-reference/Piwik/DataTable/Filter/ReplaceColumnName - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -70,7 +70,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -83,5 +83,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md b/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md index 77d8f0746..2ec27bbb0 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md @@ -50,7 +50,7 @@ See [ReplaceSummaryRowLabel](/api-reference/Piwik/DataTable/Filter/ReplaceSummar - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/Sort.md b/docs/3.x/generated/Piwik/DataTable/Filter/Sort.md index f00ca0a1f..468c3736d 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/Sort.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/Sort.md @@ -50,7 +50,7 @@ See [Sort](/api-reference/Piwik/DataTable/Filter/Sort). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Filter/Truncate.md b/docs/3.x/generated/Piwik/DataTable/Filter/Truncate.md index 3e42a5fa6..3c2cefc28 100644 --- a/docs/3.x/generated/Piwik/DataTable/Filter/Truncate.md +++ b/docs/3.x/generated/Piwik/DataTable/Filter/Truncate.md @@ -58,7 +58,7 @@ Executes the filter, see [Truncate](/api-reference/Piwik/DataTable/Filter/Trunca - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Map.md b/docs/3.x/generated/Piwik/DataTable/Map.md index b885a20d5..47d78554a 100644 --- a/docs/3.x/generated/Piwik/DataTable/Map.md +++ b/docs/3.x/generated/Piwik/DataTable/Map.md @@ -70,7 +70,7 @@ Set the name of they metadata used to index DataTables. See [getKeyName()](/api- - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -97,7 +97,7 @@ See [DataTable::queueFilter()](/api-reference/Piwik/DataTable#queuefilter) for m Filter name, eg. `'Limit'` or a Closure. - `$parameters` (`array`) — Filter parameters, eg. `array(50, 10)`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ Apply the filters previously queued to each DataTable contained by this DataTabl #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -122,7 +122,7 @@ Apply a filter to all tables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -137,7 +137,7 @@ Apply a filter to all subtables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -152,7 +152,7 @@ Apply a queued filter to all subtables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -229,7 +229,7 @@ Adds a new DataTable or Map instance to this DataTable\Map. - `$label` (`string`) — Label used to index this table in the array. -- It does not return anything. +- It does not return anything or a mixed result. @@ -240,7 +240,7 @@ Adds a new DataTable or Map instance to this DataTable\Map. - It accepts the following parameter(s): - `$idSubtable` -- It does not return anything. +- It does not return anything or a mixed result. @@ -261,7 +261,7 @@ See DataTable::enableRecursiveSort(). #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -274,7 +274,7 @@ See DataTable::disableFilter(). - It accepts the following parameter(s): - `$className` -- It does not return anything. +- It does not return anything or a mixed result. @@ -291,7 +291,7 @@ See DataTable::renameColumn(). - `$newName` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -308,7 +308,7 @@ See DataTable::deleteColumns(). The columns to delete. - `$deleteRecursiveInSubtables` (`bool`) — This param is currently not used. -- It does not return anything. +- It does not return anything or a mixed result. @@ -321,7 +321,7 @@ Deletes a table from the array of DataTables. - It accepts the following parameter(s): - `$id` (`string`) — The label associated with DataTable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -338,7 +338,7 @@ Deletes the given column in every contained DataTable. - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -426,7 +426,7 @@ See [DataTable::addDataTable()](/api-reference/Piwik/DataTable#adddatatable). - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Row.md b/docs/3.x/generated/Piwik/DataTable/Row.md index 574cf2ba4..ed1d7a574 100644 --- a/docs/3.x/generated/Piwik/DataTable/Row.md +++ b/docs/3.x/generated/Piwik/DataTable/Row.md @@ -120,7 +120,7 @@ Renames a column. The current name of the column. - `$newName` (`string`) — The new name of the column. -- It does not return anything. +- It does not return anything or a mixed result. @@ -222,7 +222,7 @@ See [DataTable::addDataTable()](/api-reference/Piwik/DataTable#adddatatable) to - It accepts the following parameter(s): - `$subTable` ([`DataTable`](../../Piwik/DataTable.md)) — Table to sum to this row's subtable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -258,7 +258,7 @@ Removes the subtable reference. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ Set all the columns at once. Overwrites **all** previously set columns. - It accepts the following parameter(s): - `$columns` (`array`) — eg, `array('label' => 'www.php.net', 'nb_visits' => 15894)` -- It does not return anything. +- It does not return anything or a mixed result. @@ -286,7 +286,7 @@ Set the value `$value` to the column called `$name`. name of the column to set. - `$value` (`mixed`) — value of the column to set. -- It does not return anything. +- It does not return anything or a mixed result. @@ -301,7 +301,7 @@ Set the value `$value` to the metadata called `$name`. name of the metadata to set. - `$value` (`mixed`) — value of the metadata to set. -- It does not return anything. +- It does not return anything or a mixed result. @@ -331,7 +331,7 @@ Add a new column to the row. If the column already exists, throws an exception. name of the column to add. - `$value` (`mixed`) — value of the column to set or a PHP callable. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the column already exists. @@ -363,7 +363,7 @@ Add a new metadata to the row. If the metadata already exists, throws an excepti name of the metadata to add. - `$value` (`mixed`) — value of the metadata to set. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the metadata already exists. @@ -387,7 +387,7 @@ Columns in `$rowToSum` that don't exist in `$this` are added to `$this`. Whether metadata should be copied or not. - `$aggregationOperations` (`array`|`bool`) — for columns that should not be summed, determine which aggregation should be used (min, max). format: `array('column name' => 'function name')` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -404,7 +404,7 @@ Sums the metadata in `$rowToSum` with the metadata in `$this` row. - `$aggregationOperations` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -440,7 +440,7 @@ Associates the supplied table with this row as the comparisons table. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DataTable/Simple.md b/docs/3.x/generated/Piwik/DataTable/Simple.md index 6b0a406f3..67e0ed3f7 100644 --- a/docs/3.x/generated/Piwik/DataTable/Simple.md +++ b/docs/3.x/generated/Piwik/DataTable/Simple.md @@ -129,7 +129,7 @@ Destructor. Makes sure DataTable memory will be cleaned up. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -141,7 +141,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -149,7 +149,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -164,7 +164,7 @@ Sorts the DataTable rows using the supplied callback function. A comparison callback compatible with usort. - `$columnSortedBy` (`string`) — The column name `$functionCallback` sorts by. This is stored so we can determine how the DataTable was sorted in the future. -- It does not return anything. +- It does not return anything or a mixed result. @@ -175,7 +175,7 @@ Sorts the DataTable rows using the supplied callback function. - It accepts the following parameter(s): - `$totalsRow` ([`Row`](../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -183,7 +183,7 @@ Sorts the DataTable rows using the supplied callback function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -208,7 +208,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -219,7 +219,7 @@ will apply filters to every subtable in addition to this instance. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -237,7 +237,7 @@ to all subtables as well. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -252,7 +252,7 @@ Applies a filter to all subtables but not to this datatable. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -290,7 +290,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -301,7 +301,7 @@ for more information. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -324,7 +324,7 @@ metadata can be used to specify a different type of operation. - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -466,7 +466,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array(Row::COLUMNS => array('visits' => 13, 'test' => 'toto'), Row::METADATA => array('mymetadata' => 'myvalue'))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -481,7 +481,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array('name' => 'google analytics', 'license' => 'commercial')` -- It does not return anything. +- It does not return anything or a mixed result. @@ -614,7 +614,7 @@ subtables. - It accepts the following parameter(s): - `$name` (`string`) — Column name to delete. -- It does not return anything. +- It does not return anything or a mixed result. @@ -622,7 +622,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -637,7 +637,7 @@ Rename a column in every row. This change is applied recursively to all subtable Old column name. - `$newName` (`string`) — New column name. -- It does not return anything. +- It does not return anything or a mixed result. @@ -652,7 +652,7 @@ Deletes several columns by name in every row. List of column names to delete. - `$deleteRecursiveInSubtables` (`bool`) — Whether to apply this change to all subtables or not. -- It does not return anything. +- It does not return anything or a mixed result. @@ -665,7 +665,7 @@ Deletes a row by ID. - It accepts the following parameter(s): - `$id` (`int`) — The row ID. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the row `$id` cannot be found. @@ -697,7 +697,7 @@ Deletes a set of rows by ID. - It accepts the following parameter(s): - `$rowIds` (`array`) — The list of row IDs to delete. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If a row ID cannot be found. @@ -793,7 +793,7 @@ _Note: This function will successfully load DataTables serialized by Piwik 1.X._ - It accepts the following parameter(s): - `$serialized` (`string`) — A string with the format of a string in the array returned by [serialize()](http://php.net/function.serialize()). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$serialized` is invalid. @@ -809,7 +809,7 @@ values. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure array( // row1 array( Row::COLUMNS => array( col1_name => value1, col2_name => value2, ...), Row::METADATA => array( metadata1_name => value1, ...), // see Row ), // row2 array( ... ), ) -- It does not return anything. +- It does not return anything or a mixed result. @@ -824,7 +824,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure: array( array( col1_name => valueA, col2_name => valueC, ...), array( col1_name => valueB, col2_name => valueD, ...), ) -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$array` is in an incorrect format. @@ -885,7 +885,7 @@ have subtables, but the subtables are not. - It accepts the following parameter(s): - `$atLeastLevel` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -915,7 +915,7 @@ Sets a metadata value by name. The metadata name. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -938,7 +938,7 @@ Sets several metadata values by name. - It accepts the following parameter(s): - `$values` (`array`) — Array mapping metadata names with metadata values. -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ Sets metadata, erasing existing values. - It accepts the following parameter(s): - `$metadata` -- It does not return anything. +- It does not return anything or a mixed result. @@ -966,7 +966,7 @@ rows are summed to the summary row. - It accepts the following parameter(s): - `$maximumAllowedRows` (`int`) — If `0`, the maximum number of rows is unset. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1053,7 +1053,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1061,7 +1061,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1082,7 +1082,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1093,7 +1093,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1106,7 +1106,7 @@ Unsets all queued filters. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1117,5 +1117,5 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Db.md b/docs/3.x/generated/Piwik/Db.md index 50471a467..0a673387d 100644 --- a/docs/3.x/generated/Piwik/Db.md +++ b/docs/3.x/generated/Piwik/Db.md @@ -126,7 +126,7 @@ Shouldn't be called directly, use [get()](/api-reference/Piwik/Db#get) instead. - It accepts the following parameter(s): - `$dbConfig` (`array`|`null`) — Connection parameters in an array. Defaults to the `[database]` INI config section. -- It does not return anything. +- It does not return anything or a mixed result. @@ -143,7 +143,7 @@ Shouldn't be called directly, use [get()](/api-reference/Piwik/Db#get) instead. - It accepts the following parameter(s): - `$dbConfig` (`array`|`null`) — Connection parameters in an array. Defaults to the `[database]` INI config section. -- It does not return anything. +- It does not return anything or a mixed result. @@ -155,7 +155,7 @@ For tests. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -352,7 +352,7 @@ Drops all tables #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -535,7 +535,7 @@ the table will not be locked for too long. The maximum number of rows to scan in one query. - `$params` (`array`) — Parameters to bind in the query, `array(param1 => value1, param2 => value2)` -- It does not return anything. +- It does not return anything or a mixed result. @@ -591,7 +591,7 @@ Checks whether the database user is allowed to lock tables. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -610,5 +610,5 @@ Checks whether the database user is allowed to lock tables. - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/DbHelper.md b/docs/3.x/generated/Piwik/DbHelper.md index 93d639c03..9fbf35337 100644 --- a/docs/3.x/generated/Piwik/DbHelper.md +++ b/docs/3.x/generated/Piwik/DbHelper.md @@ -33,5 +33,5 @@ DbHelper::createTable('tablename', $tableDefinition); The name of the table without any piwik prefix. - `$createDefinition` (`string`) — The table create definition -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Filesystem.md b/docs/3.x/generated/Piwik/Filesystem.md index 57bcfe642..8f370ca6d 100644 --- a/docs/3.x/generated/Piwik/Filesystem.md +++ b/docs/3.x/generated/Piwik/Filesystem.md @@ -30,7 +30,7 @@ _Note: This function does **not** create directories recursively._ - It accepts the following parameter(s): - `$path` (`string`) — The path of the directory to create. -- It does not return anything. +- It does not return anything or a mixed result. @@ -68,7 +68,7 @@ Recursively deletes a directory. If true, `$dir` is deleted, otherwise just its contents. - `$beforeUnlink` ([`Closure`](http://php.net/class.Closure)) — An optional closure to execute on a file path before unlinking. -- It does not return anything. +- It does not return anything or a mixed result. @@ -104,7 +104,7 @@ Copies the contents of a directory recursively from `$source` to `$target`. A directory to copy to, eg. '.'. - `$excludePhp` (`bool`) — Whether to avoid copying files if the file is related to PHP (includes .php, .tpl, .twig files). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `Piwik\Exception\Exception` — If a file cannot be copied. diff --git a/docs/3.x/generated/Piwik/Log.md b/docs/3.x/generated/Piwik/Log.md index 1d1b410f7..541943f7c 100644 --- a/docs/3.x/generated/Piwik/Log.md +++ b/docs/3.x/generated/Piwik/Log.md @@ -77,7 +77,7 @@ Logs a message using the ERROR log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -94,7 +94,7 @@ Logs a message using the WARNING log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Logs a message using the INFO log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,7 +128,7 @@ Logs a message using the DEBUG log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -145,5 +145,5 @@ Logs a message using the VERBOSE log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Mail.md b/docs/3.x/generated/Piwik/Mail.md index 1e1a2091a..ee0dbe510 100644 --- a/docs/3.x/generated/Piwik/Mail.md +++ b/docs/3.x/generated/Piwik/Mail.md @@ -39,7 +39,7 @@ Constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -50,7 +50,7 @@ Constructor. - It accepts the following parameter(s): - `$body` ([`View`](../Piwik/View.md)|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `DI\NotFoundException` @@ -93,7 +93,7 @@ Set Reply-To Header - It accepts the following parameter(s): - `$transport` -- It does not return anything. +- It does not return anything or a mixed result. @@ -112,7 +112,7 @@ Set Reply-To Header - `$filename` -- It does not return anything. +- It does not return anything or a mixed result. @@ -123,7 +123,7 @@ Set Reply-To Header - It accepts the following parameter(s): - `$subject` -- It does not return anything. +- It does not return anything or a mixed result. @@ -131,7 +131,7 @@ Set Reply-To Header #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Measurable/Measurable.md b/docs/3.x/generated/Piwik/Measurable/Measurable.md index 2147af737..8815783b0 100644 --- a/docs/3.x/generated/Piwik/Measurable/Measurable.md +++ b/docs/3.x/generated/Piwik/Measurable/Measurable.md @@ -71,7 +71,7 @@ individual site data. - It accepts the following parameter(s): - `$sites` (`array`) — The array of sites data. Indexed by site ID. eg, array('1' => array('name' => 'Site 1', ...), '2' => array('name' => 'Site 2', ...))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -278,7 +278,7 @@ See also [setSites()](/api-reference/Piwik/Measurable/Measurable#setsites) and s #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -293,7 +293,7 @@ See also [setSites()](/api-reference/Piwik/Measurable/Measurable#setsites) and s - It accepts the following parameter(s): - `$idSite` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Menu/MenuAbstract.md b/docs/3.x/generated/Piwik/Menu/MenuAbstract.md index fde0ce379..71c93f13f 100644 --- a/docs/3.x/generated/Piwik/Menu/MenuAbstract.md +++ b/docs/3.x/generated/Piwik/Menu/MenuAbstract.md @@ -56,7 +56,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,5 +107,5 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Menu/MenuAdmin.md b/docs/3.x/generated/Piwik/Menu/MenuAdmin.md index eba93fa98..b9995dd79 100644 --- a/docs/3.x/generated/Piwik/Menu/MenuAdmin.md +++ b/docs/3.x/generated/Piwik/Menu/MenuAdmin.md @@ -61,7 +61,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -76,7 +76,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -95,7 +95,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -112,7 +112,7 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. @@ -133,7 +133,7 @@ See add(). Adds a new menu item to the manage section of the user menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -154,7 +154,7 @@ See add(). Adds a new menu item to the development section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -175,7 +175,7 @@ See add(). Adds a new menu item to the diagnostic section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -196,7 +196,7 @@ See add(). Adds a new menu item to the platform section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -217,7 +217,7 @@ See add(). Adds a new menu item to the measurable section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -238,5 +238,5 @@ See add(). Adds a new menu item to the manage section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Menu/MenuTop.md b/docs/3.x/generated/Piwik/Menu/MenuTop.md index 01fd51440..eb5efe3aa 100644 --- a/docs/3.x/generated/Piwik/Menu/MenuTop.md +++ b/docs/3.x/generated/Piwik/Menu/MenuTop.md @@ -56,7 +56,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,5 +128,5 @@ Directly adds a menu entry containing html. - `$tooltip` (`string`) — Tooltip to display. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Metrics.md b/docs/3.x/generated/Piwik/Metrics.md index cf156a86b..b7d4fdd86 100644 --- a/docs/3.x/generated/Piwik/Metrics.md +++ b/docs/3.x/generated/Piwik/Metrics.md @@ -58,7 +58,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,7 +74,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -82,7 +82,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -98,7 +98,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -106,7 +106,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$columnIdRaw` -- It does not return anything. +- It does not return anything or a mixed result. @@ -125,7 +125,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -133,7 +133,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -141,5 +141,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Metrics/Formatter.md b/docs/3.x/generated/Piwik/Metrics/Formatter.md index d3b6876c7..e410122cb 100644 --- a/docs/3.x/generated/Piwik/Metrics/Formatter.md +++ b/docs/3.x/generated/Piwik/Metrics/Formatter.md @@ -117,5 +117,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Metrics/Formatter/Html.md b/docs/3.x/generated/Piwik/Metrics/Formatter/Html.md index f31ec903c..85c7f62e8 100644 --- a/docs/3.x/generated/Piwik/Metrics/Formatter/Html.md +++ b/docs/3.x/generated/Piwik/Metrics/Formatter/Html.md @@ -117,5 +117,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Nonce.md b/docs/3.x/generated/Piwik/Nonce.md index 51e02daa5..79d2a7b4a 100644 --- a/docs/3.x/generated/Piwik/Nonce.md +++ b/docs/3.x/generated/Piwik/Nonce.md @@ -74,7 +74,7 @@ Force expiration of the current nonce. - It accepts the following parameter(s): - `$id` (`string`) — The unique nonce ID. -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Verifies and discards a nonce. The nonce's unique ID. See [getNonce()](/api-reference/Piwik/Nonce#getnonce). - `$nonce` (`string`|`null`) — The nonce from the client. If `null`, the value from the **nonce** query parameter is used. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the nonce is invalid. See {@link verifyNonce()}. diff --git a/docs/3.x/generated/Piwik/Notification/Manager.md b/docs/3.x/generated/Piwik/Notification/Manager.md index 9e8fa5ba2..db4bb1e18 100644 --- a/docs/3.x/generated/Piwik/Notification/Manager.md +++ b/docs/3.x/generated/Piwik/Notification/Manager.md @@ -26,5 +26,5 @@ has been posted and has not been closed/removed, it will be replaced with `$noti A unique identifier for this notification. The ID must be a valid HTML element ID. It can only contain alphanumeric characters (underscores can be used). - `$notification` ([`Notification`](../../Piwik/Notification.md)) — The notification to post. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Option.md b/docs/3.x/generated/Piwik/Option.md index 2b89cd6bf..f3239c2df 100644 --- a/docs/3.x/generated/Piwik/Option.md +++ b/docs/3.x/generated/Piwik/Option.md @@ -81,7 +81,7 @@ Sets an option value by name. - `$autoload` -- It does not return anything. +- It does not return anything or a mixed result. @@ -96,7 +96,7 @@ Deletes an option. Option name to match exactly. - `$value` (`string`) — If supplied the option will be deleted only if its value matches this value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Deletes all options that match the supplied pattern. Pattern of key to match. `'%'` characters should be used as wildcards, and literal `'_'` characters should be escaped. - `$value` (`string`) — If supplied, options will be deleted only if their value matches this value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -122,5 +122,5 @@ Deletes all options that match the supplied pattern. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Period.md b/docs/3.x/generated/Piwik/Period.md index 115222453..34e7007dd 100644 --- a/docs/3.x/generated/Piwik/Period.md +++ b/docs/3.x/generated/Piwik/Period.md @@ -46,7 +46,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -54,7 +54,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -94,7 +94,7 @@ For valid date formats have a look at the [Date::factory()](/api-reference/Piwik - It accepts the following parameter(s): - `$dateString` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If `$dateString` is in an invalid format or if the time is before Tue, 06 Aug 1991. diff --git a/docs/3.x/generated/Piwik/Period/Range.md b/docs/3.x/generated/Piwik/Period/Range.md index 55f80b9bd..cd54847d1 100644 --- a/docs/3.x/generated/Piwik/Period/Range.md +++ b/docs/3.x/generated/Piwik/Period/Range.md @@ -52,7 +52,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -60,7 +60,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -100,7 +100,7 @@ For valid date formats have a look at the [Date::factory()](/api-reference/Piwik - It accepts the following parameter(s): - `$dateString` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If `$dateString` is in an invalid format or if the time is before Tue, 06 Aug 1991. @@ -303,7 +303,7 @@ Sets the default end date of the period. - It accepts the following parameter(s): - `$oDate` ([`Date`](../../Piwik/Date.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -387,7 +387,7 @@ the range spans over. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -395,5 +395,5 @@ the range spans over. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Piwik.md b/docs/3.x/generated/Piwik/Piwik.md index 478b9d9c0..bb06ece45 100644 --- a/docs/3.x/generated/Piwik/Piwik.md +++ b/docs/3.x/generated/Piwik/Piwik.md @@ -99,7 +99,7 @@ Check that the current user is either the specified user or the superuser. - It accepts the following parameter(s): - `$theUser` (`string`) — A username. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../Piwik/NoAccessException.md) — If the user is neither the Super User nor the user `$theUser`. @@ -144,7 +144,7 @@ Checks that the user is not the anonymous user. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../Piwik/NoAccessException.md) — if the current user is the anonymous user. @@ -156,7 +156,7 @@ Check that the current user has superuser access. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user is not the superuser. @@ -184,7 +184,7 @@ Checks that the current user has admin access to the requested list of sites. - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — One or more site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If user doesn't have admin access. @@ -206,7 +206,7 @@ Checks that the current user has write access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have write access to any site. @@ -243,7 +243,7 @@ Checks that the current user has admin access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have admin access to any site. @@ -284,7 +284,7 @@ Checks that the current user has view access to the requested list of sites - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — The list of site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user does not have view access to every site in the list. @@ -299,7 +299,7 @@ Checks that the current user has write access to the requested list of sites - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — The list of site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user does not have write access to every site in the list. @@ -321,7 +321,7 @@ Checks that the current user has view access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have view access to any site. @@ -353,7 +353,7 @@ Redirects the current request to a new module and action. The target controller action, eg, `'index'`. - `$parameters` (`array`) — The query parameter values to modify before redirecting. -- It does not return anything. +- It does not return anything or a mixed result. @@ -385,7 +385,7 @@ Post an event to Piwik's event dispatcher which will execute the event's observe If true, plugins that are loaded after this event is fired will have their observers for this event executed. - `$plugins` (`array`|`null`) — The list of plugins to execute observers for. If null, all plugin observers will be executed. -- It does not return anything. +- It does not return anything or a mixed result. @@ -403,7 +403,7 @@ need to use this function._** The event name. - `$function` (`callable`|`array`) — The observer. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin.md b/docs/3.x/generated/Piwik/Plugin.md index ef241a440..8a54617ff 100644 --- a/docs/3.x/generated/Piwik/Plugin.md +++ b/docs/3.x/generated/Piwik/Plugin.md @@ -120,7 +120,7 @@ Constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -147,7 +147,7 @@ Returns plugin information, including: #### Signature - It is a **finalized** method. -- It does not return anything. +- It does not return anything or a mixed result. @@ -187,7 +187,7 @@ Useful for initialization code that uses translated strings. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -214,7 +214,7 @@ needs to: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if installation of fails for some reason. @@ -230,7 +230,7 @@ an [uninstall()](/api-reference/Piwik/Plugin#uninstall) method. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if uninstallation of fails for some reason. @@ -242,7 +242,7 @@ Executed every time the plugin is enabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -252,7 +252,7 @@ Executed every time the plugin is disabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -316,7 +316,7 @@ Tries to find a component such as a Menu or Tasks within this plugin. - `$expectedSubclass` -- It does not return anything. +- It does not return anything or a mixed result. @@ -340,7 +340,7 @@ Detect whether there are any missing dependencies. - It accepts the following parameter(s): - `$piwikVersion` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Archiver.md b/docs/3.x/generated/Piwik/Plugin/Archiver.md index 1b0c341a0..f07d952ca 100644 --- a/docs/3.x/generated/Piwik/Plugin/Archiver.md +++ b/docs/3.x/generated/Piwik/Plugin/Archiver.md @@ -81,7 +81,7 @@ Aggregate log table rows using a [LogAggregator](/api-reference/Piwik/DataAccess #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -99,7 +99,7 @@ method. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -129,7 +129,7 @@ for this period, segment and site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Controller.md b/docs/3.x/generated/Piwik/Plugin/Controller.md index 6b33ad7ff..a5b60ad18 100644 --- a/docs/3.x/generated/Piwik/Plugin/Controller.md +++ b/docs/3.x/generated/Piwik/Plugin/Controller.md @@ -294,7 +294,7 @@ Sets the first date available in the period selector's calendar. The min date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -310,7 +310,7 @@ for a site (which varies based on the timezone of a site). The max date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -370,7 +370,7 @@ Also calls [setHostValidationVariablesView()](/api-reference/Piwik/Plugin/Contro - It accepts the following parameter(s): - `$view` -- It does not return anything. +- It does not return anything or a mixed result. @@ -389,7 +389,7 @@ Checks if the current host is valid and sets variables on the given view, includ - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -408,7 +408,7 @@ Sets general period variables on a view, including: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current period is invalid. @@ -435,7 +435,7 @@ This function will exit immediately after executing. The new date query parameter, eg, `'today'`. - `$parameters` (`array`) — Other query parameters to append to the URL. -- It does not return anything. +- It does not return anything or a mixed result. @@ -453,7 +453,7 @@ If called from JavaScript by using the `ajaxHelper` you have to call `ajaxHelper #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../../Piwik/NoAccessException.md) — If the token doesn't match. diff --git a/docs/3.x/generated/Piwik/Plugin/ControllerAdmin.md b/docs/3.x/generated/Piwik/Plugin/ControllerAdmin.md index 6907816be..eba2301a3 100644 --- a/docs/3.x/generated/Piwik/Plugin/ControllerAdmin.md +++ b/docs/3.x/generated/Piwik/Plugin/ControllerAdmin.md @@ -272,7 +272,7 @@ Sets the first date available in the period selector's calendar. The min date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -288,7 +288,7 @@ for a site (which varies based on the timezone of a site). The max date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -348,7 +348,7 @@ Also calls [setHostValidationVariablesView()](/api-reference/Piwik/Plugin/Contro - It accepts the following parameter(s): - `$view` -- It does not return anything. +- It does not return anything or a mixed result. @@ -367,7 +367,7 @@ Checks if the current host is valid and sets variables on the given view, includ - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -386,7 +386,7 @@ Sets general period variables on a view, including: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current period is invalid. @@ -413,7 +413,7 @@ This function will exit immediately after executing. The new date query parameter, eg, `'today'`. - `$parameters` (`array`) — Other query parameters to append to the URL. -- It does not return anything. +- It does not return anything or a mixed result. @@ -431,7 +431,7 @@ If called from JavaScript by using the `ajaxHelper` you have to call `ajaxHelper #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../../Piwik/NoAccessException.md) — If the token doesn't match. @@ -475,5 +475,5 @@ Assigns the following variables: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Dimension/ActionDimension.md b/docs/3.x/generated/Piwik/Plugin/Dimension/ActionDimension.md index a3d6c2def..241167705 100644 --- a/docs/3.x/generated/Piwik/Plugin/Dimension/ActionDimension.md +++ b/docs/3.x/generated/Piwik/Plugin/Dimension/ActionDimension.md @@ -314,7 +314,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -369,7 +369,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -382,7 +382,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -431,7 +431,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -449,7 +449,7 @@ already. - It accepts the following parameter(s): - `$segment` ([`Segment`](../../../Piwik/Plugin/Segment.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -516,7 +516,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md b/docs/3.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md index 61a2361f7..6b2e45842 100644 --- a/docs/3.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md +++ b/docs/3.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md @@ -315,7 +315,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -370,7 +370,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -383,7 +383,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -432,7 +432,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -450,7 +450,7 @@ already. - It accepts the following parameter(s): - `$segment` ([`Segment`](../../../Piwik/Plugin/Segment.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -517,7 +517,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Dimension/VisitDimension.md b/docs/3.x/generated/Piwik/Plugin/Dimension/VisitDimension.md index 9320fbfb3..a1546bc40 100644 --- a/docs/3.x/generated/Piwik/Plugin/Dimension/VisitDimension.md +++ b/docs/3.x/generated/Piwik/Plugin/Dimension/VisitDimension.md @@ -317,7 +317,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -372,7 +372,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -385,7 +385,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -434,7 +434,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -452,7 +452,7 @@ already. - It accepts the following parameter(s): - `$segment` ([`Segment`](../../../Piwik/Plugin/Segment.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -519,7 +519,7 @@ Get all visit dimensions that are defined by all activated plugins. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Menu.md b/docs/3.x/generated/Piwik/Plugin/Menu.md index 6ef7ae0be..fe98dcb95 100644 --- a/docs/3.x/generated/Piwik/Plugin/Menu.md +++ b/docs/3.x/generated/Piwik/Plugin/Menu.md @@ -107,7 +107,7 @@ Configures the top menu which is supposed to contain analytics related items suc - It accepts the following parameter(s): - `$menu` ([`MenuTop`](../../Piwik/Menu/MenuTop.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -121,5 +121,5 @@ Configures the admin menu which is supposed to contain only administration relat - It accepts the following parameter(s): - `$menu` ([`MenuAdmin`](../../Piwik/Menu/MenuAdmin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Report.md b/docs/3.x/generated/Piwik/Plugin/Report.md index b9f9747b9..dd57316f4 100644 --- a/docs/3.x/generated/Piwik/Plugin/Report.md +++ b/docs/3.x/generated/Piwik/Plugin/Report.md @@ -222,7 +222,7 @@ created in most page requests. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -253,7 +253,7 @@ throw new Exception('Setting XYZ is not enabled or the user has not enough permi #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -293,7 +293,7 @@ default request config. For instance you can change how many rows are displayed - It accepts the following parameter(s): - `$view` ([`ViewDataTable`](../../Piwik/Plugin/ViewDataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -344,7 +344,7 @@ $widgetsList->addToContainerWidget($containerId = 'Products', $factory->createWi - `$factory` ([`ReportWidgetFactory`](../../Piwik/Report/ReportWidgetFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -461,7 +461,7 @@ the current requested date, period and site. - `$infos` -- It does not return anything. +- It does not return anything or a mixed result. @@ -517,7 +517,7 @@ recommended related report. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Segment.md b/docs/3.x/generated/Piwik/Plugin/Segment.md index 5b17b4d89..023b911f6 100644 --- a/docs/3.x/generated/Piwik/Plugin/Segment.md +++ b/docs/3.x/generated/Piwik/Plugin/Segment.md @@ -49,7 +49,7 @@ created. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ this as well. For example "Any URL including protocol. The URL must be URL encod - It accepts the following parameter(s): - `$acceptedValues` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,7 +78,7 @@ or 'General_Visit'. - It accepts the following parameter(s): - `$category` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ translation key such as 'Actions_ColumnEntryPageTitle' or 'Resolution_ColumnReso - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ you need to set "&segment=searches>0" in the UI. - It accepts the following parameter(s): - `$segment` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -127,7 +127,7 @@ If the closure returns NULL, then Piwik assumes the segment sub-string will not - It accepts the following parameter(s): - `$sqlFilter` (`string`|[`Closure`](http://php.net/class.Closure)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -143,7 +143,7 @@ segment. This callback is called shortly before [setSqlFilter()](/api-reference/ - It accepts the following parameter(s): - `$sqlFilterValue` (`string`|`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -157,7 +157,7 @@ Defines to which column in the MySQL database the segment belongs: 'mytablename. - It accepts the following parameter(s): - `$sqlSegment` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -172,7 +172,7 @@ All set segments will be applied via an OR operator. - It accepts the following parameter(s): - `$segments` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -185,7 +185,7 @@ Set (overwrite) the type of this segment which is usually either a 'dimension' o - It accepts the following parameter(s): - `$type` (`string`) — See constansts TYPE_* -- It does not return anything. +- It does not return anything or a mixed result. @@ -208,7 +208,7 @@ Set callback which will be executed when user will call for suggested values for - It accepts the following parameter(s): - `$suggestedValuesCallback` (`callable`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -221,7 +221,7 @@ Set callback which will be executed when user will call for suggested values for - It accepts the following parameter(s): - `$suggestedValuesApi` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -236,7 +236,7 @@ a certain segment only available to users having super user access you could do - It accepts the following parameter(s): - `$permission` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -251,7 +251,7 @@ These types of segments are, for example, used in unions for other segments, but - It accepts the following parameter(s): - `$value` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Tasks.md b/docs/3.x/generated/Piwik/Plugin/Tasks.md index 1a19950fa..1788086a1 100644 --- a/docs/3.x/generated/Piwik/Plugin/Tasks.md +++ b/docs/3.x/generated/Piwik/Plugin/Tasks.md @@ -54,7 +54,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. @@ -73,7 +73,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/ViewDataTable.md b/docs/3.x/generated/Piwik/Plugin/ViewDataTable.md index e9d0dad96..5a797fdb0 100644 --- a/docs/3.x/generated/Piwik/Plugin/ViewDataTable.md +++ b/docs/3.x/generated/Piwik/Plugin/ViewDataTable.md @@ -328,7 +328,7 @@ Display a meaningful error message when any invalid parameter is being set. - It accepts the following parameter(s): - `$overrideParams` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `` @@ -371,5 +371,5 @@ default, it is assumed visualizations do not support comparison. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugin/Visualization.md b/docs/3.x/generated/Piwik/Plugin/Visualization.md index 12284ad8b..b0c8e1d09 100644 --- a/docs/3.x/generated/Piwik/Plugin/Visualization.md +++ b/docs/3.x/generated/Piwik/Plugin/Visualization.md @@ -338,7 +338,7 @@ Display a meaningful error message when any invalid parameter is being set. - It accepts the following parameter(s): - `$overrideParams` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `` @@ -381,7 +381,7 @@ default, it is assumed visualizations do not support comparison. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -397,7 +397,7 @@ Assigns a template variable making it available in the Twig template specified b One or more variable names to set. - `$value` (`mixed`) — The value to set each variable to. -- It does not return anything. +- It does not return anything or a mixed result. @@ -409,7 +409,7 @@ Derived classes should override this method if they change the amount of data th #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -422,7 +422,7 @@ data. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -435,7 +435,7 @@ limit and truncate reports). #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -445,7 +445,7 @@ Hook that is executed after generic filters are applied. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -457,7 +457,7 @@ Use this method to format the report data before the view is rendered. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -468,5 +468,5 @@ be a certain value, despite changes from plugins and query parameters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md b/docs/3.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md index 384ee4be9..eaa467a37 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md @@ -258,7 +258,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -269,7 +269,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -282,5 +282,5 @@ public for Insights use. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md index 478d92cb4..d31018975 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md @@ -120,5 +120,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md index 9df9c2f78..896c50fba 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md index d2573fc0a..dcbeff6ee 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md index 5bebeb9bf..59983134a 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md index 364e16d23..d5d168801 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md index 8305d1526..f2b82f9a5 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md index 83ed7ef51..859254a67 100644 --- a/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CustomPiwikJs/TrackerUpdater.md b/docs/3.x/generated/Piwik/Plugins/CustomPiwikJs/TrackerUpdater.md index 1e8c34817..9e3f85d45 100644 --- a/docs/3.x/generated/Piwik/Plugins/CustomPiwikJs/TrackerUpdater.md +++ b/docs/3.x/generated/Piwik/Plugins/CustomPiwikJs/TrackerUpdater.md @@ -24,7 +24,7 @@ Checks whether the Piwik JavaScript tracker file "piwik.js" is writable. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — In case the piwik.js file is not writable. @@ -40,5 +40,5 @@ an exception in such a case and instead just to nothing. To check if the update #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/CustomVariables/ProfileSummary/VisitScopeSummary.md b/docs/3.x/generated/Piwik/Plugins/CustomVariables/ProfileSummary/VisitScopeSummary.md index 94d2a97d4..ab6f6abe0 100644 --- a/docs/3.x/generated/Piwik/Plugins/CustomVariables/ProfileSummary/VisitScopeSummary.md +++ b/docs/3.x/generated/Piwik/Plugins/CustomVariables/ProfileSummary/VisitScopeSummary.md @@ -27,7 +27,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md b/docs/3.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md index 40a539556..96c6013df 100644 --- a/docs/3.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md +++ b/docs/3.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md @@ -52,7 +52,7 @@ Constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,7 +79,7 @@ Returns plugin information, including: #### Signature - It is a **finalized** method. -- It does not return anything. +- It does not return anything or a mixed result. @@ -119,7 +119,7 @@ Useful for initialization code that uses translated strings. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -146,7 +146,7 @@ needs to: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if installation of fails for some reason. @@ -162,7 +162,7 @@ an [uninstall()](/api-reference/Piwik/Plugins/DevicePlugins/DevicePlugins#uninst #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if uninstallation of fails for some reason. @@ -174,7 +174,7 @@ Executed every time the plugin is enabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -184,7 +184,7 @@ Executed every time the plugin is disabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -248,7 +248,7 @@ Tries to find a component such as a Menu or Tasks within this plugin. - `$expectedSubclass` -- It does not return anything. +- It does not return anything or a mixed result. @@ -272,7 +272,7 @@ Detect whether there are any missing dependencies. - It accepts the following parameter(s): - `$piwikVersion` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/DevicesDetection/ProfileSummary/DevicesSummary.md b/docs/3.x/generated/Piwik/Plugins/DevicesDetection/ProfileSummary/DevicesSummary.md index 2b9dd5de1..68c68dcdd 100644 --- a/docs/3.x/generated/Piwik/Plugins/DevicesDetection/ProfileSummary/DevicesSummary.md +++ b/docs/3.x/generated/Piwik/Plugins/DevicesDetection/ProfileSummary/DevicesSummary.md @@ -27,7 +27,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md b/docs/3.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md index da75fcbbb..46e7ba256 100644 --- a/docs/3.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md +++ b/docs/3.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md @@ -70,7 +70,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$item` ([`DiagnosticResultItem`](../../../../Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResultItem.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,7 +81,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$items` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -100,7 +100,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$longErrorMessage` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Ecommerce/ProfileSummary/EcommerceSummary.md b/docs/3.x/generated/Piwik/Plugins/Ecommerce/ProfileSummary/EcommerceSummary.md index 323394eae..4163086bd 100644 --- a/docs/3.x/generated/Piwik/Plugins/Ecommerce/ProfileSummary/EcommerceSummary.md +++ b/docs/3.x/generated/Piwik/Plugins/Ecommerce/ProfileSummary/EcommerceSummary.md @@ -27,7 +27,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ImportantVisits.md b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ImportantVisits.md index 7a6ab3567..c1f8b8e50 100644 --- a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ImportantVisits.md +++ b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ImportantVisits.md @@ -27,7 +27,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md index a910570a5..a6985993f 100644 --- a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md +++ b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md @@ -29,7 +29,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/Summary.md b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/Summary.md index 12be5a04f..c1ece13b0 100644 --- a/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/Summary.md +++ b/docs/3.x/generated/Piwik/Plugins/Live/ProfileSummary/Summary.md @@ -29,7 +29,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md b/docs/3.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md index c95e777ac..1ed07e150 100644 --- a/docs/3.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md +++ b/docs/3.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md @@ -39,7 +39,7 @@ Set details of current visit - It accepts the following parameter(s): - `$details` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -116,7 +116,7 @@ $actions = array ( action set to enrich - `$visitIds` (`array`) — list of visit ids -- It does not return anything. +- It does not return anything or a mixed result. @@ -142,7 +142,7 @@ Allows filtering the provided actions - `$visitorDetailsArray` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -159,7 +159,7 @@ Allows extended each action with additional information - `$visitorDetails` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md b/docs/3.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md index b0c7ba21f..28aa6905d 100644 --- a/docs/3.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md +++ b/docs/3.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/Live/Visualizations/Visito - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Login/SessionInitializer.md b/docs/3.x/generated/Piwik/Plugins/Login/SessionInitializer.md index 7519deee2..ddb228986 100644 --- a/docs/3.x/generated/Piwik/Plugins/Login/SessionInitializer.md +++ b/docs/3.x/generated/Piwik/Plugins/Login/SessionInitializer.md @@ -47,7 +47,7 @@ Authenticates the user and, if successful, initializes an authenticated session. The Auth implementation to use. - `$rememberMe` (`bool`) — Whether the authenticated session should be remembered after the browser is closed or not. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If authentication fails or the user is not allowed to login for some reason. diff --git a/docs/3.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md b/docs/3.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md index 8d1d1bfa7..ba0168cde 100644 --- a/docs/3.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md +++ b/docs/3.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md @@ -256,7 +256,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -267,7 +267,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -280,5 +280,5 @@ public for Insights use. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md b/docs/3.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md index 99e650a18..0dcf3a7d6 100644 --- a/docs/3.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md +++ b/docs/3.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md @@ -86,7 +86,7 @@ complete a challenge. For example "add_user" challenge could directly link to th #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md b/docs/3.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md index c8abf53f9..1edf84a53 100644 --- a/docs/3.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md +++ b/docs/3.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/TreemapVisualization/Treem - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Plugins/UserCountry/ProfileSummary/LocationSummary.md b/docs/3.x/generated/Piwik/Plugins/UserCountry/ProfileSummary/LocationSummary.md index cbad29c53..f53d5e470 100644 --- a/docs/3.x/generated/Piwik/Plugins/UserCountry/ProfileSummary/LocationSummary.md +++ b/docs/3.x/generated/Piwik/Plugins/UserCountry/ProfileSummary/LocationSummary.md @@ -27,7 +27,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/RankingQuery.md b/docs/3.x/generated/Piwik/RankingQuery.md index 5c2fdf7c5..5d5d585e8 100644 --- a/docs/3.x/generated/Piwik/RankingQuery.md +++ b/docs/3.x/generated/Piwik/RankingQuery.md @@ -64,7 +64,7 @@ Set the limit after which everything is grouped to "Others". - It accepts the following parameter(s): - `$limit` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Set the value to use for the label in the 'Others' row. - It accepts the following parameter(s): - `$value` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ Labels are the columns that are replaced with "Others" after the limit. - It accepts the following parameter(s): - `$labelColumn` (`string`|`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -115,7 +115,7 @@ Add a column that has be added to the outer queries. - `$aggregationFunction` (`string`|`bool`) — If set, this function is used to aggregate the values of "Others", eg, `'min'`, `'max'` or `'sum'`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -132,7 +132,7 @@ by [execute()](/api-reference/Piwik/RankingQuery#execute). - It accepts the following parameter(s): - `$column` string Name of the column. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if method is used more than once. @@ -160,7 +160,7 @@ rows `log_action.type = TYPE_DOWNLOAD`. string The column name to partion by. - `$possibleValues` Array of possible column values. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if method is used more than once. diff --git a/docs/3.x/generated/Piwik/Registry.md b/docs/3.x/generated/Piwik/Registry.md index 9603aec72..327683518 100644 --- a/docs/3.x/generated/Piwik/Registry.md +++ b/docs/3.x/generated/Piwik/Registry.md @@ -38,7 +38,7 @@ has not been created, this method will create it. - It accepts the following parameter(s): - `$key` -- It does not return anything. +- It does not return anything or a mixed result. @@ -49,7 +49,7 @@ has not been created, this method will create it. - It accepts the following parameter(s): - `$key` -- It does not return anything. +- It does not return anything or a mixed result. @@ -62,7 +62,7 @@ has not been created, this method will create it. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,7 +75,7 @@ has not been created, this method will create it. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -86,7 +86,7 @@ has not been created, this method will create it. - It accepts the following parameter(s): - `$key` -- It does not return anything. +- It does not return anything or a mixed result. @@ -97,5 +97,5 @@ has not been created, this method will create it. - It accepts the following parameter(s): - `$key` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Report/ReportWidgetConfig.md b/docs/3.x/generated/Piwik/Report/ReportWidgetConfig.md index f6f1d1518..f3f2c2779 100644 --- a/docs/3.x/generated/Piwik/Report/ReportWidgetConfig.md +++ b/docs/3.x/generated/Piwik/Report/ReportWidgetConfig.md @@ -111,7 +111,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -257,7 +257,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Report/ReportWidgetCo #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -267,7 +267,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Report/ReportWidgetC #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -285,7 +285,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/Daily.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/Daily.md index 22d153744..a18d12e05 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/Daily.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/Daily.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/Hourly.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/Hourly.md index 24b793e4f..c38b08d75 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/Hourly.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/Hourly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/Monthly.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/Monthly.md index 1c9665d63..968b4c5a8 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/Monthly.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/Monthly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/Schedule.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/Schedule.md index 030fb0424..a9e950657 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/Schedule.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/Schedule.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md index 2e8c26330..31b24277a 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md @@ -22,7 +22,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Schedule/Weekly.md b/docs/3.x/generated/Piwik/Scheduler/Schedule/Weekly.md index ff34945e0..9b67d2675 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Schedule/Weekly.md +++ b/docs/3.x/generated/Piwik/Scheduler/Schedule/Weekly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/3.x/generated/Piwik/Scheduler/Scheduler.md b/docs/3.x/generated/Piwik/Scheduler/Scheduler.md index 96eb5f0a2..66403091f 100644 --- a/docs/3.x/generated/Piwik/Scheduler/Scheduler.md +++ b/docs/3.x/generated/Piwik/Scheduler/Scheduler.md @@ -57,7 +57,7 @@ was changed. - It accepts the following parameter(s): - `$task` ([`Task`](../../Piwik/Scheduler/Task.md)) — Describes the scheduled task being rescheduled. -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,5 +75,5 @@ The task will be run the first time tomorrow. - It accepts the following parameter(s): - `$task` ([`Task`](../../Piwik/Scheduler/Task.md)) — Describes the scheduled task being rescheduled. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Segment.md b/docs/3.x/generated/Piwik/Segment.md index f252edecf..ccd8e1987 100644 --- a/docs/3.x/generated/Piwik/Segment.md +++ b/docs/3.x/generated/Piwik/Segment.md @@ -88,7 +88,7 @@ Returns `true` if the segment is empty, `false` if otherwise. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -135,7 +135,7 @@ condition is empty. - It accepts the following parameter(s): - `$definition` -- It does not return anything. +- It does not return anything or a mixed result. @@ -209,5 +209,5 @@ The combination is naive in that it does not take order of operations into accou - It accepts the following parameter(s): - `$idSite` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Settings/FieldConfig/ArrayField.md b/docs/3.x/generated/Piwik/Settings/FieldConfig/ArrayField.md index 6fc43a5b3..0001059cd 100644 --- a/docs/3.x/generated/Piwik/Settings/FieldConfig/ArrayField.md +++ b/docs/3.x/generated/Piwik/Settings/FieldConfig/ArrayField.md @@ -99,5 +99,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Settings/FieldConfig/MultiPair.md b/docs/3.x/generated/Piwik/Settings/FieldConfig/MultiPair.md index e5a562ca3..b6d44365b 100644 --- a/docs/3.x/generated/Piwik/Settings/FieldConfig/MultiPair.md +++ b/docs/3.x/generated/Piwik/Settings/FieldConfig/MultiPair.md @@ -116,5 +116,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md b/docs/3.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md index eb7ab0da3..320b8da48 100644 --- a/docs/3.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md +++ b/docs/3.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md @@ -83,7 +83,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -96,7 +96,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -146,7 +146,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/3.x/generated/Piwik/Settings/Plugin/SystemSetting.md b/docs/3.x/generated/Piwik/Settings/Plugin/SystemSetting.md index 1be455603..9137acd97 100644 --- a/docs/3.x/generated/Piwik/Settings/Plugin/SystemSetting.md +++ b/docs/3.x/generated/Piwik/Settings/Plugin/SystemSetting.md @@ -80,7 +80,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -93,7 +93,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,7 +114,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -140,7 +140,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/3.x/generated/Piwik/Settings/Setting.md b/docs/3.x/generated/Piwik/Settings/Setting.md index c9fda93a1..f12b799f4 100644 --- a/docs/3.x/generated/Piwik/Settings/Setting.md +++ b/docs/3.x/generated/Piwik/Settings/Setting.md @@ -80,7 +80,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -93,7 +93,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,7 +114,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -143,7 +143,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/3.x/generated/Piwik/Settings/Settings.md b/docs/3.x/generated/Piwik/Settings/Settings.md index d7a6459a3..3d1735d18 100644 --- a/docs/3.x/generated/Piwik/Settings/Settings.md +++ b/docs/3.x/generated/Piwik/Settings/Settings.md @@ -29,7 +29,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -52,7 +52,7 @@ Adds a new setting to the settings container. - It accepts the following parameter(s): - `$setting` ([`Setting`](../../Piwik/Settings/Setting.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If there is a setting with the same name that already exists. If the name contains non-alphanumeric characters. @@ -65,5 +65,5 @@ Saves (persists) the current setting values in the database. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Site.md b/docs/3.x/generated/Piwik/Site.md index 631b9e7b6..ee3a9418c 100644 --- a/docs/3.x/generated/Piwik/Site.md +++ b/docs/3.x/generated/Piwik/Site.md @@ -91,7 +91,7 @@ individual site data. - It accepts the following parameter(s): - `$sites` (`array`) — The array of sites data. Indexed by site ID. eg, array('1' => array('name' => 'Site 1', ...), '2' => array('name' => 'Site 2', ...))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -298,7 +298,7 @@ See also [setSites()](/api-reference/Piwik/Site#setsites) and setSitesFromArray( #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -313,7 +313,7 @@ See also [setSites()](/api-reference/Piwik/Site#setsites) and setSitesFromArray( - It accepts the following parameter(s): - `$idSite` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/TaskScheduler.md b/docs/3.x/generated/Piwik/TaskScheduler.md index d94cfb9d2..379efc233 100644 --- a/docs/3.x/generated/Piwik/TaskScheduler.md +++ b/docs/3.x/generated/Piwik/TaskScheduler.md @@ -56,5 +56,5 @@ was changed. - It accepts the following parameter(s): - `$task` ([`Task`](../Piwik/Scheduler/Task.md)) — Describes the scheduled task being rescheduled. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Translation/Translator.md b/docs/3.x/generated/Piwik/Translation/Translator.md index 78b67b5b4..5669ebca0 100644 --- a/docs/3.x/generated/Piwik/Translation/Translator.md +++ b/docs/3.x/generated/Piwik/Translation/Translator.md @@ -70,7 +70,7 @@ cannot be found for the ID, the ID is returned. - It accepts the following parameter(s): - `$language` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Generate javascript translations array #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -103,7 +103,7 @@ Add a directory containing translations. - It accepts the following parameter(s): - `$directory` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -113,7 +113,7 @@ Should be used by tests only, and this method should eventually be removed. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Updater.md b/docs/3.x/generated/Piwik/Updater.md index e6b465f5b..4ae3c8879 100644 --- a/docs/3.x/generated/Piwik/Updater.md +++ b/docs/3.x/generated/Piwik/Updater.md @@ -26,7 +26,7 @@ Execute multiple migration queries from a single Update file. The path to the Updates file. - `$migrations` ([`Migration[]`](../Piwik/Updater/Migration.md)) — An array of migrations -- It does not return anything. +- It does not return anything or a mixed result. @@ -39,7 +39,7 @@ Execute multiple migration queries from a single Update file. - `$migration` ([`Migration`](../Piwik/Updater/Migration.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `Piwik\UpdaterErrorException` diff --git a/docs/3.x/generated/Piwik/Updates.md b/docs/3.x/generated/Piwik/Updates.md index 606da6cf6..2e7ca5c7e 100644 --- a/docs/3.x/generated/Piwik/Updates.md +++ b/docs/3.x/generated/Piwik/Updates.md @@ -62,5 +62,5 @@ See \Piwik\Plugins\ExamplePlugin\Updates\Updates\_0\_0\_2 for an example. - It accepts the following parameter(s): - `$updater` ([`Updater`](../Piwik/Updater.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Url.md b/docs/3.x/generated/Piwik/Url.md index fd4e8ed71..4704a8b89 100644 --- a/docs/3.x/generated/Piwik/Url.md +++ b/docs/3.x/generated/Piwik/Url.md @@ -235,7 +235,7 @@ to the current URL without query string. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -248,7 +248,7 @@ Redirects the user to the specified URL. - It accepts the following parameter(s): - `$url` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/3.x/generated/Piwik/Version.md b/docs/3.x/generated/Piwik/Version.md index 774e22b56..e69f87aa2 100644 --- a/docs/3.x/generated/Piwik/Version.md +++ b/docs/3.x/generated/Piwik/Version.md @@ -22,7 +22,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. @@ -33,5 +33,5 @@ The class defines the following methods: - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/View.md b/docs/3.x/generated/Piwik/View.md index cb8ff15f5..21c5b4856 100644 --- a/docs/3.x/generated/Piwik/View.md +++ b/docs/3.x/generated/Piwik/View.md @@ -126,7 +126,7 @@ Disables the cache buster (adding of ?cb=. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -166,7 +166,7 @@ Variable names may not be prefixed with '_'. The variable name. - `$val` (`mixed`) — The variable value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -209,7 +209,7 @@ Unsets a template variable. - It accepts the following parameter(s): - `$name` (`string`) — The name of the template variable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -237,7 +237,7 @@ set just before rendering. - It accepts the following parameter(s): - `$contentType` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -254,7 +254,7 @@ embedded in iframes. Learn more [here](https://developer.mozilla.org/en-US/docs/ - It accepts the following parameter(s): - `$option` (`string`) — ('deny' or 'sameorigin') -- It does not return anything. +- It does not return anything or a mixed result. @@ -297,5 +297,5 @@ Sets whether a strict Referrer-Policy header will be sent (if not, nothing is se - It accepts the following parameter(s): - `$useStrictReferrerPolicy` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/View/UIControl.md b/docs/3.x/generated/Piwik/View/UIControl.md index 74f2ade4c..1242e7119 100644 --- a/docs/3.x/generated/Piwik/View/UIControl.md +++ b/docs/3.x/generated/Piwik/View/UIControl.md @@ -125,7 +125,7 @@ Disables the cache buster (adding of ?cb=. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -163,7 +163,7 @@ Sets a variable. See View::\_\_set(). The variable name. - `$val` (`mixed`) — The variable value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -204,7 +204,7 @@ Unsets a template variable. - It accepts the following parameter(s): - `$name` (`string`) — The name of the template variable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -231,7 +231,7 @@ set just before rendering. - It accepts the following parameter(s): - `$contentType` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -248,7 +248,7 @@ embedded in iframes. Learn more [here](https://developer.mozilla.org/en-US/docs/ - It accepts the following parameter(s): - `$option` (`string`) — ('deny' or 'sameorigin') -- It does not return anything. +- It does not return anything or a mixed result. @@ -291,7 +291,7 @@ Sets whether a strict Referrer-Policy header will be sent (if not, nothing is se - It accepts the following parameter(s): - `$useStrictReferrerPolicy` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/ViewDataTable/Config.md b/docs/3.x/generated/Piwik/ViewDataTable/Config.md index a4a2406ed..4b6bc5567 100644 --- a/docs/3.x/generated/Piwik/ViewDataTable/Config.md +++ b/docs/3.x/generated/Piwik/ViewDataTable/Config.md @@ -964,7 +964,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1002,7 +1002,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1010,7 +1010,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1018,7 +1018,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1037,7 +1037,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in releated report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1055,7 +1055,7 @@ use [addRelatedReport()](/api-reference/Piwik/ViewDataTable/Config#addrelatedrep - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1072,7 +1072,7 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations). The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1087,7 +1087,7 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations) and - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1098,5 +1098,5 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations) and - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/ViewDataTable/RequestConfig.md b/docs/3.x/generated/Piwik/ViewDataTable/RequestConfig.md index 492020366..3031bbce0 100644 --- a/docs/3.x/generated/Piwik/ViewDataTable/RequestConfig.md +++ b/docs/3.x/generated/Piwik/ViewDataTable/RequestConfig.md @@ -411,7 +411,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -425,7 +425,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('disable_queued_filters', 'filter_column')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -439,7 +439,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('disable_queued_filters', 'filter_column')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -454,7 +454,7 @@ learn more. - `$actualColumns` -- It does not return anything. +- It does not return anything or a mixed result. @@ -462,7 +462,7 @@ learn more. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -470,7 +470,7 @@ learn more. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -481,7 +481,7 @@ learn more. - It accepts the following parameter(s): - `$paramName` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Widget/Widget.md b/docs/3.x/generated/Piwik/Widget/Widget.md index 3b4eba476..21e9b1da5 100644 --- a/docs/3.x/generated/Piwik/Widget/Widget.md +++ b/docs/3.x/generated/Piwik/Widget/Widget.md @@ -27,7 +27,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$config` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Widget/WidgetConfig.md b/docs/3.x/generated/Piwik/Widget/WidgetConfig.md index 6bb261b39..f5a67d3a5 100644 --- a/docs/3.x/generated/Piwik/Widget/WidgetConfig.md +++ b/docs/3.x/generated/Piwik/Widget/WidgetConfig.md @@ -107,7 +107,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -255,7 +255,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetConfig#i #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -265,7 +265,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetConfig# #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -283,7 +283,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/3.x/generated/Piwik/Widget/WidgetContainerConfig.md b/docs/3.x/generated/Piwik/Widget/WidgetContainerConfig.md index 9d424ce98..e869967f6 100644 --- a/docs/3.x/generated/Piwik/Widget/WidgetContainerConfig.md +++ b/docs/3.x/generated/Piwik/Widget/WidgetContainerConfig.md @@ -116,7 +116,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -262,7 +262,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetContaine #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -272,7 +272,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetContain #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -290,7 +290,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -468,7 +468,7 @@ Set (overwrite) widget configs. - It accepts the following parameter(s): - `$configs` ([`WidgetConfig[]`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/Piwik/Widget/WidgetsList.md b/docs/3.x/generated/Piwik/Widget/WidgetsList.md index d2ee54fa6..c83d28766 100644 --- a/docs/3.x/generated/Piwik/Widget/WidgetsList.md +++ b/docs/3.x/generated/Piwik/Widget/WidgetsList.md @@ -34,7 +34,7 @@ no such checks will be performed. - It accepts the following parameter(s): - `$widget` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -47,7 +47,7 @@ Add multiple widget configs at once. See [addWidgetConfig()](/api-reference/Piwi - It accepts the following parameter(s): - `$widgets` ([`WidgetConfig[]`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,7 +75,7 @@ will not be recognized. eg 'Products' or 'Contents'. See WidgetContainerConfig::setId - `$widget` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Removes one or more widgets from the widget list. The widget category id. Can be a translation token eg 'General_Visits' see [WidgetConfig::setCategoryId()](/api-reference/Piwik/Widget/WidgetConfig#setcategoryid). - `$widgetName` (`string`|`false`) — The name of the widget to remove eg 'VisitTime_ByServerTimeWidgetName'. If not supplied, all widgets within that category will be removed. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/3.x/generated/PiwikTracker.md b/docs/3.x/generated/PiwikTracker.md index 5ff4e3997..8febe62b1 100644 --- a/docs/3.x/generated/PiwikTracker.md +++ b/docs/3.x/generated/PiwikTracker.md @@ -276,7 +276,7 @@ and you wish to clear Custom Variables of 'visit' scope. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -305,7 +305,7 @@ Clear / reset all previously set custom tracking parameters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -447,7 +447,7 @@ doBulkTrack method is called. This method will send all tracking data at once. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -462,7 +462,7 @@ Enable Cookie Creation - this will cause a first party VisitorId cookie to be se (optional) Set first-party cookie domain. Accepted values: example.com, *.example.com (same as .example.com) or subdomain.example.com - `$path` (`string`) — (optional) Set first-party cookie path -- It does not return anything. +- It does not return anything or a mixed result. @@ -472,7 +472,7 @@ If image response is disabled Piwik will respond with a HTTP 204 header instead #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1067,7 +1067,7 @@ Deletes all first party cookies from the client #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1202,7 +1202,7 @@ This can be disabled by calling this function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1213,7 +1213,7 @@ from Piwik. Defaults to 600 seconds. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1244,7 +1244,7 @@ If a proxy is needed to look up the address of the Piwik site, set it with this IP as string, for example "173.234.92.107" - `$proxyPort` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1259,7 +1259,7 @@ Sets a cookie to be sent to the tracking server. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/MatomoTracker.md b/docs/4.x/generated/MatomoTracker.md index bef02bcb2..40a0b6c08 100644 --- a/docs/4.x/generated/MatomoTracker.md +++ b/docs/4.x/generated/MatomoTracker.md @@ -231,7 +231,7 @@ Clear / reset all previously set performance metrics. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -319,7 +319,7 @@ and you wish to clear Custom Variables of 'visit' scope. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -348,7 +348,7 @@ Clear / reset all previously set custom tracking parameters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -490,7 +490,7 @@ doBulkTrack method is called. This method will send all tracking data at once. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -505,7 +505,7 @@ Enable Cookie Creation - this will cause a first party VisitorId cookie to be se (optional) Set first-party cookie domain. Accepted values: example.com, *.example.com (same as .example.com) or subdomain.example.com - `$path` (`string`) — (optional) Set first-party cookie path -- It does not return anything. +- It does not return anything or a mixed result. @@ -515,7 +515,7 @@ If image response is disabled Matomo will respond with a HTTP 204 header instead #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1108,7 +1108,7 @@ Deletes all first party cookies from the client #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1239,7 +1239,7 @@ This can be disabled by calling this function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1250,7 +1250,7 @@ from Matomo. Defaults to 600 seconds. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1281,7 +1281,7 @@ If a proxy is needed to look up the address of the Matomo site, set it with this IP as string, for example "173.234.92.107" - `$proxyPort` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1296,7 +1296,7 @@ Sets a cookie to be sent to the tracking server. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/ArchiveProcessor.md b/docs/4.x/generated/Piwik/ArchiveProcessor.md index 65d7b4932..719500b0f 100644 --- a/docs/4.x/generated/Piwik/ArchiveProcessor.md +++ b/docs/4.x/generated/Piwik/ArchiveProcessor.md @@ -169,7 +169,7 @@ and segment. - It accepts the following parameter(s): - `$numericRecords` (`array`) — A name-value mapping of numeric values that should be archived, eg, array('Referrers_distinctKeywords' => 23, 'Referrers_distinctCampaigns' => 234) -- It does not return anything. +- It does not return anything or a mixed result. @@ -187,7 +187,7 @@ Numeric values are not inserted if they equal `0`. The name of the numeric value, eg, `'Referrers_distinctKeywords'`. - `$value` (`float`) — The numeric value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -203,5 +203,5 @@ and segment. The name of the record, eg, 'Referrers_type'. - `$values` (`string`|`array`) — A blob string or an array of blob strings. If an array is used, the first element in the array will be inserted with the `$name` name. The others will be inserted with `$name . '_' . $index` as the record name (where $index is the index of the blob record in `$values`). -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Auth.md b/docs/4.x/generated/Piwik/Auth.md index 0427aef72..2919cf60c 100644 --- a/docs/4.x/generated/Piwik/Auth.md +++ b/docs/4.x/generated/Piwik/Auth.md @@ -71,7 +71,7 @@ Sets the authentication token to authenticate with. - It accepts the following parameter(s): - `$token_auth` (`string`) — authentication token -- It does not return anything. +- It does not return anything or a mixed result. @@ -110,7 +110,7 @@ Sets the login name to authenticate with. - It accepts the following parameter(s): - `$login` (`string`) — The username. -- It does not return anything. +- It does not return anything or a mixed result. @@ -123,7 +123,7 @@ Sets the password to authenticate with. - It accepts the following parameter(s): - `$password` (`string`) — Password (not hashed). -- It does not return anything. +- It does not return anything or a mixed result. @@ -136,7 +136,7 @@ Sets the hash of the password to authenticate with. The hash will be an MD5 hash - It accepts the following parameter(s): - `$passwordHash` (`string`) — The hashed password. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if authentication by hashed password is not supported. diff --git a/docs/4.x/generated/Piwik/Columns/Dimension.md b/docs/4.x/generated/Piwik/Columns/Dimension.md index 23b3e956f..bcf3001ad 100644 --- a/docs/4.x/generated/Piwik/Columns/Dimension.md +++ b/docs/4.x/generated/Piwik/Columns/Dimension.md @@ -301,7 +301,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -356,7 +356,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -369,7 +369,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -426,7 +426,7 @@ $segmentsList->addSegment($segment); - `$dimensionSegmentFactory` ([`DimensionSegmentFactory`](../../Piwik/Columns/DimensionSegmentFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -445,7 +445,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -512,7 +512,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Columns/Discriminator.md b/docs/4.x/generated/Piwik/Columns/Discriminator.md index 2f5923fd0..9161a0e82 100644 --- a/docs/4.x/generated/Piwik/Columns/Discriminator.md +++ b/docs/4.x/generated/Piwik/Columns/Discriminator.md @@ -40,7 +40,7 @@ Join constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Columns/MetricsList.md b/docs/4.x/generated/Piwik/Columns/MetricsList.md index 3d4f9e873..9699923da 100644 --- a/docs/4.x/generated/Piwik/Columns/MetricsList.md +++ b/docs/4.x/generated/Piwik/Columns/MetricsList.md @@ -29,7 +29,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$metric` ([`Metric`](../../Piwik/Plugin/Metric.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -54,7 +54,7 @@ Removes one or more metrics from the metrics list. The metric category id. Can be a translation token eg 'General_Visits' see Metric::getCategory(). - `$metricName` (`string`|`false`) — The name of the metric to remove eg 'nb_visits'. If not supplied, all metrics within that category will be removed. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Columns/Updater.md b/docs/4.x/generated/Piwik/Columns/Updater.md index cb8594dcd..a43c146b5 100644 --- a/docs/4.x/generated/Piwik/Columns/Updater.md +++ b/docs/4.x/generated/Piwik/Columns/Updater.md @@ -46,5 +46,5 @@ See \Piwik\Plugins\ExamplePlugin\Updates\Updates\_0\_0\_2 for an example. - It accepts the following parameter(s): - `$updater` ([`Updater`](../../Piwik/Updater.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Common.md b/docs/4.x/generated/Piwik/Common.md index e19a5c178..0378994bb 100644 --- a/docs/4.x/generated/Piwik/Common.md +++ b/docs/4.x/generated/Piwik/Common.md @@ -256,5 +256,5 @@ For more information: [https://github.com/piwik/piwik/issues/374](https://github - It accepts the following parameter(s): - `$var` (`mixed`) — The object to destroy. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Config.md b/docs/4.x/generated/Piwik/Config.md index abe74ea4f..bbf02b9e2 100644 --- a/docs/4.x/generated/Piwik/Config.md +++ b/docs/4.x/generated/Piwik/Config.md @@ -66,7 +66,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -88,7 +88,7 @@ Returns a configuration value or section by name. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. @@ -103,7 +103,7 @@ Sets a configuration value or section. This section name or value name to set. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,5 +114,5 @@ values are different from the default. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable.md b/docs/4.x/generated/Piwik/DataTable.md index 052920773..efe4b9f22 100644 --- a/docs/4.x/generated/Piwik/DataTable.md +++ b/docs/4.x/generated/Piwik/DataTable.md @@ -259,7 +259,7 @@ Destructor. Makes sure DataTable memory will be cleaned up. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -279,7 +279,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -294,7 +294,7 @@ Sorts the DataTable rows using the supplied callback function. A comparison callback compatible with usort. - `$columnSortedBy` (`string`) — The column name `$functionCallback` sorts by. This is stored so we can determine how the DataTable was sorted in the future. -- It does not return anything. +- It does not return anything or a mixed result. @@ -305,7 +305,7 @@ Sorts the DataTable rows using the supplied callback function. - It accepts the following parameter(s): - `$totalsRow` ([`Row`](../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -313,7 +313,7 @@ Sorts the DataTable rows using the supplied callback function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -338,7 +338,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -349,7 +349,7 @@ will apply filters to every subtable in addition to this instance. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -367,7 +367,7 @@ to all subtables as well. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -382,7 +382,7 @@ Applies a filter to all subtables but not to this datatable. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -401,7 +401,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -420,7 +420,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -431,7 +431,7 @@ for more information. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -454,7 +454,7 @@ metadata can be used to specify a different type of operation. - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -596,7 +596,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array(Row::COLUMNS => array('visits' => 13, 'test' => 'toto'), Row::METADATA => array('mymetadata' => 'myvalue'))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -611,7 +611,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array('name' => 'google analytics', 'license' => 'commercial')` -- It does not return anything. +- It does not return anything or a mixed result. @@ -744,7 +744,7 @@ subtables. - It accepts the following parameter(s): - `$name` (`string`) — Column name to delete. -- It does not return anything. +- It does not return anything or a mixed result. @@ -752,7 +752,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -767,7 +767,7 @@ Rename a column in every row. This change is applied recursively to all subtable Old column name. - `$newName` (`string`) — New column name. -- It does not return anything. +- It does not return anything or a mixed result. @@ -782,7 +782,7 @@ Deletes several columns by name in every row. List of column names to delete. - `$deleteRecursiveInSubtables` (`bool`) — Whether to apply this change to all subtables or not. -- It does not return anything. +- It does not return anything or a mixed result. @@ -795,7 +795,7 @@ Deletes a row by ID. - It accepts the following parameter(s): - `$id` (`int`) — The row ID. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the row `$id` cannot be found. @@ -827,7 +827,7 @@ Deletes a set of rows by ID. - It accepts the following parameter(s): - `$rowIds` (`array`) — The list of row IDs to delete. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If a row ID cannot be found. @@ -923,7 +923,7 @@ _Note: This function will successfully load DataTables serialized by Piwik 1.X._ - It accepts the following parameter(s): - `$serialized` (`string`) — A string with the format of a string in the array returned by [serialize()](http://php.net/function.serialize()). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$serialized` is invalid. @@ -940,7 +940,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure array( // row1 array( Row::COLUMNS => array( col1_name => value1, col2_name => value2, ...), Row::METADATA => array( metadata1_name => value1, ...), // see Row ), // row2 array( ... ), ) -- It does not return anything. +- It does not return anything or a mixed result. @@ -955,7 +955,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure: array( array( col1_name => valueA, col2_name => valueC, ...), array( col1_name => valueB, col2_name => valueD, ...), ) -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$array` is in an incorrect format. @@ -1016,7 +1016,7 @@ have subtables, but the subtables are not. - It accepts the following parameter(s): - `$atLeastLevel` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1046,7 +1046,7 @@ Sets a metadata value by name. The metadata name. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -1069,7 +1069,7 @@ Sets several metadata values by name. - It accepts the following parameter(s): - `$values` (`array`) — Array mapping metadata names with metadata values. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1082,7 +1082,7 @@ Sets metadata, erasing existing values. - It accepts the following parameter(s): - `$metadata` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1097,7 +1097,7 @@ rows are summed to the summary row. - It accepts the following parameter(s): - `$maximumAllowedRows` (`int`) — If `0`, the maximum number of rows is unset. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1184,7 +1184,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1192,7 +1192,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1213,7 +1213,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1224,7 +1224,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1237,7 +1237,7 @@ Unsets all queued filters. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1248,5 +1248,5 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/BaseFilter.md b/docs/4.x/generated/Piwik/DataTable/BaseFilter.md index 14ec21ae1..63acca5c8 100644 --- a/docs/4.x/generated/Piwik/DataTable/BaseFilter.md +++ b/docs/4.x/generated/Piwik/DataTable/BaseFilter.md @@ -50,7 +50,7 @@ Manipulates a DataTable in some way. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md index f4fa7f161..11b2cfa74 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetrics.md @@ -58,7 +58,7 @@ more information. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md index 8dde300a6..7ff5dab73 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddColumnsProcessedMetricsGoal.md @@ -76,7 +76,7 @@ more information. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -103,5 +103,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md index 7b6517e79..2cdefb8d0 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabel.md @@ -47,7 +47,7 @@ See [AddSegmentByLabel](/api-reference/Piwik/DataTable/Filter/AddSegmentByLabel) - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md index 0e8709017..58b244f4e 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByLabelMapping.md @@ -47,7 +47,7 @@ See [AddSegmentByLabelMapping](/api-reference/Piwik/DataTable/Filter/AddSegmentB - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md index 4bb8ec78c..bd6da6ba1 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentByRangeLabel.md @@ -42,7 +42,7 @@ Generates a segment filter based on the label column and the given segment name - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md index f841c7d69..44a243c5f 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentBySegmentValue.md @@ -42,7 +42,7 @@ See [AddSegmentBySegmentValue](/api-reference/Piwik/DataTable/Filter/AddSegmentB - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md index 05e6e9078..86d49022a 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSegmentValue.md @@ -48,7 +48,7 @@ See [ColumnCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/ColumnCall - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -62,7 +62,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,5 +75,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md b/docs/4.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md index e3b44cc04..bcd8f92ab 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/AddSummaryRow.md @@ -47,7 +47,7 @@ Executes the filter. See [AddSummaryRow](/api-reference/Piwik/DataTable/Filter/A - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md b/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md index dd92d75ec..296b4981a 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyRangeLabels.md @@ -64,7 +64,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,7 +78,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -91,7 +91,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md b/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md index a5ef78a51..2034b4c8f 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/BeautifyTimeRangeLabels.md @@ -56,7 +56,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -70,7 +70,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -83,7 +83,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md b/docs/4.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md index 808309f15..e3db0336b 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/CalculateEvolutionFilter.md @@ -58,7 +58,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,7 +85,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ Calculates the evolution percentage for two arbitrary values. - It accepts the following parameter(s): - `$number` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,5 +128,5 @@ Calculates the evolution percentage for two arbitrary values. - It accepts the following parameter(s): - `$number` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md index 1d2f090be..e27d3dd5d 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumn.md @@ -54,7 +54,7 @@ See [ColumnCallbackAddColumn](/api-reference/Piwik/DataTable/Filter/ColumnCallba - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -68,7 +68,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,5 +81,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md index 95cf8da8c..a8953bea6 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md @@ -57,7 +57,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -84,5 +84,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md index 955c8d0d0..bbe1a443a 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md @@ -57,7 +57,7 @@ See [ColumnCallbackAddColumnQuotient](/api-reference/Piwik/DataTable/Filter/Colu - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -84,5 +84,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md index ae5d99677..cebc68527 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md @@ -52,7 +52,7 @@ See [ColumnCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/ColumnCall - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,5 +79,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md index 3e6ee53c3..e1b3d1db4 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md @@ -44,7 +44,7 @@ See [ColumnCallbackDeleteMetadata](/api-reference/Piwik/DataTable/Filter/ColumnC - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -58,7 +58,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,5 +71,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md index 39b43db9f..978f521f5 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md @@ -51,7 +51,7 @@ Filters the given data table - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -65,7 +65,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,5 +78,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md index 9c6ff76ba..996cbc2fd 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnCallbackReplace.md @@ -59,7 +59,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -73,7 +73,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -86,5 +86,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnDelete.md b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnDelete.md index 3bdd25366..628b69c9a 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ColumnDelete.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ColumnDelete.md @@ -67,7 +67,7 @@ See [ColumnDelete](/api-reference/Piwik/DataTable/Filter/ColumnDelete). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,7 +81,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -94,5 +94,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md b/docs/4.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md index 90ed99598..6472a4013 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ExcludeLowPopulation.md @@ -58,7 +58,7 @@ See [ExcludeLowPopulation](/api-reference/Piwik/DataTable/Filter/ExcludeLowPopul - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/GroupBy.md b/docs/4.x/generated/Piwik/DataTable/Filter/GroupBy.md index 817535170..958219c21 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/GroupBy.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/GroupBy.md @@ -53,7 +53,7 @@ See [GroupBy](/api-reference/Piwik/DataTable/Filter/GroupBy). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -67,7 +67,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -80,5 +80,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/Limit.md b/docs/4.x/generated/Piwik/DataTable/Filter/Limit.md index 1fd66d0fd..045040bea 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/Limit.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/Limit.md @@ -49,7 +49,7 @@ See [Limit](/api-reference/Piwik/DataTable/Filter/Limit). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -63,7 +63,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -76,5 +76,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md b/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md index 551f44a5c..97019df0e 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackAddMetadata.md @@ -51,7 +51,7 @@ See [MetadataCallbackAddMetadata](/api-reference/Piwik/DataTable/Filter/Metadata - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -65,7 +65,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,5 +78,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md b/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md index 24f0b3bc6..771d93366 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/MetadataCallbackReplace.md @@ -52,7 +52,7 @@ See [ColumnCallbackReplace](/api-reference/Piwik/DataTable/Filter/ColumnCallback - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,5 +79,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/Pattern.md b/docs/4.x/generated/Piwik/DataTable/Filter/Pattern.md index cbd7caa03..ba1b8c3b6 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/Pattern.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/Pattern.md @@ -50,7 +50,7 @@ See [Pattern](/api-reference/Piwik/DataTable/Filter/Pattern). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/PatternRecursive.md b/docs/4.x/generated/Piwik/DataTable/Filter/PatternRecursive.md index 28f37b205..5a9687aa2 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/PatternRecursive.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/PatternRecursive.md @@ -47,7 +47,7 @@ See [PatternRecursive](/api-reference/Piwik/DataTable/Filter/PatternRecursive). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -61,7 +61,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,5 +74,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/PrependSegment.md b/docs/4.x/generated/Piwik/DataTable/Filter/PrependSegment.md index e8a091199..0acd1e9a9 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/PrependSegment.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/PrependSegment.md @@ -42,7 +42,7 @@ See [PrependValueToMetadata](/api-reference/Piwik/DataTable/Filter/PrependValueT - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md b/docs/4.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md index ccc296b11..8e163116b 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/PrependValueToMetadata.md @@ -44,7 +44,7 @@ See [PrependValueToMetadata](/api-reference/Piwik/DataTable/Filter/PrependValueT - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -58,7 +58,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,5 +71,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md b/docs/4.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md index 196988321..1ed2a9152 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/RemoveSubtables.md @@ -42,7 +42,7 @@ See [Limit](/api-reference/Piwik/DataTable/Filter/Limit). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -69,5 +69,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md b/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md index 45ad664d5..31ac170aa 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceColumnNames.md @@ -56,7 +56,7 @@ See [ReplaceColumnNames](/api-reference/Piwik/DataTable/Filter/ReplaceColumnName - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -70,7 +70,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -83,5 +83,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md b/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md index 77d8f0746..2ec27bbb0 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/ReplaceSummaryRowLabel.md @@ -50,7 +50,7 @@ See [ReplaceSummaryRowLabel](/api-reference/Piwik/DataTable/Filter/ReplaceSummar - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/Sort.md b/docs/4.x/generated/Piwik/DataTable/Filter/Sort.md index f00ca0a1f..468c3736d 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/Sort.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/Sort.md @@ -50,7 +50,7 @@ See [Sort](/api-reference/Piwik/DataTable/Filter/Sort). - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,5 +77,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Filter/Truncate.md b/docs/4.x/generated/Piwik/DataTable/Filter/Truncate.md index 3e42a5fa6..3c2cefc28 100644 --- a/docs/4.x/generated/Piwik/DataTable/Filter/Truncate.md +++ b/docs/4.x/generated/Piwik/DataTable/Filter/Truncate.md @@ -58,7 +58,7 @@ Executes the filter, see [Truncate](/api-reference/Piwik/DataTable/Filter/Trunca - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -72,7 +72,7 @@ is up to the derived BaseFilter class. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -85,5 +85,5 @@ Filters a row's subtable, if one exists and is loaded in memory. - It accepts the following parameter(s): - `$row` ([`Row`](../../../Piwik/DataTable/Row.md)) — The row whose subtable should be filter. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Map.md b/docs/4.x/generated/Piwik/DataTable/Map.md index b885a20d5..47d78554a 100644 --- a/docs/4.x/generated/Piwik/DataTable/Map.md +++ b/docs/4.x/generated/Piwik/DataTable/Map.md @@ -70,7 +70,7 @@ Set the name of they metadata used to index DataTables. See [getKeyName()](/api- - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -97,7 +97,7 @@ See [DataTable::queueFilter()](/api-reference/Piwik/DataTable#queuefilter) for m Filter name, eg. `'Limit'` or a Closure. - `$parameters` (`array`) — Filter parameters, eg. `array(50, 10)`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ Apply the filters previously queued to each DataTable contained by this DataTabl #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -122,7 +122,7 @@ Apply a filter to all tables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -137,7 +137,7 @@ Apply a filter to all subtables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -152,7 +152,7 @@ Apply a queued filter to all subtables contained by this instance. Name of filter class or a Closure. - `$parameters` (`array`) — Parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -229,7 +229,7 @@ Adds a new DataTable or Map instance to this DataTable\Map. - `$label` (`string`) — Label used to index this table in the array. -- It does not return anything. +- It does not return anything or a mixed result. @@ -240,7 +240,7 @@ Adds a new DataTable or Map instance to this DataTable\Map. - It accepts the following parameter(s): - `$idSubtable` -- It does not return anything. +- It does not return anything or a mixed result. @@ -261,7 +261,7 @@ See DataTable::enableRecursiveSort(). #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -274,7 +274,7 @@ See DataTable::disableFilter(). - It accepts the following parameter(s): - `$className` -- It does not return anything. +- It does not return anything or a mixed result. @@ -291,7 +291,7 @@ See DataTable::renameColumn(). - `$newName` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -308,7 +308,7 @@ See DataTable::deleteColumns(). The columns to delete. - `$deleteRecursiveInSubtables` (`bool`) — This param is currently not used. -- It does not return anything. +- It does not return anything or a mixed result. @@ -321,7 +321,7 @@ Deletes a table from the array of DataTables. - It accepts the following parameter(s): - `$id` (`string`) — The label associated with DataTable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -338,7 +338,7 @@ Deletes the given column in every contained DataTable. - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -426,7 +426,7 @@ See [DataTable::addDataTable()](/api-reference/Piwik/DataTable#adddatatable). - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Row.md b/docs/4.x/generated/Piwik/DataTable/Row.md index 574cf2ba4..ed1d7a574 100644 --- a/docs/4.x/generated/Piwik/DataTable/Row.md +++ b/docs/4.x/generated/Piwik/DataTable/Row.md @@ -120,7 +120,7 @@ Renames a column. The current name of the column. - `$newName` (`string`) — The new name of the column. -- It does not return anything. +- It does not return anything or a mixed result. @@ -222,7 +222,7 @@ See [DataTable::addDataTable()](/api-reference/Piwik/DataTable#adddatatable) to - It accepts the following parameter(s): - `$subTable` ([`DataTable`](../../Piwik/DataTable.md)) — Table to sum to this row's subtable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -258,7 +258,7 @@ Removes the subtable reference. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ Set all the columns at once. Overwrites **all** previously set columns. - It accepts the following parameter(s): - `$columns` (`array`) — eg, `array('label' => 'www.php.net', 'nb_visits' => 15894)` -- It does not return anything. +- It does not return anything or a mixed result. @@ -286,7 +286,7 @@ Set the value `$value` to the column called `$name`. name of the column to set. - `$value` (`mixed`) — value of the column to set. -- It does not return anything. +- It does not return anything or a mixed result. @@ -301,7 +301,7 @@ Set the value `$value` to the metadata called `$name`. name of the metadata to set. - `$value` (`mixed`) — value of the metadata to set. -- It does not return anything. +- It does not return anything or a mixed result. @@ -331,7 +331,7 @@ Add a new column to the row. If the column already exists, throws an exception. name of the column to add. - `$value` (`mixed`) — value of the column to set or a PHP callable. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the column already exists. @@ -363,7 +363,7 @@ Add a new metadata to the row. If the metadata already exists, throws an excepti name of the metadata to add. - `$value` (`mixed`) — value of the metadata to set. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the metadata already exists. @@ -387,7 +387,7 @@ Columns in `$rowToSum` that don't exist in `$this` are added to `$this`. Whether metadata should be copied or not. - `$aggregationOperations` (`array`|`bool`) — for columns that should not be summed, determine which aggregation should be used (min, max). format: `array('column name' => 'function name')` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -404,7 +404,7 @@ Sums the metadata in `$rowToSum` with the metadata in `$this` row. - `$aggregationOperations` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -440,7 +440,7 @@ Associates the supplied table with this row as the comparisons table. - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DataTable/Simple.md b/docs/4.x/generated/Piwik/DataTable/Simple.md index 6b0a406f3..67e0ed3f7 100644 --- a/docs/4.x/generated/Piwik/DataTable/Simple.md +++ b/docs/4.x/generated/Piwik/DataTable/Simple.md @@ -129,7 +129,7 @@ Destructor. Makes sure DataTable memory will be cleaned up. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -141,7 +141,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -149,7 +149,7 @@ If we do not increase tableId it can result in segmentation faults when destruct #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -164,7 +164,7 @@ Sorts the DataTable rows using the supplied callback function. A comparison callback compatible with usort. - `$columnSortedBy` (`string`) — The column name `$functionCallback` sorts by. This is stored so we can determine how the DataTable was sorted in the future. -- It does not return anything. +- It does not return anything or a mixed result. @@ -175,7 +175,7 @@ Sorts the DataTable rows using the supplied callback function. - It accepts the following parameter(s): - `$totalsRow` ([`Row`](../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -183,7 +183,7 @@ Sorts the DataTable rows using the supplied callback function. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -208,7 +208,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -219,7 +219,7 @@ will apply filters to every subtable in addition to this instance. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -237,7 +237,7 @@ to all subtables as well. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -252,7 +252,7 @@ Applies a filter to all subtables but not to this datatable. Class name, eg. `"Sort"` or "Piwik\DataTable\Filters\Sort"`. If no namespace is supplied, `Piwik\DataTable\BaseFilter` is assumed. This parameter can also be a closure that takes a DataTable as its first parameter. - `$parameters` (`array`) — Array of extra parameters to pass to the filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -271,7 +271,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -290,7 +290,7 @@ way they will be run after the table is truncated which will result in better pe The class name of the filter, eg. `'Limit'`. - `$parameters` (`array`) — The parameters to give to the filter, eg. `array($offset, $limit)` for the Limit filter. -- It does not return anything. +- It does not return anything or a mixed result. @@ -301,7 +301,7 @@ for more information. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -324,7 +324,7 @@ metadata can be used to specify a different type of operation. - It accepts the following parameter(s): - `$tableToSum` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -466,7 +466,7 @@ You can add row metadata with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array(Row::COLUMNS => array('visits' => 13, 'test' => 'toto'), Row::METADATA => array('mymetadata' => 'myvalue'))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -481,7 +481,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$row` (`array`) — eg. `array('name' => 'google analytics', 'license' => 'commercial')` -- It does not return anything. +- It does not return anything or a mixed result. @@ -614,7 +614,7 @@ subtables. - It accepts the following parameter(s): - `$name` (`string`) — Column name to delete. -- It does not return anything. +- It does not return anything or a mixed result. @@ -622,7 +622,7 @@ subtables. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -637,7 +637,7 @@ Rename a column in every row. This change is applied recursively to all subtable Old column name. - `$newName` (`string`) — New column name. -- It does not return anything. +- It does not return anything or a mixed result. @@ -652,7 +652,7 @@ Deletes several columns by name in every row. List of column names to delete. - `$deleteRecursiveInSubtables` (`bool`) — Whether to apply this change to all subtables or not. -- It does not return anything. +- It does not return anything or a mixed result. @@ -665,7 +665,7 @@ Deletes a row by ID. - It accepts the following parameter(s): - `$id` (`int`) — The row ID. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the row `$id` cannot be found. @@ -697,7 +697,7 @@ Deletes a set of rows by ID. - It accepts the following parameter(s): - `$rowIds` (`array`) — The list of row IDs to delete. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If a row ID cannot be found. @@ -793,7 +793,7 @@ _Note: This function will successfully load DataTables serialized by Piwik 1.X._ - It accepts the following parameter(s): - `$serialized` (`string`) — A string with the format of a string in the array returned by [serialize()](http://php.net/function.serialize()). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$serialized` is invalid. @@ -809,7 +809,7 @@ values. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure array( // row1 array( Row::COLUMNS => array( col1_name => value1, col2_name => value2, ...), Row::METADATA => array( metadata1_name => value1, ...), // see Row ), // row2 array( ... ), ) -- It does not return anything. +- It does not return anything or a mixed result. @@ -824,7 +824,7 @@ Row metadata cannot be added with this method. - It accepts the following parameter(s): - `$array` (`array`) — Array with the following structure: array( array( col1_name => valueA, col2_name => valueC, ...), array( col1_name => valueB, col2_name => valueD, ...), ) -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if `$array` is in an incorrect format. @@ -885,7 +885,7 @@ have subtables, but the subtables are not. - It accepts the following parameter(s): - `$atLeastLevel` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -915,7 +915,7 @@ Sets a metadata value by name. The metadata name. - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -938,7 +938,7 @@ Sets several metadata values by name. - It accepts the following parameter(s): - `$values` (`array`) — Array mapping metadata names with metadata values. -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ Sets metadata, erasing existing values. - It accepts the following parameter(s): - `$metadata` -- It does not return anything. +- It does not return anything or a mixed result. @@ -966,7 +966,7 @@ rows are summed to the summary row. - It accepts the following parameter(s): - `$maximumAllowedRows` (`int`) — If `0`, the maximum number of rows is unset. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1053,7 +1053,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1061,7 +1061,7 @@ Unsets all queued filters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1082,7 +1082,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1093,7 +1093,7 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1106,7 +1106,7 @@ Unsets all queued filters. - `$value` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1117,5 +1117,5 @@ Unsets all queued filters. - It accepts the following parameter(s): - `$offset` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Db.md b/docs/4.x/generated/Piwik/Db.md index 10180ace7..f303fa852 100644 --- a/docs/4.x/generated/Piwik/Db.md +++ b/docs/4.x/generated/Piwik/Db.md @@ -125,7 +125,7 @@ Shouldn't be called directly, use [get()](/api-reference/Piwik/Db#get) instead. - It accepts the following parameter(s): - `$dbConfig` (`array`|`null`) — Connection parameters in an array. Defaults to the `[database]` INI config section. -- It does not return anything. +- It does not return anything or a mixed result. @@ -142,7 +142,7 @@ Shouldn't be called directly, use [get()](/api-reference/Piwik/Db#get) instead. - It accepts the following parameter(s): - `$dbConfig` (`array`|`null`) — Connection parameters in an array. Defaults to the `[database]` INI config section. -- It does not return anything. +- It does not return anything or a mixed result. @@ -154,7 +154,7 @@ For tests. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -351,7 +351,7 @@ Drops all tables #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -521,7 +521,7 @@ the table will not be locked for too long. The maximum number of rows to scan in one query. - `$params` (`array`) — Parameters to bind in the query, `array(param1 => value1, param2 => value2)` -- It does not return anything. +- It does not return anything or a mixed result. @@ -577,7 +577,7 @@ Checks whether the database user is allowed to lock tables. - It accepts the following parameter(s): - `$enable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -596,5 +596,5 @@ Checks whether the database user is allowed to lock tables. - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/DbHelper.md b/docs/4.x/generated/Piwik/DbHelper.md index 93d639c03..9fbf35337 100644 --- a/docs/4.x/generated/Piwik/DbHelper.md +++ b/docs/4.x/generated/Piwik/DbHelper.md @@ -33,5 +33,5 @@ DbHelper::createTable('tablename', $tableDefinition); The name of the table without any piwik prefix. - `$createDefinition` (`string`) — The table create definition -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Filesystem.md b/docs/4.x/generated/Piwik/Filesystem.md index 57bcfe642..8f370ca6d 100644 --- a/docs/4.x/generated/Piwik/Filesystem.md +++ b/docs/4.x/generated/Piwik/Filesystem.md @@ -30,7 +30,7 @@ _Note: This function does **not** create directories recursively._ - It accepts the following parameter(s): - `$path` (`string`) — The path of the directory to create. -- It does not return anything. +- It does not return anything or a mixed result. @@ -68,7 +68,7 @@ Recursively deletes a directory. If true, `$dir` is deleted, otherwise just its contents. - `$beforeUnlink` ([`Closure`](http://php.net/class.Closure)) — An optional closure to execute on a file path before unlinking. -- It does not return anything. +- It does not return anything or a mixed result. @@ -104,7 +104,7 @@ Copies the contents of a directory recursively from `$source` to `$target`. A directory to copy to, eg. '.'. - `$excludePhp` (`bool`) — Whether to avoid copying files if the file is related to PHP (includes .php, .tpl, .twig files). -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `Piwik\Exception\Exception` — If a file cannot be copied. diff --git a/docs/4.x/generated/Piwik/Log.md b/docs/4.x/generated/Piwik/Log.md index 1d1b410f7..541943f7c 100644 --- a/docs/4.x/generated/Piwik/Log.md +++ b/docs/4.x/generated/Piwik/Log.md @@ -77,7 +77,7 @@ Logs a message using the ERROR log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -94,7 +94,7 @@ Logs a message using the WARNING log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Logs a message using the INFO log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,7 +128,7 @@ Logs a message using the DEBUG log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. @@ -145,5 +145,5 @@ Logs a message using the VERBOSE log level. - It accepts the following parameter(s): - `$message` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Mail.md b/docs/4.x/generated/Piwik/Mail.md index 9b8635300..5e5716d75 100644 --- a/docs/4.x/generated/Piwik/Mail.md +++ b/docs/4.x/generated/Piwik/Mail.md @@ -58,7 +58,7 @@ Sets the sender. Email address of the sender. - `$name` (`null`|`string`) — Name of the sender. -- It does not return anything. +- It does not return anything or a mixed result. @@ -68,7 +68,7 @@ Sets the default sender #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `DI\NotFoundException` @@ -101,7 +101,7 @@ Returns the address the mail will be sent from - It accepts the following parameter(s): - `$body` ([`View`](../Piwik/View.md)|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `DI\NotFoundException` @@ -116,7 +116,7 @@ Sets the HTML part of the mail - It accepts the following parameter(s): - `$html` -- It does not return anything. +- It does not return anything or a mixed result. @@ -131,7 +131,7 @@ If bodyHtml is set, this will be used as alternative text part - It accepts the following parameter(s): - `$txt` -- It does not return anything. +- It does not return anything or a mixed result. @@ -164,7 +164,7 @@ Sets the subject of the mail - It accepts the following parameter(s): - `$subject` -- It does not return anything. +- It does not return anything or a mixed result. @@ -189,7 +189,7 @@ Adds a recipient - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -214,7 +214,7 @@ Add Bcc address - `$name` (`null`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -234,7 +234,7 @@ Removes all recipients and bccs from the list #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -249,7 +249,7 @@ Add Reply-To address - `$name` (`null`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -264,7 +264,7 @@ Sets the reply to address (all previously added addresses will be removed) - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -291,7 +291,7 @@ Returns the list of reply to addresses - `$cid` -- It does not return anything. +- It does not return anything or a mixed result. @@ -299,7 +299,7 @@ Returns the list of reply to addresses #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -324,7 +324,7 @@ Enables SMTP debugging - It accepts the following parameter(s): - `$smtpDebug` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Menu/MenuAbstract.md b/docs/4.x/generated/Piwik/Menu/MenuAbstract.md index fde0ce379..71c93f13f 100644 --- a/docs/4.x/generated/Piwik/Menu/MenuAbstract.md +++ b/docs/4.x/generated/Piwik/Menu/MenuAbstract.md @@ -56,7 +56,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,5 +107,5 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Menu/MenuAdmin.md b/docs/4.x/generated/Piwik/Menu/MenuAdmin.md index eba93fa98..b9995dd79 100644 --- a/docs/4.x/generated/Piwik/Menu/MenuAdmin.md +++ b/docs/4.x/generated/Piwik/Menu/MenuAdmin.md @@ -61,7 +61,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -76,7 +76,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -95,7 +95,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -112,7 +112,7 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. @@ -133,7 +133,7 @@ See add(). Adds a new menu item to the manage section of the user menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -154,7 +154,7 @@ See add(). Adds a new menu item to the development section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -175,7 +175,7 @@ See add(). Adds a new menu item to the diagnostic section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -196,7 +196,7 @@ See add(). Adds a new menu item to the platform section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -217,7 +217,7 @@ See add(). Adds a new menu item to the measurable section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -238,5 +238,5 @@ See add(). Adds a new menu item to the manage section of the admin menu. - `$tooltip` (`bool`|`string`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Menu/MenuTop.md b/docs/4.x/generated/Piwik/Menu/MenuTop.md index 01fd51440..eb5efe3aa 100644 --- a/docs/4.x/generated/Piwik/Menu/MenuTop.md +++ b/docs/4.x/generated/Piwik/Menu/MenuTop.md @@ -56,7 +56,7 @@ Adds a new entry to the menu. An icon classname, such as "icon-add". Only supported by admin menu - `$onclick` (`bool`|`string`) — Will execute the on click handler instead of executing the link. Only supported by admin menu. -- It does not return anything. +- It does not return anything or a mixed result. @@ -71,7 +71,7 @@ Removes an existing entry from the menu. The menu's category name. Can be a translation token. - `$subMenuName` (`bool`|`string`) — The menu item's name. Can be a translation token. -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Renames a single menu entry. - `$subMenuRenamed` -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ Edits a URL of an existing menu entry. - `$newUrl` -- It does not return anything. +- It does not return anything or a mixed result. @@ -128,5 +128,5 @@ Directly adds a menu entry containing html. - `$tooltip` (`string`) — Tooltip to display. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Metrics.md b/docs/4.x/generated/Piwik/Metrics.md index cf156a86b..b7d4fdd86 100644 --- a/docs/4.x/generated/Piwik/Metrics.md +++ b/docs/4.x/generated/Piwik/Metrics.md @@ -58,7 +58,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -66,7 +66,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -74,7 +74,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -82,7 +82,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -98,7 +98,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -106,7 +106,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$columnIdRaw` -- It does not return anything. +- It does not return anything or a mixed result. @@ -125,7 +125,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -133,7 +133,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -141,5 +141,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Metrics/Formatter.md b/docs/4.x/generated/Piwik/Metrics/Formatter.md index d3b6876c7..e410122cb 100644 --- a/docs/4.x/generated/Piwik/Metrics/Formatter.md +++ b/docs/4.x/generated/Piwik/Metrics/Formatter.md @@ -117,5 +117,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Metrics/Formatter/Html.md b/docs/4.x/generated/Piwik/Metrics/Formatter/Html.md index f31ec903c..85c7f62e8 100644 --- a/docs/4.x/generated/Piwik/Metrics/Formatter/Html.md +++ b/docs/4.x/generated/Piwik/Metrics/Formatter/Html.md @@ -117,5 +117,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Nonce.md b/docs/4.x/generated/Piwik/Nonce.md index 51e02daa5..79d2a7b4a 100644 --- a/docs/4.x/generated/Piwik/Nonce.md +++ b/docs/4.x/generated/Piwik/Nonce.md @@ -74,7 +74,7 @@ Force expiration of the current nonce. - It accepts the following parameter(s): - `$id` (`string`) — The unique nonce ID. -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Verifies and discards a nonce. The nonce's unique ID. See [getNonce()](/api-reference/Piwik/Nonce#getnonce). - `$nonce` (`string`|`null`) — The nonce from the client. If `null`, the value from the **nonce** query parameter is used. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the nonce is invalid. See {@link verifyNonce()}. diff --git a/docs/4.x/generated/Piwik/Notification/Manager.md b/docs/4.x/generated/Piwik/Notification/Manager.md index 9e8fa5ba2..db4bb1e18 100644 --- a/docs/4.x/generated/Piwik/Notification/Manager.md +++ b/docs/4.x/generated/Piwik/Notification/Manager.md @@ -26,5 +26,5 @@ has been posted and has not been closed/removed, it will be replaced with `$noti A unique identifier for this notification. The ID must be a valid HTML element ID. It can only contain alphanumeric characters (underscores can be used). - `$notification` ([`Notification`](../../Piwik/Notification.md)) — The notification to post. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Option.md b/docs/4.x/generated/Piwik/Option.md index 2b89cd6bf..f3239c2df 100644 --- a/docs/4.x/generated/Piwik/Option.md +++ b/docs/4.x/generated/Piwik/Option.md @@ -81,7 +81,7 @@ Sets an option value by name. - `$autoload` -- It does not return anything. +- It does not return anything or a mixed result. @@ -96,7 +96,7 @@ Deletes an option. Option name to match exactly. - `$value` (`string`) — If supplied the option will be deleted only if its value matches this value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -111,7 +111,7 @@ Deletes all options that match the supplied pattern. Pattern of key to match. `'%'` characters should be used as wildcards, and literal `'_'` characters should be escaped. - `$value` (`string`) — If supplied, options will be deleted only if their value matches this value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -122,5 +122,5 @@ Deletes all options that match the supplied pattern. - It accepts the following parameter(s): - `$name` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Period.md b/docs/4.x/generated/Piwik/Period.md index aff029786..a74ed17a9 100644 --- a/docs/4.x/generated/Piwik/Period.md +++ b/docs/4.x/generated/Piwik/Period.md @@ -48,7 +48,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -56,7 +56,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -96,7 +96,7 @@ For valid date formats have a look at the [Date::factory()](/api-reference/Piwik - It accepts the following parameter(s): - `$dateString` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If `$dateString` is in an invalid format or if the time is before Tue, 06 Aug 1991. @@ -225,7 +225,7 @@ Returns the start day and day after the end day for this period in the given tim - It accepts the following parameter(s): - `$timezone` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Period/Range.md b/docs/4.x/generated/Piwik/Period/Range.md index b97b99d76..17bc9c528 100644 --- a/docs/4.x/generated/Piwik/Period/Range.md +++ b/docs/4.x/generated/Piwik/Period/Range.md @@ -54,7 +54,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -62,7 +62,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -102,7 +102,7 @@ For valid date formats have a look at the [Date::factory()](/api-reference/Piwik - It accepts the following parameter(s): - `$dateString` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If `$dateString` is in an invalid format or if the time is before Tue, 06 Aug 1991. @@ -233,7 +233,7 @@ Returns the start day and day after the end day for this period in the given tim - It accepts the following parameter(s): - `$timezone` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -331,7 +331,7 @@ Sets the default end date of the period. - It accepts the following parameter(s): - `$oDate` ([`Date`](../../Piwik/Date.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -415,7 +415,7 @@ the range spans over. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -423,5 +423,5 @@ the range spans over. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Piwik.md b/docs/4.x/generated/Piwik/Piwik.md index 727635441..9a2585cd9 100644 --- a/docs/4.x/generated/Piwik/Piwik.md +++ b/docs/4.x/generated/Piwik/Piwik.md @@ -98,7 +98,7 @@ Check that the current user is either the specified user or the superuser. - It accepts the following parameter(s): - `$theUser` (`string`) — A username. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../Piwik/NoAccessException.md) — If the user is neither the Super User nor the user `$theUser`. @@ -143,7 +143,7 @@ Checks that the user is not the anonymous user. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../Piwik/NoAccessException.md) — if the current user is the anonymous user. @@ -155,7 +155,7 @@ Check that the current user has superuser access. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user is not the superuser. @@ -183,7 +183,7 @@ Checks that the current user has admin access to the requested list of sites. - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — One or more site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If user doesn't have admin access. @@ -205,7 +205,7 @@ Checks that the current user has write access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have write access to any site. @@ -242,7 +242,7 @@ Checks that the current user has admin access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have admin access to any site. @@ -283,7 +283,7 @@ Checks that the current user has view access to the requested list of sites - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — The list of site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user does not have view access to every site in the list. @@ -298,7 +298,7 @@ Checks that the current user has write access to the requested list of sites - It accepts the following parameter(s): - `$idSites` (`int`|`array`) — The list of site IDs to check access for. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current user does not have write access to every site in the list. @@ -320,7 +320,7 @@ Checks that the current user has view access to at least one site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if user doesn't have view access to any site. @@ -352,7 +352,7 @@ Redirects the current request to a new module and action. The target controller action, eg, `'index'`. - `$parameters` (`array`) — The query parameter values to modify before redirecting. -- It does not return anything. +- It does not return anything or a mixed result. @@ -384,7 +384,7 @@ Post an event to Piwik's event dispatcher which will execute the event's observe If true, plugins that are loaded after this event is fired will have their observers for this event executed. - `$plugins` (`array`|`null`) — The list of plugins to execute observers for. If null, all plugin observers will be executed. -- It does not return anything. +- It does not return anything or a mixed result. @@ -402,7 +402,7 @@ need to use this function._** The event name. - `$function` (`callable`|`array`) — The observer. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin.md b/docs/4.x/generated/Piwik/Plugin.md index ef241a440..8a54617ff 100644 --- a/docs/4.x/generated/Piwik/Plugin.md +++ b/docs/4.x/generated/Piwik/Plugin.md @@ -120,7 +120,7 @@ Constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -147,7 +147,7 @@ Returns plugin information, including: #### Signature - It is a **finalized** method. -- It does not return anything. +- It does not return anything or a mixed result. @@ -187,7 +187,7 @@ Useful for initialization code that uses translated strings. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -214,7 +214,7 @@ needs to: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if installation of fails for some reason. @@ -230,7 +230,7 @@ an [uninstall()](/api-reference/Piwik/Plugin#uninstall) method. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if uninstallation of fails for some reason. @@ -242,7 +242,7 @@ Executed every time the plugin is enabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -252,7 +252,7 @@ Executed every time the plugin is disabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -316,7 +316,7 @@ Tries to find a component such as a Menu or Tasks within this plugin. - `$expectedSubclass` -- It does not return anything. +- It does not return anything or a mixed result. @@ -340,7 +340,7 @@ Detect whether there are any missing dependencies. - It accepts the following parameter(s): - `$piwikVersion` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Archiver.md b/docs/4.x/generated/Piwik/Plugin/Archiver.md index 1b0c341a0..f07d952ca 100644 --- a/docs/4.x/generated/Piwik/Plugin/Archiver.md +++ b/docs/4.x/generated/Piwik/Plugin/Archiver.md @@ -81,7 +81,7 @@ Aggregate log table rows using a [LogAggregator](/api-reference/Piwik/DataAccess #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -99,7 +99,7 @@ method. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -129,7 +129,7 @@ for this period, segment and site. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Controller.md b/docs/4.x/generated/Piwik/Plugin/Controller.md index 6b33ad7ff..a5b60ad18 100644 --- a/docs/4.x/generated/Piwik/Plugin/Controller.md +++ b/docs/4.x/generated/Piwik/Plugin/Controller.md @@ -294,7 +294,7 @@ Sets the first date available in the period selector's calendar. The min date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -310,7 +310,7 @@ for a site (which varies based on the timezone of a site). The max date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -370,7 +370,7 @@ Also calls [setHostValidationVariablesView()](/api-reference/Piwik/Plugin/Contro - It accepts the following parameter(s): - `$view` -- It does not return anything. +- It does not return anything or a mixed result. @@ -389,7 +389,7 @@ Checks if the current host is valid and sets variables on the given view, includ - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -408,7 +408,7 @@ Sets general period variables on a view, including: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current period is invalid. @@ -435,7 +435,7 @@ This function will exit immediately after executing. The new date query parameter, eg, `'today'`. - `$parameters` (`array`) — Other query parameters to append to the URL. -- It does not return anything. +- It does not return anything or a mixed result. @@ -453,7 +453,7 @@ If called from JavaScript by using the `ajaxHelper` you have to call `ajaxHelper #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../../Piwik/NoAccessException.md) — If the token doesn't match. diff --git a/docs/4.x/generated/Piwik/Plugin/ControllerAdmin.md b/docs/4.x/generated/Piwik/Plugin/ControllerAdmin.md index 6907816be..eba2301a3 100644 --- a/docs/4.x/generated/Piwik/Plugin/ControllerAdmin.md +++ b/docs/4.x/generated/Piwik/Plugin/ControllerAdmin.md @@ -272,7 +272,7 @@ Sets the first date available in the period selector's calendar. The min date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -288,7 +288,7 @@ for a site (which varies based on the timezone of a site). The max date. - `$view` ([`View`](../../Piwik/View.md)) — The view that contains the period selector. -- It does not return anything. +- It does not return anything or a mixed result. @@ -348,7 +348,7 @@ Also calls [setHostValidationVariablesView()](/api-reference/Piwik/Plugin/Contro - It accepts the following parameter(s): - `$view` -- It does not return anything. +- It does not return anything or a mixed result. @@ -367,7 +367,7 @@ Checks if the current host is valid and sets variables on the given view, includ - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -386,7 +386,7 @@ Sets general period variables on a view, including: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if the current period is invalid. @@ -413,7 +413,7 @@ This function will exit immediately after executing. The new date query parameter, eg, `'today'`. - `$parameters` (`array`) — Other query parameters to append to the URL. -- It does not return anything. +- It does not return anything or a mixed result. @@ -431,7 +431,7 @@ If called from JavaScript by using the `ajaxHelper` you have to call `ajaxHelper #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Piwik\NoAccessException`](../../Piwik/NoAccessException.md) — If the token doesn't match. @@ -475,5 +475,5 @@ Assigns the following variables: - It accepts the following parameter(s): - `$view` ([`View`](../../Piwik/View.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Dimension/ActionDimension.md b/docs/4.x/generated/Piwik/Plugin/Dimension/ActionDimension.md index 96a314d46..14e9b9aba 100644 --- a/docs/4.x/generated/Piwik/Plugin/Dimension/ActionDimension.md +++ b/docs/4.x/generated/Piwik/Plugin/Dimension/ActionDimension.md @@ -313,7 +313,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -368,7 +368,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -381,7 +381,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -438,7 +438,7 @@ $segmentsList->addSegment($segment); - `$dimensionSegmentFactory` ([`DimensionSegmentFactory`](../../../Piwik/Columns/DimensionSegmentFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -457,7 +457,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -524,7 +524,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md b/docs/4.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md index 0550bb354..6d81778f1 100644 --- a/docs/4.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md +++ b/docs/4.x/generated/Piwik/Plugin/Dimension/ConversionDimension.md @@ -314,7 +314,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -369,7 +369,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -382,7 +382,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -439,7 +439,7 @@ $segmentsList->addSegment($segment); - `$dimensionSegmentFactory` ([`DimensionSegmentFactory`](../../../Piwik/Columns/DimensionSegmentFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -458,7 +458,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -525,7 +525,7 @@ Gets an instance of all available visit, action and conversion dimension. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Dimension/VisitDimension.md b/docs/4.x/generated/Piwik/Plugin/Dimension/VisitDimension.md index 911e92ede..c1d370b48 100644 --- a/docs/4.x/generated/Piwik/Plugin/Dimension/VisitDimension.md +++ b/docs/4.x/generated/Piwik/Plugin/Dimension/VisitDimension.md @@ -316,7 +316,7 @@ will be done. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -371,7 +371,7 @@ Sets (overwrites) the SQL segment - It accepts the following parameter(s): - `$segment` -- It does not return anything. +- It does not return anything or a mixed result. @@ -384,7 +384,7 @@ Sets (overwrites the dimension type) - It accepts the following parameter(s): - `$type` -- It does not return anything. +- It does not return anything or a mixed result. @@ -441,7 +441,7 @@ $segmentsList->addSegment($segment); - `$dimensionSegmentFactory` ([`DimensionSegmentFactory`](../../../Piwik/Columns/DimensionSegmentFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -460,7 +460,7 @@ For certain dimension types, some metrics will be added automatically. - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../../Piwik/Columns/DimensionMetricFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -527,7 +527,7 @@ Get all visit dimensions that are defined by all activated plugins. - It accepts the following parameter(s): - `$plugin` ([`Plugin`](../../../Piwik/Plugin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Menu.md b/docs/4.x/generated/Piwik/Plugin/Menu.md index 6ef7ae0be..fe98dcb95 100644 --- a/docs/4.x/generated/Piwik/Plugin/Menu.md +++ b/docs/4.x/generated/Piwik/Plugin/Menu.md @@ -107,7 +107,7 @@ Configures the top menu which is supposed to contain analytics related items suc - It accepts the following parameter(s): - `$menu` ([`MenuTop`](../../Piwik/Menu/MenuTop.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -121,5 +121,5 @@ Configures the admin menu which is supposed to contain only administration relat - It accepts the following parameter(s): - `$menu` ([`MenuAdmin`](../../Piwik/Menu/MenuAdmin.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Report.md b/docs/4.x/generated/Piwik/Plugin/Report.md index b9f9747b9..dd57316f4 100644 --- a/docs/4.x/generated/Piwik/Plugin/Report.md +++ b/docs/4.x/generated/Piwik/Plugin/Report.md @@ -222,7 +222,7 @@ created in most page requests. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -253,7 +253,7 @@ throw new Exception('Setting XYZ is not enabled or the user has not enough permi #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -293,7 +293,7 @@ default request config. For instance you can change how many rows are displayed - It accepts the following parameter(s): - `$view` ([`ViewDataTable`](../../Piwik/Plugin/ViewDataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -344,7 +344,7 @@ $widgetsList->addToContainerWidget($containerId = 'Products', $factory->createWi - `$factory` ([`ReportWidgetFactory`](../../Piwik/Report/ReportWidgetFactory.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -461,7 +461,7 @@ the current requested date, period and site. - `$infos` -- It does not return anything. +- It does not return anything or a mixed result. @@ -517,7 +517,7 @@ recommended related report. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Segment.md b/docs/4.x/generated/Piwik/Plugin/Segment.md index 375c2dd55..9fd09b622 100644 --- a/docs/4.x/generated/Piwik/Plugin/Segment.md +++ b/docs/4.x/generated/Piwik/Plugin/Segment.md @@ -49,7 +49,7 @@ created. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -64,7 +64,7 @@ this as well. For example "Any URL including protocol. The URL must be URL encod - It accepts the following parameter(s): - `$acceptedValues` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -78,7 +78,7 @@ or 'General_Visit'. - It accepts the following parameter(s): - `$category` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ translation key such as 'Actions_ColumnEntryPageTitle' or 'Resolution_ColumnReso - It accepts the following parameter(s): - `$name` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -107,7 +107,7 @@ you need to set "&segment=searches>0" in the UI. - It accepts the following parameter(s): - `$segment` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -127,7 +127,7 @@ If the closure returns NULL, then Piwik assumes the segment sub-string will not - It accepts the following parameter(s): - `$sqlFilter` (`string`|[`Closure`](http://php.net/class.Closure)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -143,7 +143,7 @@ segment. This callback is called shortly before [setSqlFilter()](/api-reference/ - It accepts the following parameter(s): - `$sqlFilterValue` (`string`|`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -157,7 +157,7 @@ Defines to which column in the MySQL database the segment belongs: 'mytablename. - It accepts the following parameter(s): - `$sqlSegment` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -172,7 +172,7 @@ All set segments will be applied via an OR operator. - It accepts the following parameter(s): - `$segments` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -185,7 +185,7 @@ Set (overwrite) the type of this segment which is usually either a 'dimension' o - It accepts the following parameter(s): - `$type` (`string`) — See constansts TYPE_* -- It does not return anything. +- It does not return anything or a mixed result. @@ -208,7 +208,7 @@ Set callback which will be executed when user will call for suggested values for - It accepts the following parameter(s): - `$suggestedValuesCallback` (`callable`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -221,7 +221,7 @@ Set callback which will be executed when user will call for suggested values for - It accepts the following parameter(s): - `$suggestedValuesApi` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -236,7 +236,7 @@ a certain segment only available to users having super user access you could do - It accepts the following parameter(s): - `$permission` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -251,7 +251,7 @@ These types of segments are, for example, used in unions for other segments, but - It accepts the following parameter(s): - `$value` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Tasks.md b/docs/4.x/generated/Piwik/Plugin/Tasks.md index 1a19950fa..1788086a1 100644 --- a/docs/4.x/generated/Piwik/Plugin/Tasks.md +++ b/docs/4.x/generated/Piwik/Plugin/Tasks.md @@ -54,7 +54,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. @@ -73,7 +73,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ See [hourly()](/api-reference/Piwik/Plugin/Tasks#hourly) - `$priority` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/ViewDataTable.md b/docs/4.x/generated/Piwik/Plugin/ViewDataTable.md index 9d30865ae..d63fef845 100644 --- a/docs/4.x/generated/Piwik/Plugin/ViewDataTable.md +++ b/docs/4.x/generated/Piwik/Plugin/ViewDataTable.md @@ -328,7 +328,7 @@ Display a meaningful error message when any invalid parameter is being set. - It accepts the following parameter(s): - `$overrideParams` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `` @@ -371,5 +371,5 @@ default, it is assumed visualizations do not support comparison. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugin/Visualization.md b/docs/4.x/generated/Piwik/Plugin/Visualization.md index 12284ad8b..b0c8e1d09 100644 --- a/docs/4.x/generated/Piwik/Plugin/Visualization.md +++ b/docs/4.x/generated/Piwik/Plugin/Visualization.md @@ -338,7 +338,7 @@ Display a meaningful error message when any invalid parameter is being set. - It accepts the following parameter(s): - `$overrideParams` -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `` @@ -381,7 +381,7 @@ default, it is assumed visualizations do not support comparison. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -397,7 +397,7 @@ Assigns a template variable making it available in the Twig template specified b One or more variable names to set. - `$value` (`mixed`) — The value to set each variable to. -- It does not return anything. +- It does not return anything or a mixed result. @@ -409,7 +409,7 @@ Derived classes should override this method if they change the amount of data th #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -422,7 +422,7 @@ data. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -435,7 +435,7 @@ limit and truncate reports). #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -445,7 +445,7 @@ Hook that is executed after generic filters are applied. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -457,7 +457,7 @@ Use this method to format the report data before the view is rendered. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -468,5 +468,5 @@ be a certain value, despite changes from plugins and query parameters. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md b/docs/4.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md index 384ee4be9..eaa467a37 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreHome/Columns/Metrics/EvolutionMetric.md @@ -258,7 +258,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -269,7 +269,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -282,5 +282,5 @@ public for Insights use. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md index 478d92cb4..d31018975 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Metrics/Formatter/Numeric.md @@ -120,5 +120,5 @@ are found through report metadata and DataTable metadata. Whitelist of names of metrics to format. - `$formatAll` (`boolean`) — If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md index d72d23160..e050618dc 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Cloud/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md index 331ac1b46..7a4b984d4 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Graph/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md index 49bf705a0..5757d76f4 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/HtmlTable/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md index 2aca48a46..833867693 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md index 399b7df8d..0497f9a87 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md index db343c455..cdca2e281 100644 --- a/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/CoreVisualizations/Visualizations/Sparklines/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/CoreVisualizations/Visuali - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/CoreVisualizations/Visualizatio - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/CustomJsTracker/TrackerUpdater.md b/docs/4.x/generated/Piwik/Plugins/CustomJsTracker/TrackerUpdater.md index 3e6055fe4..65d751451 100644 --- a/docs/4.x/generated/Piwik/Plugins/CustomJsTracker/TrackerUpdater.md +++ b/docs/4.x/generated/Piwik/Plugins/CustomJsTracker/TrackerUpdater.md @@ -24,7 +24,7 @@ Checks whether the Piwik JavaScript tracker file "piwik.js" is writable. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — In case the piwik.js file is not writable. @@ -40,5 +40,5 @@ an exception in such a case and instead just to nothing. To check if the update #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md b/docs/4.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md index 40a539556..96c6013df 100644 --- a/docs/4.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md +++ b/docs/4.x/generated/Piwik/Plugins/DevicePlugins/DevicePlugins.md @@ -52,7 +52,7 @@ Constructor. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -79,7 +79,7 @@ Returns plugin information, including: #### Signature - It is a **finalized** method. -- It does not return anything. +- It does not return anything or a mixed result. @@ -119,7 +119,7 @@ Useful for initialization code that uses translated strings. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -146,7 +146,7 @@ needs to: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if installation of fails for some reason. @@ -162,7 +162,7 @@ an [uninstall()](/api-reference/Piwik/Plugins/DevicePlugins/DevicePlugins#uninst #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if uninstallation of fails for some reason. @@ -174,7 +174,7 @@ Executed every time the plugin is enabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -184,7 +184,7 @@ Executed every time the plugin is disabled. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -248,7 +248,7 @@ Tries to find a component such as a Menu or Tasks within this plugin. - `$expectedSubclass` -- It does not return anything. +- It does not return anything or a mixed result. @@ -272,7 +272,7 @@ Detect whether there are any missing dependencies. - It accepts the following parameter(s): - `$piwikVersion` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md b/docs/4.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md index da75fcbbb..46e7ba256 100644 --- a/docs/4.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md +++ b/docs/4.x/generated/Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md @@ -70,7 +70,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$item` ([`DiagnosticResultItem`](../../../../Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResultItem.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -81,7 +81,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$items` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -100,7 +100,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$longErrorMessage` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md b/docs/4.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md index e8503d520..fd1e99965 100644 --- a/docs/4.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md +++ b/docs/4.x/generated/Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md @@ -29,7 +29,7 @@ Set profile information - It accepts the following parameter(s): - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md b/docs/4.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md index 6a5292ef4..bda81e550 100644 --- a/docs/4.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md +++ b/docs/4.x/generated/Piwik/Plugins/Live/VisitorDetailsAbstract.md @@ -48,7 +48,7 @@ Makes it possible to extend the visitor details returned from API - It accepts the following parameter(s): - `$visitor` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -70,7 +70,7 @@ Makes it possible to enrich the action set for a single visit List of action to manipulate - `$visitorDetails` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -104,7 +104,7 @@ $actions = array ( action set to enrich - `$visitIds` (`array`) — list of visit ids -- It does not return anything. +- It does not return anything or a mixed result. @@ -130,7 +130,7 @@ Allows filtering the provided actions - `$visitorDetailsArray` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -155,7 +155,7 @@ Allows extending each action with additional information - `$visitorDetails` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -294,7 +294,7 @@ Will be called when visitor profile is initialized - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -316,7 +316,7 @@ Will be called for every action within the profile - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -343,7 +343,7 @@ Will be called for every action within the profile - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -369,7 +369,7 @@ Can be used to set profile information that requires data that was set while ite - `$profile` (`array`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md b/docs/4.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md index 39a38aa01..4459d4ad2 100644 --- a/docs/4.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md +++ b/docs/4.x/generated/Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/Live/Visualizations/Visito - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/Live/Visualizations/VisitorLog/ - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md b/docs/4.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md index 8d1d1bfa7..ba0168cde 100644 --- a/docs/4.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md +++ b/docs/4.x/generated/Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md @@ -256,7 +256,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -267,7 +267,7 @@ Constructor. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -280,5 +280,5 @@ public for Insights use. - It accepts the following parameter(s): - `$row` ([`Row`](../../../../../Piwik/DataTable/Row.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md b/docs/4.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md index 99e650a18..0dcf3a7d6 100644 --- a/docs/4.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md +++ b/docs/4.x/generated/Piwik/Plugins/Tour/Engagement/Challenge.md @@ -86,7 +86,7 @@ complete a challenge. For example "add_user" challenge could directly link to th #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md b/docs/4.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md index 52e8f32a3..9b527b7ae 100644 --- a/docs/4.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md +++ b/docs/4.x/generated/Piwik/Plugins/TreemapVisualization/TreemapConfig.md @@ -905,7 +905,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -919,7 +919,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -943,7 +943,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -951,7 +951,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -959,7 +959,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -996,7 +996,7 @@ use [addRelatedReport()](/api-reference/Piwik/Plugins/TreemapVisualization/Treem - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1013,7 +1013,7 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1028,7 +1028,7 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1039,5 +1039,5 @@ See [$translations](/api-reference/Piwik/Plugins/TreemapVisualization/TreemapCon - It accepts the following parameter(s): - `$table` ([`DataTable`](../../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/RankingQuery.md b/docs/4.x/generated/Piwik/RankingQuery.md index 8936e31d3..0142f91e4 100644 --- a/docs/4.x/generated/Piwik/RankingQuery.md +++ b/docs/4.x/generated/Piwik/RankingQuery.md @@ -64,7 +64,7 @@ Set the limit after which everything is grouped to "Others". - It accepts the following parameter(s): - `$limit` (`int`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -77,7 +77,7 @@ Set the value to use for the label in the 'Others' row. - It accepts the following parameter(s): - `$value` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -92,7 +92,7 @@ Labels are the columns that are replaced with "Others" after the limit. - It accepts the following parameter(s): - `$labelColumn` (`string`|`array`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -115,7 +115,7 @@ Add a column that has be added to the outer queries. - `$aggregationFunction` (`string`|`bool`) — If set, this function is used to aggregate the values of "Others", eg, `'min'`, `'max'` or `'sum'`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -132,7 +132,7 @@ by [execute()](/api-reference/Piwik/RankingQuery#execute). - It accepts the following parameter(s): - `$column` string Name of the column. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if method is used more than once. @@ -160,7 +160,7 @@ rows `log_action.type = TYPE_DOWNLOAD`. string The column name to partition by. - `$possibleValues` Array of possible column values. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — if method is used more than once. diff --git a/docs/4.x/generated/Piwik/Report/ReportWidgetConfig.md b/docs/4.x/generated/Piwik/Report/ReportWidgetConfig.md index 804641d23..445fa52d2 100644 --- a/docs/4.x/generated/Piwik/Report/ReportWidgetConfig.md +++ b/docs/4.x/generated/Piwik/Report/ReportWidgetConfig.md @@ -111,7 +111,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -257,7 +257,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Report/ReportWidgetCo #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -267,7 +267,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Report/ReportWidgetC #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -285,7 +285,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/Daily.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/Daily.md index 22d153744..a18d12e05 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/Daily.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/Daily.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/Hourly.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/Hourly.md index 24b793e4f..c38b08d75 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/Hourly.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/Hourly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/Monthly.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/Monthly.md index 1c9665d63..968b4c5a8 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/Monthly.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/Monthly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/Schedule.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/Schedule.md index 030fb0424..a9e950657 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/Schedule.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/Schedule.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md index 2e8c26330..31b24277a 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/SpecificTime.md @@ -22,7 +22,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Schedule/Weekly.md b/docs/4.x/generated/Piwik/Scheduler/Schedule/Weekly.md index ff34945e0..9b67d2675 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Schedule/Weekly.md +++ b/docs/4.x/generated/Piwik/Scheduler/Schedule/Weekly.md @@ -24,7 +24,7 @@ Sets the hour of the day on which the task should be executed. - It accepts the following parameter(s): - `$hour` (`int`) — Must be `>= 0` and `< 24`. -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current scheduled period is **hourly** or if `$hour` is invalid. diff --git a/docs/4.x/generated/Piwik/Scheduler/Scheduler.md b/docs/4.x/generated/Piwik/Scheduler/Scheduler.md index 96eb5f0a2..66403091f 100644 --- a/docs/4.x/generated/Piwik/Scheduler/Scheduler.md +++ b/docs/4.x/generated/Piwik/Scheduler/Scheduler.md @@ -57,7 +57,7 @@ was changed. - It accepts the following parameter(s): - `$task` ([`Task`](../../Piwik/Scheduler/Task.md)) — Describes the scheduled task being rescheduled. -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,5 +75,5 @@ The task will be run the first time tomorrow. - It accepts the following parameter(s): - `$task` ([`Task`](../../Piwik/Scheduler/Task.md)) — Describes the scheduled task being rescheduled. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Segment.md b/docs/4.x/generated/Piwik/Segment.md index f252edecf..ccd8e1987 100644 --- a/docs/4.x/generated/Piwik/Segment.md +++ b/docs/4.x/generated/Piwik/Segment.md @@ -88,7 +88,7 @@ Returns `true` if the segment is empty, `false` if otherwise. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -135,7 +135,7 @@ condition is empty. - It accepts the following parameter(s): - `$definition` -- It does not return anything. +- It does not return anything or a mixed result. @@ -209,5 +209,5 @@ The combination is naive in that it does not take order of operations into accou - It accepts the following parameter(s): - `$idSite` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Segment/SegmentsList.md b/docs/4.x/generated/Piwik/Segment/SegmentsList.md index 18a706e14..9df735b58 100644 --- a/docs/4.x/generated/Piwik/Segment/SegmentsList.md +++ b/docs/4.x/generated/Piwik/Segment/SegmentsList.md @@ -28,7 +28,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$segment` ([`Segment`](../../Piwik/Plugin/Segment.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -53,7 +53,7 @@ Removes one or more segments from the segments list. The segment category id. Can be a translation token eg 'General_Visits' see Segment::getCategoryId(). - `$segmentExpression` (`string`|`false`) — The segment expression name to remove eg 'pageUrl'. If not supplied, all segments within that category will be removed. -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Settings/FieldConfig/ArrayField.md b/docs/4.x/generated/Piwik/Settings/FieldConfig/ArrayField.md index 6fc43a5b3..0001059cd 100644 --- a/docs/4.x/generated/Piwik/Settings/FieldConfig/ArrayField.md +++ b/docs/4.x/generated/Piwik/Settings/FieldConfig/ArrayField.md @@ -99,5 +99,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Settings/FieldConfig/MultiPair.md b/docs/4.x/generated/Piwik/Settings/FieldConfig/MultiPair.md index e5a562ca3..b6d44365b 100644 --- a/docs/4.x/generated/Piwik/Settings/FieldConfig/MultiPair.md +++ b/docs/4.x/generated/Piwik/Settings/FieldConfig/MultiPair.md @@ -116,5 +116,5 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md b/docs/4.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md index eb7ab0da3..320b8da48 100644 --- a/docs/4.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md +++ b/docs/4.x/generated/Piwik/Settings/Plugin/SystemConfigSetting.md @@ -83,7 +83,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -96,7 +96,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -146,7 +146,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/4.x/generated/Piwik/Settings/Plugin/SystemSetting.md b/docs/4.x/generated/Piwik/Settings/Plugin/SystemSetting.md index 1be455603..9137acd97 100644 --- a/docs/4.x/generated/Piwik/Settings/Plugin/SystemSetting.md +++ b/docs/4.x/generated/Piwik/Settings/Plugin/SystemSetting.md @@ -80,7 +80,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -93,7 +93,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,7 +114,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -140,7 +140,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/4.x/generated/Piwik/Settings/Setting.md b/docs/4.x/generated/Piwik/Settings/Setting.md index c9fda93a1..f12b799f4 100644 --- a/docs/4.x/generated/Piwik/Settings/Setting.md +++ b/docs/4.x/generated/Piwik/Settings/Setting.md @@ -80,7 +80,7 @@ Sets/overwrites the current default value - It accepts the following parameter(s): - `$defaultValue` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -93,7 +93,7 @@ Set whether setting is writable or not. For example to hide setting from the UI - It accepts the following parameter(s): - `$isWritable` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -114,7 +114,7 @@ Saves (persists) the value for this setting in the database if a value has been #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -143,7 +143,7 @@ method. Before storing the actual value, the value will be converted to the actu - It accepts the following parameter(s): - `$value` (`mixed`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If the current user is not allowed to change the value of this setting. diff --git a/docs/4.x/generated/Piwik/Settings/Settings.md b/docs/4.x/generated/Piwik/Settings/Settings.md index d7a6459a3..3d1735d18 100644 --- a/docs/4.x/generated/Piwik/Settings/Settings.md +++ b/docs/4.x/generated/Piwik/Settings/Settings.md @@ -29,7 +29,7 @@ The abstract class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -52,7 +52,7 @@ Adds a new setting to the settings container. - It accepts the following parameter(s): - `$setting` ([`Setting`](../../Piwik/Settings/Setting.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) — If there is a setting with the same name that already exists. If the name contains non-alphanumeric characters. @@ -65,5 +65,5 @@ Saves (persists) the current setting values in the database. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Site.md b/docs/4.x/generated/Piwik/Site.md index 9debbb848..fc8e48640 100644 --- a/docs/4.x/generated/Piwik/Site.md +++ b/docs/4.x/generated/Piwik/Site.md @@ -90,7 +90,7 @@ individual site data. - It accepts the following parameter(s): - `$sites` (`array`) — The array of sites data. Indexed by site ID. eg, array('1' => array('name' => 'Site 1', ...), '2' => array('name' => 'Site 2', ...))` -- It does not return anything. +- It does not return anything or a mixed result. @@ -297,7 +297,7 @@ See also [setSites()](/api-reference/Piwik/Site#setsites) and setSitesFromArray( #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -312,7 +312,7 @@ See also [setSites()](/api-reference/Piwik/Site#setsites) and setSitesFromArray( - It accepts the following parameter(s): - `$idSite` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Translation/Translator.md b/docs/4.x/generated/Piwik/Translation/Translator.md index 599b08f9b..fa2c28692 100644 --- a/docs/4.x/generated/Piwik/Translation/Translator.md +++ b/docs/4.x/generated/Piwik/Translation/Translator.md @@ -84,7 +84,7 @@ cannot be found for the ID, the ID is returned. - It accepts the following parameter(s): - `$language` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -104,7 +104,7 @@ Generate javascript translations array #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -117,7 +117,7 @@ Add a directory containing translations. - It accepts the following parameter(s): - `$directory` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -127,7 +127,7 @@ Should be used by tests only, and this method should eventually be removed. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Updater.md b/docs/4.x/generated/Piwik/Updater.md index e6b465f5b..4ae3c8879 100644 --- a/docs/4.x/generated/Piwik/Updater.md +++ b/docs/4.x/generated/Piwik/Updater.md @@ -26,7 +26,7 @@ Execute multiple migration queries from a single Update file. The path to the Updates file. - `$migrations` ([`Migration[]`](../Piwik/Updater/Migration.md)) — An array of migrations -- It does not return anything. +- It does not return anything or a mixed result. @@ -39,7 +39,7 @@ Execute multiple migration queries from a single Update file. - `$migration` ([`Migration`](../Piwik/Updater/Migration.md)) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - `Piwik\UpdaterErrorException` diff --git a/docs/4.x/generated/Piwik/Updates.md b/docs/4.x/generated/Piwik/Updates.md index c5089b13c..77c037880 100644 --- a/docs/4.x/generated/Piwik/Updates.md +++ b/docs/4.x/generated/Piwik/Updates.md @@ -54,5 +54,5 @@ See \Piwik\Plugins\ExamplePlugin\Updates\Updates\_0\_0\_2 for an example. - It accepts the following parameter(s): - `$updater` ([`Updater`](../Piwik/Updater.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Url.md b/docs/4.x/generated/Piwik/Url.md index b6b8d7ada..289dc78ed 100644 --- a/docs/4.x/generated/Piwik/Url.md +++ b/docs/4.x/generated/Piwik/Url.md @@ -235,7 +235,7 @@ to the current URL without query string. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -248,7 +248,7 @@ Redirects the user to the specified URL. - It accepts the following parameter(s): - `$url` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/4.x/generated/Piwik/Version.md b/docs/4.x/generated/Piwik/Version.md index 774e22b56..e69f87aa2 100644 --- a/docs/4.x/generated/Piwik/Version.md +++ b/docs/4.x/generated/Piwik/Version.md @@ -22,7 +22,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. @@ -33,5 +33,5 @@ The class defines the following methods: - It accepts the following parameter(s): - `$version` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/View.md b/docs/4.x/generated/Piwik/View.md index 9094c32ff..d14da48a9 100644 --- a/docs/4.x/generated/Piwik/View.md +++ b/docs/4.x/generated/Piwik/View.md @@ -145,7 +145,7 @@ Disables the cache buster (adding of ?cb=. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -185,7 +185,7 @@ Variable names may not be prefixed with '_'. The variable name. - `$val` (`mixed`) — The variable value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -228,7 +228,7 @@ Unsets a template variable. - It accepts the following parameter(s): - `$name` (`string`) — The name of the template variable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -256,7 +256,7 @@ set just before rendering. - It accepts the following parameter(s): - `$contentType` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -273,7 +273,7 @@ embedded in iframes. Learn more [here](https://developer.mozilla.org/en-US/docs/ - It accepts the following parameter(s): - `$option` (`string`) — ('deny' or 'sameorigin') -- It does not return anything. +- It does not return anything or a mixed result. @@ -316,5 +316,5 @@ Sets whether a strict Referrer-Policy header will be sent (if not, nothing is se - It accepts the following parameter(s): - `$useStrictReferrerPolicy` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/View/UIControl.md b/docs/4.x/generated/Piwik/View/UIControl.md index 4167c2df4..189f46b1e 100644 --- a/docs/4.x/generated/Piwik/View/UIControl.md +++ b/docs/4.x/generated/Piwik/View/UIControl.md @@ -139,7 +139,7 @@ Disables the cache buster (adding of ?cb=. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -177,7 +177,7 @@ Sets a variable. See View::\_\_set(). The variable name. - `$val` (`mixed`) — The variable value. -- It does not return anything. +- It does not return anything or a mixed result. @@ -218,7 +218,7 @@ Unsets a template variable. - It accepts the following parameter(s): - `$name` (`string`) — The name of the template variable. -- It does not return anything. +- It does not return anything or a mixed result. @@ -245,7 +245,7 @@ set just before rendering. - It accepts the following parameter(s): - `$contentType` (`string`) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -262,7 +262,7 @@ embedded in iframes. Learn more [here](https://developer.mozilla.org/en-US/docs/ - It accepts the following parameter(s): - `$option` (`string`) — ('deny' or 'sameorigin') -- It does not return anything. +- It does not return anything or a mixed result. @@ -305,7 +305,7 @@ Sets whether a strict Referrer-Policy header will be sent (if not, nothing is se - It accepts the following parameter(s): - `$useStrictReferrerPolicy` (`bool`) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/ViewDataTable/Config.md b/docs/4.x/generated/Piwik/ViewDataTable/Config.md index 2f2a50080..4bc3e21c9 100644 --- a/docs/4.x/generated/Piwik/ViewDataTable/Config.md +++ b/docs/4.x/generated/Piwik/ViewDataTable/Config.md @@ -964,7 +964,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -978,7 +978,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('show_limit_control', 'show_goals')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1002,7 +1002,7 @@ by name. - It accepts the following parameter(s): - `$columnToRemove` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1010,7 +1010,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1018,7 +1018,7 @@ by name. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -1037,7 +1037,7 @@ report list. The report's display name, eg, `'Browsers'`. - `$queryParams` (`array`) — Any extra query parameters to set in related report's URL, eg, `array('idGoal' => 'ecommerceOrder')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1055,7 +1055,7 @@ use [addRelatedReport()](/api-reference/Piwik/ViewDataTable/Config#addrelatedrep - It accepts the following parameter(s): - `$relatedReports` (`array`) — Array mapping report IDs with their internationalized display titles, eg, ``` array( 'DevicesDetection.getBrowsers' => 'Browsers', 'Resolution.getConfiguration' => 'Configurations' ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1072,7 +1072,7 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations). The name of a column in the report data, eg, `'nb_visits'` or `'goal_1_nb_conversions'`. - `$translation` (`string`) — The internationalized text, eg, `'Visits'` or `"Conversions for 'My Goal'"`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -1087,7 +1087,7 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations) and - It accepts the following parameter(s): - `$translations` (`array`) — An array of column name => text mappings, eg, ``` array( 'nb_visits' => 'Visits', 'goal_1_nb_conversions' => "Conversions for 'My Goal'" ) ``` -- It does not return anything. +- It does not return anything or a mixed result. @@ -1098,5 +1098,5 @@ See [$translations](/api-reference/Piwik/ViewDataTable/Config#$translations) and - It accepts the following parameter(s): - `$table` ([`DataTable`](../../Piwik/DataTable.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/ViewDataTable/RequestConfig.md b/docs/4.x/generated/Piwik/ViewDataTable/RequestConfig.md index 68ece6205..36ee4a6a3 100644 --- a/docs/4.x/generated/Piwik/ViewDataTable/RequestConfig.md +++ b/docs/4.x/generated/Piwik/ViewDataTable/RequestConfig.md @@ -411,7 +411,7 @@ The class defines the following methods: #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -425,7 +425,7 @@ to learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('disable_queued_filters', 'filter_column')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -439,7 +439,7 @@ learn more. - It accepts the following parameter(s): - `$propertyNames` (`array`) — List of property names, eg, `array('disable_queued_filters', 'filter_column')`. -- It does not return anything. +- It does not return anything or a mixed result. @@ -454,7 +454,7 @@ learn more. - `$actualColumns` -- It does not return anything. +- It does not return anything or a mixed result. @@ -462,7 +462,7 @@ learn more. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -470,7 +470,7 @@ learn more. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -481,7 +481,7 @@ learn more. - It accepts the following parameter(s): - `$paramName` -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Widget/Widget.md b/docs/4.x/generated/Piwik/Widget/Widget.md index 3b4eba476..21e9b1da5 100644 --- a/docs/4.x/generated/Piwik/Widget/Widget.md +++ b/docs/4.x/generated/Piwik/Widget/Widget.md @@ -27,7 +27,7 @@ The class defines the following methods: - It accepts the following parameter(s): - `$config` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Widget/WidgetConfig.md b/docs/4.x/generated/Piwik/Widget/WidgetConfig.md index 99a65e5d2..19a497a36 100644 --- a/docs/4.x/generated/Piwik/Widget/WidgetConfig.md +++ b/docs/4.x/generated/Piwik/Widget/WidgetConfig.md @@ -107,7 +107,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -255,7 +255,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetConfig#i #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -265,7 +265,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetConfig# #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -283,7 +283,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) diff --git a/docs/4.x/generated/Piwik/Widget/WidgetContainerConfig.md b/docs/4.x/generated/Piwik/Widget/WidgetContainerConfig.md index aaef03464..c2fc9fdea 100644 --- a/docs/4.x/generated/Piwik/Widget/WidgetContainerConfig.md +++ b/docs/4.x/generated/Piwik/Widget/WidgetContainerConfig.md @@ -116,7 +116,7 @@ not needed to be configured manually. #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -262,7 +262,7 @@ Enables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetContaine #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -272,7 +272,7 @@ Disables the widget. See [isEnabled()](/api-reference/Piwik/Widget/WidgetContain #### Signature -- It does not return anything. +- It does not return anything or a mixed result. @@ -290,7 +290,7 @@ if (!$this->isEnabled()) { #### Signature -- It does not return anything. +- It does not return anything or a mixed result. - It throws one of the following exceptions: - [`Exception`](http://php.net/class.Exception) @@ -468,7 +468,7 @@ Set (overwrite) widget configs. - It accepts the following parameter(s): - `$configs` ([`WidgetConfig[]`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. diff --git a/docs/4.x/generated/Piwik/Widget/WidgetsList.md b/docs/4.x/generated/Piwik/Widget/WidgetsList.md index d2ee54fa6..c83d28766 100644 --- a/docs/4.x/generated/Piwik/Widget/WidgetsList.md +++ b/docs/4.x/generated/Piwik/Widget/WidgetsList.md @@ -34,7 +34,7 @@ no such checks will be performed. - It accepts the following parameter(s): - `$widget` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -47,7 +47,7 @@ Add multiple widget configs at once. See [addWidgetConfig()](/api-reference/Piwi - It accepts the following parameter(s): - `$widgets` ([`WidgetConfig[]`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -75,7 +75,7 @@ will not be recognized. eg 'Products' or 'Contents'. See WidgetContainerConfig::setId - `$widget` ([`WidgetConfig`](../../Piwik/Widget/WidgetConfig.md)) — -- It does not return anything. +- It does not return anything or a mixed result. @@ -90,7 +90,7 @@ Removes one or more widgets from the widget list. The widget category id. Can be a translation token eg 'General_Visits' see [WidgetConfig::setCategoryId()](/api-reference/Piwik/Widget/WidgetConfig#setcategoryid). - `$widgetName` (`string`|`false`) — The name of the widget to remove eg 'VisitTime_ByServerTimeWidgetName'. If not supplied, all widgets within that category will be removed. -- It does not return anything. +- It does not return anything or a mixed result.