updated plugins API documentation

Author: Piwik Docs

docs/3.x/generated/Classes.md

@@ -23,7 +23,6 @@ This is a complete list of available classes:
 - [`Columns\Updater`](Piwik/Columns/Updater.md) — Class that handles dimension updates
 - [`Common`](Piwik/Common.md) — Contains helper methods used by both Piwik Core and the Piwik Tracking engine.
 - [`Config`](Piwik/Config.md) — Singleton that provides read & write access to Piwik's INI configuration.
-- [`Console`](Piwik/Console.md)
 - [`DataAccess\LogAggregator`](Piwik/DataAccess/LogAggregator.md) — Contains methods that calculate metrics by aggregating log data (visits, actions, conversions, ecommerce items).
 - [`DataTable`](Piwik/DataTable.md) — The primary data structure used to store analytics data in Piwik.
 - [`DataTable\BaseFilter`](Piwik/DataTable/BaseFilter.md) — A filter is set of logic that manipulates a DataTable.
@@ -159,6 +158,7 @@ This is a complete list of available classes:
 - [`Plugins\Live\Visitor`](Piwik/Plugins/Live/Visitor.md)
 - [`Plugins\Live\VisitorDetailsAbstract`](Piwik/Plugins/Live/VisitorDetailsAbstract.md) — Class VisitorDetailsAbstract
 - [`Plugins\Live\Visualizations\VisitorLog\Config`](Piwik/Plugins/Live/Visualizations/VisitorLog/Config.md) — DataTable Visualization that derives from HtmlTable and sets show_extra_columns to true.
+- [`Plugins\Login\SessionInitializer`](Piwik/Plugins/Login/SessionInitializer.md) — This SessionInitializer is no longer used, but is kept for backwards compatibility.
 - [`Plugins\MobileMessaging\SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md) — The SMSProvider abstract class is used as a base class for SMS provider implementations.
 - [`Plugins\MultiSites\Columns\Metrics\EcommerceOnlyEvolutionMetric`](Piwik/Plugins/MultiSites/Columns/Metrics/EcommerceOnlyEvolutionMetric.md) — Ecommerce evolution metric adapter.
 - [`Plugins\Tour\Engagement\Challenge`](Piwik/Plugins/Tour/Engagement/Challenge.md) — Defines a new challenge which a super user needs to complete in order to become a "Matomo expert".

docs/3.x/generated/Classnames.md

@@ -19,7 +19,6 @@
 ## Columns\Updater
 ## Common
 ## Config
-## Console
 ## DataAccess\LogAggregator
 ## DataTable
 ## DataTable\BaseFilter
@@ -155,6 +154,7 @@
 ## Plugins\Live\Visitor
 ## Plugins\Live\VisitorDetailsAbstract
 ## Plugins\Live\Visualizations\VisitorLog\Config
+## Plugins\Login\SessionInitializer
 ## Plugins\MobileMessaging\SMSProvider
 ## Plugins\MultiSites\Columns\Metrics\EcommerceOnlyEvolutionMetric
 ## Plugins\Tour\Engagement\Challenge

docs/3.x/generated/Hooks.md

@@ -103,7 +103,7 @@ Index
 - [`createCustomMetric()`](Piwik/Columns/DimensionMetricFactory.md#createcustommetric) — *Method in class* [`DimensionMetricFactory`](Piwik/Columns/DimensionMetricFactory.md)
 - [`createComputedMetric()`](Piwik/Columns/DimensionMetricFactory.md#createcomputedmetric) — *Method in class* [`DimensionMetricFactory`](Piwik/Columns/DimensionMetricFactory.md)
 - [`createMetric()`](Piwik/Columns/DimensionMetricFactory.md#createmetric) — *Method in class* [`DimensionMetricFactory`](Piwik/Columns/DimensionMetricFactory.md)
-- [`Common`](Piwik/Common.md) — *Class in namespace* `Piwik`- [`Config`](Piwik/Config.md) — *Class in namespace* `Piwik`- [`Console`](Piwik/Console.md) — *Class in namespace* `Piwik`- [`clearQueuedFilters()`](Piwik/DataTable.md#clearqueuedfilters) — *Method in class* [`DataTable`](Piwik/DataTable.md)
+- [`Common`](Piwik/Common.md) — *Class in namespace* `Piwik`- [`Config`](Piwik/Config.md) — *Class in namespace* `Piwik`- [`clearQueuedFilters()`](Piwik/DataTable.md#clearqueuedfilters) — *Method in class* [`DataTable`](Piwik/DataTable.md)
 - [`CalculateEvolutionFilter`](Piwik/DataTable/Filter/CalculateEvolutionFilter.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`calculate()`](Piwik/DataTable/Filter/CalculateEvolutionFilter.md#calculate) — *Method in class* [`CalculateEvolutionFilter`](Piwik/DataTable/Filter/CalculateEvolutionFilter.md)
 - [`ColumnCallbackAddColumn`](Piwik/DataTable/Filter/ColumnCallbackAddColumn.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackAddColumnPercentage`](Piwik/DataTable/Filter/ColumnCallbackAddColumnPercentage.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackAddColumnQuotient`](Piwik/DataTable/Filter/ColumnCallbackAddColumnQuotient.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackAddMetadata`](Piwik/DataTable/Filter/ColumnCallbackAddMetadata.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackDeleteMetadata`](Piwik/DataTable/Filter/ColumnCallbackDeleteMetadata.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackDeleteRow`](Piwik/DataTable/Filter/ColumnCallbackDeleteRow.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnCallbackReplace`](Piwik/DataTable/Filter/ColumnCallbackReplace.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`ColumnDelete`](Piwik/DataTable/Filter/ColumnDelete.md) — *Class in namespace* `Piwik\DataTable\Filter`- [`compareWeek()`](Piwik/Date.md#compareweek) — *Method in class* [`Date`](Piwik/Date.md)
 - [`compareMonth()`](Piwik/Date.md#comparemonth) — *Method in class* [`Date`](Piwik/Date.md)
@@ -556,6 +556,8 @@ Index
 - [`getAllReports()`](Piwik/Plugin/ReportsProvider.md#getallreports) — *Method in class* [`ReportsProvider`](Piwik/Plugin/ReportsProvider.md)
 - [`getAllReportClasses()`](Piwik/Plugin/ReportsProvider.md#getallreportclasses) — *Method in class* [`ReportsProvider`](Piwik/Plugin/ReportsProvider.md)
 - [`getSegment()`](Piwik/Plugin/Segment.md#getsegment) — *Method in class* [`Segment`](Piwik/Plugin/Segment.md)
+- [`getMeasurableSettings()`](Piwik/Plugin/SettingsProvider.md#getmeasurablesettings) — *Method in class* [`SettingsProvider`](Piwik/Plugin/SettingsProvider.md)
+- [`getAllMeasurableSettings()`](Piwik/Plugin/SettingsProvider.md#getallmeasurablesettings) — *Method in class* [`SettingsProvider`](Piwik/Plugin/SettingsProvider.md)
 - [`getDefaultConfig()`](Piwik/Plugin/ViewDataTable.md#getdefaultconfig) — *Method in class* [`ViewDataTable`](Piwik/Plugin/ViewDataTable.md)
 - [`getDefaultRequestConfig()`](Piwik/Plugin/ViewDataTable.md#getdefaultrequestconfig) — *Method in class* [`ViewDataTable`](Piwik/Plugin/ViewDataTable.md)
 - [`getViewDataTableId()`](Piwik/Plugin/ViewDataTable.md#getviewdatatableid) — *Method in class* [`ViewDataTable`](Piwik/Plugin/ViewDataTable.md)
@@ -598,6 +600,7 @@ Index
 - [`getOrder()`](Piwik/Plugins/Live/ProfileSummary/Summary.md#getorder) — *Method in class* [`Summary`](Piwik/Plugins/Live/ProfileSummary/Summary.md)
 - [`getAllVisitorDetailsClasses()`](Piwik/Plugins/Live/Visitor.md#getallvisitordetailsclasses) — *Method in class* [`Visitor`](Piwik/Plugins/Live/Visitor.md)
 - [`getDb()`](Piwik/Plugins/Live/VisitorDetailsAbstract.md#getdb) — *Method in class* [`VisitorDetailsAbstract`](Piwik/Plugins/Live/VisitorDetailsAbstract.md)
+- [`getHashTokenAuth()`](Piwik/Plugins/Login/SessionInitializer.md#gethashtokenauth) — *Method in class* [`SessionInitializer`](Piwik/Plugins/Login/SessionInitializer.md)
 - [`getId()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#getid) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
 - [`getDescription()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#getdescription) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
 - [`getCreditLeft()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#getcreditleft) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
@@ -794,6 +797,7 @@ Index
 - [`isComparing()`](Piwik/Plugin/ViewDataTable.md#iscomparing) — *Method in class* [`ViewDataTable`](Piwik/Plugin/ViewDataTable.md)
 - [`isThereDataToDisplay()`](Piwik/Plugin/Visualization.md#istheredatatodisplay) — *Method in class* [`Visualization`](Piwik/Plugin/Visualization.md)
 - [`InteractionRate`](Piwik/Plugins/Contents/Columns/Metrics/InteractionRate.md) — *Class in namespace* `Piwik\Plugins\Contents\Columns\Metrics`- [`Item`](Piwik/Plugins/CoreHome/SystemSummary/Item.md) — *Class in namespace* `Piwik\Plugins\CoreHome\SystemSummary`- [`ItemsCount`](Piwik/Plugins/Goals/Columns/Metrics/GoalSpecific/ItemsCount.md) — *Class in namespace* `Piwik\Plugins\Goals\Columns\Metrics\GoalSpecific`- [`ImportantVisits`](Piwik/Plugins/Live/ProfileSummary/ImportantVisits.md) — *Class in namespace* `Piwik\Plugins\Live\ProfileSummary`- [`initProfile()`](Piwik/Plugins/Live/VisitorDetailsAbstract.md#initprofile) — *Method in class* [`VisitorDetailsAbstract`](Piwik/Plugins/Live/VisitorDetailsAbstract.md)
+- [`initSession()`](Piwik/Plugins/Login/SessionInitializer.md#initsession) — *Method in class* [`SessionInitializer`](Piwik/Plugins/Login/SessionInitializer.md)
 - [`isAvailable()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#isavailable) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
 - [`isCompleted()`](Piwik/Plugins/Tour/Engagement/Challenge.md#iscompleted) — *Method in class* [`Challenge`](Piwik/Plugins/Tour/Engagement/Challenge.md)
 - [`isRegistered()`](Piwik/Registry.md#isregistered) — *Method in class* [`Registry`](Piwik/Registry.md)
@@ -1079,7 +1083,7 @@ Index
 - [`setLongErrorMessage()`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md#setlongerrormessage) — *Method in class* [`DiagnosticResult`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md)
 - [`setProfile()`](Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md#setprofile) — *Method in class* [`ProfileSummaryAbstract`](Piwik/Plugins/Live/ProfileSummary/ProfileSummaryAbstract.md)
 - [`Summary`](Piwik/Plugins/Live/ProfileSummary/Summary.md) — *Class in namespace* `Piwik\Plugins\Live\ProfileSummary`- [`setDetails()`](Piwik/Plugins/Live/VisitorDetailsAbstract.md#setdetails) — *Method in class* [`VisitorDetailsAbstract`](Piwik/Plugins/Live/VisitorDetailsAbstract.md)
-- [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md) — *Class in namespace* `Piwik\Plugins\MobileMessaging`- [`sendSMS()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#sendsms) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
+- [`SessionInitializer`](Piwik/Plugins/Login/SessionInitializer.md) — *Class in namespace* `Piwik\Plugins\Login`- [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md) — *Class in namespace* `Piwik\Plugins\MobileMessaging`- [`sendSMS()`](Piwik/Plugins/MobileMessaging/SMSProvider.md#sendsms) — *Method in class* [`SMSProvider`](Piwik/Plugins/MobileMessaging/SMSProvider.md)
 - [`setCompleted()`](Piwik/Plugins/Tour/Engagement/Challenge.md#setcompleted) — *Method in class* [`Challenge`](Piwik/Plugins/Tour/Engagement/Challenge.md)
 - [`setLimit()`](Piwik/RankingQuery.md#setlimit) — *Method in class* [`RankingQuery`](Piwik/RankingQuery.md)
 - [`setOthersLabel()`](Piwik/RankingQuery.md#setotherslabel) — *Method in class* [`RankingQuery`](Piwik/RankingQuery.md)
@@ -1290,6 +1294,7 @@ Index
 - [`__construct()`](Piwik/Plugins/Diagnostics/DiagnosticService.md#__construct) — *Method in class* [`DiagnosticService`](Piwik/Plugins/Diagnostics/DiagnosticService.md)
 - [`__construct()`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md#__construct) — *Method in class* [`DiagnosticResult`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResult.md)
 - [`__construct()`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResultItem.md#__construct) — *Method in class* [`DiagnosticResultItem`](Piwik/Plugins/Diagnostics/Diagnostic/DiagnosticResultItem.md)
+- [`__construct()`](Piwik/Plugins/Login/SessionInitializer.md#__construct) — *Method in class* [`SessionInitializer`](Piwik/Plugins/Login/SessionInitializer.md)
 - [`__construct()`](Piwik/RankingQuery.md#__construct) — *Method in class* [`RankingQuery`](Piwik/RankingQuery.md)
 - [`__construct()`](Piwik/Report/ReportWidgetFactory.md#__construct) — *Method in class* [`ReportWidgetFactory`](Piwik/Report/ReportWidgetFactory.md)
 - [`__construct()`](Piwik/Scheduler/Task.md#__construct) — *Method in class* [`Task`](Piwik/Scheduler/Task.md)

docs/3.x/generated/Index.md

@@ -67,6 +67,7 @@ This is a complete list of available namespaces:
 - [`Piwik\Plugins\Live\ProfileSummary`](Piwik/Plugins/Live/ProfileSummary)
 - [`Piwik\Plugins\Live\Visualizations`](Piwik/Plugins/Live/Visualizations)
 - [`Piwik\Plugins\Live\Visualizations\VisitorLog`](Piwik/Plugins/Live/Visualizations/VisitorLog)
+- [`Piwik\Plugins\Login`](Piwik/Plugins/Login)
 - [`Piwik\Plugins\MobileMessaging`](Piwik/Plugins/MobileMessaging)
 - [`Piwik\Plugins\MultiSites`](Piwik/Plugins/MultiSites)
 - [`Piwik\Plugins\MultiSites\Columns`](Piwik/Plugins/MultiSites/Columns)

docs/3.x/generated/Namespaces.md

@@ -70,9 +70,8 @@ The class defines the following methods:
 <a name="getRequestArrayFromString" id="getRequestArrayFromString"></a>
 ### `getRequestArrayFromString()`
 
-Converts the supplied request string into an array of query paramater name/value mappings.
-
-The current query parameters (everything in `$_GET` and `$_POST`) are
+Converts the supplied request string into an array of query paramater name/value
+mappings. The current query parameters (everything in `$_GET` and `$_POST`) are
 forwarded to request array before it is returned.
 
 #### Signature
@@ -102,7 +101,8 @@ Constructor.
 <a name="process" id="process"></a>
 ### `process()`
 
-Dispatches the API request to the appropriate API method and returns the result after post-processing.
+Dispatches the API request to the appropriate API method and returns the result
+after post-processing.
 
 Post-processing includes:
 
@@ -123,8 +123,10 @@ object.
 - *Returns:*  [`DataTable`](../../Piwik/DataTable.md)|`Piwik\API\Map`|`string` &mdash;
     The data resulting from the API call.
 - It throws one of the following exceptions:
-    - `PluginDeactivatedException` &mdash; if the module plugin is not activated.
-    - [`Exception`](http://php.net/class.Exception) &mdash; if the requested API method cannot be called, if required parameters for the API method are missing or if the API method throws an exception and the **format** query parameter is **original**.
+    - `Piwik\Exception\PluginDeactivatedException` &mdash; if the module plugin is not activated.
+    - [`Exception`](http://php.net/class.Exception) &mdash; if the requested API method cannot be called, if required parameters for the
+                  API method are missing or if the API method throws an exception and the **format**
+                  query parameter is **original**.
 
 <a name="getclassnameapi" id="getclassnameapi"></a>
 <a name="getClassNameAPI" id="getClassNameAPI"></a>
@@ -145,9 +147,7 @@ Returns the name of a plugin's API class by plugin name.
 <a name="isRootRequestApiRequest" id="isRootRequestApiRequest"></a>
 ### `isRootRequestApiRequest()`
 
-Detect if the root request (the actual request) is an API request or not.
-
-To detect whether an API is currently
+Detect if the root request (the actual request) is an API request or not. To detect whether an API is currently
 request within any request, have a look at [isApiRequest()](/api-reference/Piwik/API/Request#isapirequest).
 
 #### Signature
@@ -175,9 +175,7 @@ can be called programmatically. These requests are considered "child" API reques
 <a name="isApiRequest" id="isApiRequest"></a>
 ### `isApiRequest()`
 
-Detect if request is an API request.
-
-Meaning the module is 'API' and an API method having a valid format was
+Detect if request is an API request. Meaning the module is 'API' and an API method having a valid format was
 specified. Note that this method will return true even if the actual request is for example a regular UI
 reporting page request but within this request we are currently processing an API request (eg a
 controller calls Request::processRequest('API.getMatomoVersion')). To find out if the root request is an API
@@ -213,7 +211,8 @@ Returns the current API method being executed, if the current request is an API
 <a name="processRequest" id="processRequest"></a>
 ### `processRequest()`
 
-Helper method that processes an API request in one line using the variables in `$_GET` and `$_POST`.
+Helper method that processes an API request in one line using the variables in `$_GET`
+and `$_POST`.
 
 #### Signature
 
@@ -232,9 +231,8 @@ Helper method that processes an API request in one line using the variables in `
 <a name="getRequestParametersGET" id="getRequestParametersGET"></a>
 ### `getRequestParametersGET()`
 
-Returns the original request parameters in the current query string as an array mapping query parameter names with values.
-
-The result of this function will not be affected
+Returns the original request parameters in the current query string as an array mapping
+query parameter names with values. The result of this function will not be affected
 by any modifications to `$_GET` and will not include parameters in `$_POST`.
 
 #### Signature

docs/3.x/generated/Piwik/API/Request.md

@@ -33,9 +33,8 @@ The class defines the following methods:
 <a name="doAsSuperUser" id="doAsSuperUser"></a>
 ### `doAsSuperUser()`
 
-Executes a callback with superuser privileges, making sure those privileges are rescinded before this method exits.
-
-Privileges will be rescinded even if an exception is thrown.
+Executes a callback with superuser privileges, making sure those privileges are rescinded
+before this method exits. Privileges will be rescinded even if an exception is thrown.
 
 #### Signature