updated plugins API documentation

matomo-org · Jun 17, 2020 · 6289c94 · 6289c94
1 parent 6af3dcd
commit 6289c94
Show file tree

Hide file tree

Showing 259 changed files with 1,235 additions and 1,235 deletions.
diff --git 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`) &mdash;
        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.
 
 <a name="insertnumericrecord" id="insertnumericrecord"></a>
 <a name="insertNumericRecord" id="insertNumericRecord"></a>
@@ -187,7 +187,7 @@ Numeric values are not inserted if they equal `0`.
        The name of the numeric value, eg, `'Referrers_distinctKeywords'`.
     - `$value` (`float`) &mdash;
        The numeric value.
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="insertblobrecord" id="insertblobrecord"></a>
 <a name="insertBlobRecord" id="insertBlobRecord"></a>
@@ -203,5 +203,5 @@ and segment.
        The name of the record, eg, 'Referrers_type'.
     - `$values` (`string`|`array`) &mdash;
        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
@@ -71,7 +71,7 @@ Sets the authentication token to authenticate with.
 -  It accepts the following parameter(s):
     - `$token_auth` (`string`) &mdash;
        authentication token
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="getlogin" id="getlogin"></a>
 <a name="getLogin" id="getLogin"></a>
@@ -110,7 +110,7 @@ Sets the login name to authenticate with.
 -  It accepts the following parameter(s):
     - `$login` (`string`) &mdash;
        The username.
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="setpassword" id="setpassword"></a>
 <a name="setPassword" id="setPassword"></a>
@@ -123,7 +123,7 @@ Sets the password to authenticate with.
 -  It accepts the following parameter(s):
     - `$password` (`string`) &mdash;
        Password (not hashed).
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="setpasswordhash" id="setpasswordhash"></a>
 <a name="setPasswordHash" id="setPasswordHash"></a>
@@ -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`) &mdash;
        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) &mdash; 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
@@ -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.
 
 <a name="settype" id="settype"></a>
 <a name="setType" id="setType"></a>
@@ -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.
 
 <a name="groupvalue" id="groupvalue"></a>
 <a name="groupValue" id="groupValue"></a>
@@ -419,7 +419,7 @@ For certain dimension types, some metrics will be added automatically.
 
     - `$dimensionMetricFactory` ([`DimensionMetricFactory`](../../Piwik/Columns/DimensionMetricFactory.md)) &mdash;
 
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="addsegment" id="addsegment"></a>
 <a name="addSegment" id="addSegment"></a>
@@ -437,7 +437,7 @@ already.
 -  It accepts the following parameter(s):
     - `$segment` ([`Segment`](../../Piwik/Plugin/Segment.md)) &mdash;
 
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="getsegmentname" id="getsegmentname"></a>
 <a name="getSegmentName" id="getSegmentName"></a>
@@ -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)) &mdash;
 
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="factory" id="factory"></a>
 <a name="factory" id="factory"></a>

diff --git 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.
 
 <a name="gettable" id="gettable"></a>
 <a name="getTable" id="getTable"></a>

diff --git 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)) &mdash;
 
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="getmetrics" id="getmetrics"></a>
 <a name="getMetrics" id="getMetrics"></a>
@@ -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`) &mdash;
        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.
 
 <a name="getmetric" id="getmetric"></a>
 <a name="getMetric" id="getMetric"></a>

diff --git 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)) &mdash;
 
-- 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
@@ -296,5 +296,5 @@ For more information: [https://github.com/piwik/piwik/issues/374](https://github
 -  It accepts the following parameter(s):
     - `$var` (`mixed`) &mdash;
        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
@@ -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.
 
 <a name="getfromcommonconfig" id="getfromcommonconfig"></a>
 <a name="getFromCommonConfig" id="getFromCommonConfig"></a>
@@ -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.
 
 <a name="getfromlocalconfig" id="getfromlocalconfig"></a>
 <a name="getFromLocalConfig" id="getFromLocalConfig"></a>
@@ -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.
 
 <a name="__set" id="__set"></a>
 <a name="__set" id="__set"></a>
@@ -103,7 +103,7 @@ Sets a configuration value or section.
        This section name or value name to set.
     - `$value` (`mixed`) &mdash;
 
-- It does not return anything.
+- It does not return anything or a mixed result.
 
 <a name="forcesave" id="forcesave"></a>
 <a name="forceSave" id="forceSave"></a>
@@ -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.