diff options
author | Jean Baptiste Noblot <noblot.jb@gmail.com> | 2020-03-04 19:36:20 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-04 19:36:20 +0300 |
commit | 16f25a0494f91a7660bdc0ba68d7b21882e7790e (patch) | |
tree | 7b0f3c76c0665f59d4f052003c00b78f60073877 /plugins | |
parent | ff2296329e5a702f1513c7c356d86dbf2965c706 (diff) |
Fix PHPDocs (#15663)
Diffstat (limited to 'plugins')
32 files changed, 30 insertions, 33 deletions
diff --git a/plugins/API/Renderer/Console.php b/plugins/API/Renderer/Console.php index d86907295e..bd4a24fbf4 100644 --- a/plugins/API/Renderer/Console.php +++ b/plugins/API/Renderer/Console.php @@ -16,7 +16,7 @@ class Console extends ApiRenderer /** * @param $message - * @param Exception|\Throwable $exception + * @param \Exception|\Throwable $exception * @return string */ public function renderException($message, $exception) diff --git a/plugins/API/Renderer/Html.php b/plugins/API/Renderer/Html.php index eb45b0cfda..289d89a65f 100644 --- a/plugins/API/Renderer/Html.php +++ b/plugins/API/Renderer/Html.php @@ -20,7 +20,7 @@ class Html extends ApiRenderer /** * @param $message - * @param Exception|\Throwable $exception + * @param \Exception|\Throwable $exception * @return string */ public function renderException($message, $exception) diff --git a/plugins/API/Renderer/Json.php b/plugins/API/Renderer/Json.php index d3c3a9ab42..d2baf4cdc2 100644 --- a/plugins/API/Renderer/Json.php +++ b/plugins/API/Renderer/Json.php @@ -31,7 +31,6 @@ class Json extends ApiRenderer /** * @param $message - * @param Exception|\Throwable $exception * @param \Exception|\Throwable $exception * @return string */ diff --git a/plugins/Actions/ArchivingHelper.php b/plugins/Actions/ArchivingHelper.php index e5c315d0b1..afd92e0171 100644 --- a/plugins/Actions/ArchivingHelper.php +++ b/plugins/Actions/ArchivingHelper.php @@ -542,7 +542,7 @@ class ArchivingHelper * * @param int $idAction * @param int $actionType - * @param \DataTable\Row + * @param \Piwik\DataTable\Row */ private static function setCachedActionRow($idAction, $actionType, $actionRow) { diff --git a/plugins/Annotations/Annotations.php b/plugins/Annotations/Annotations.php index 228761de2f..791a4939cd 100644 --- a/plugins/Annotations/Annotations.php +++ b/plugins/Annotations/Annotations.php @@ -16,7 +16,7 @@ namespace Piwik\Plugins\Annotations; class Annotations extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/BulkTracking/BulkTracking.php b/plugins/BulkTracking/BulkTracking.php index 89379e38f5..7cd3af44b8 100644 --- a/plugins/BulkTracking/BulkTracking.php +++ b/plugins/BulkTracking/BulkTracking.php @@ -19,7 +19,7 @@ class BulkTracking extends \Piwik\Plugin private $requests; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php b/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php index 38fd48fa24..28141fc3c5 100644 --- a/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php +++ b/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php @@ -56,7 +56,7 @@ class MultiRowEvolution extends RowEvolution /** * Render the popover * @param \Piwik\Plugins\CoreHome\Controller $controller - * @param View (the popover_rowevolution template) + * @param \Piwik\View (the popover_rowevolution template) */ public function renderPopover($controller, $view) { diff --git a/plugins/CoreHome/DataTableRowAction/RowEvolution.php b/plugins/CoreHome/DataTableRowAction/RowEvolution.php index 87f92694c9..bb73f9bb87 100644 --- a/plugins/CoreHome/DataTableRowAction/RowEvolution.php +++ b/plugins/CoreHome/DataTableRowAction/RowEvolution.php @@ -120,7 +120,7 @@ class RowEvolution /** * Render the popover * @param \Piwik\Plugins\CoreHome\Controller $controller - * @param View (the popover_rowevolution template) + * @param \Piwik\View (the popover_rowevolution template) */ public function renderPopover($controller, $view) { diff --git a/plugins/CoreUpdater/CoreUpdater.php b/plugins/CoreUpdater/CoreUpdater.php index 6d9696ac6a..f24bf25cd2 100644 --- a/plugins/CoreUpdater/CoreUpdater.php +++ b/plugins/CoreUpdater/CoreUpdater.php @@ -25,7 +25,7 @@ use Piwik\Version; class CoreUpdater extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/CoreVisualizations/Visualizations/Sparklines/Config.php b/plugins/CoreVisualizations/Visualizations/Sparklines/Config.php index e5fe3da1c0..dd59f2e8b3 100644 --- a/plugins/CoreVisualizations/Visualizations/Sparklines/Config.php +++ b/plugins/CoreVisualizations/Visualizations/Sparklines/Config.php @@ -140,7 +140,7 @@ class Config extends \Piwik\ViewDataTable\Config * It will show a sparkline image, the value of the resolved metric name and a descrption. Optionally, multiple * values can be shown after a sparkline image by passing multiple metric names * (eg array('nb_visits', 'nb_actions')). The data will be requested from the configured api method see - * {@link Piwik\ViewDataTable\RequestConfig::$apiMethodToRequestDataTable}. + * {@link \Piwik\ViewDataTable\RequestConfig::$apiMethodToRequestDataTable}. * * Example: * $config->addSparklineMetric('nb_visits'); diff --git a/plugins/DBStats/DBStats.php b/plugins/DBStats/DBStats.php index 47f83c0442..fab4ffab8d 100644 --- a/plugins/DBStats/DBStats.php +++ b/plugins/DBStats/DBStats.php @@ -18,7 +18,7 @@ class DBStats extends \Piwik\Plugin const TIME_OF_LAST_TASK_RUN_OPTION = 'dbstats_time_of_last_cache_task_run'; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Diagnostics/Diagnostics.php b/plugins/Diagnostics/Diagnostics.php index cdef33bb27..a4e366866c 100644 --- a/plugins/Diagnostics/Diagnostics.php +++ b/plugins/Diagnostics/Diagnostics.php @@ -20,7 +20,7 @@ class Diagnostics extends Plugin const NO_DATA_ARCHIVING_NOT_RUN_NOTIFICATION_ID = 'DiagnosticsNoDataArchivingNotRun'; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Events/Events.php b/plugins/Events/Events.php index b7e993cce7..aecab5a91f 100644 --- a/plugins/Events/Events.php +++ b/plugins/Events/Events.php @@ -19,7 +19,7 @@ use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable\AllColumns; class Events extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Feedback/Feedback.php b/plugins/Feedback/Feedback.php index 834cff1c02..f129597d64 100644 --- a/plugins/Feedback/Feedback.php +++ b/plugins/Feedback/Feedback.php @@ -23,7 +23,7 @@ class Feedback extends \Piwik\Plugin const NEVER_REMIND_ME_AGAIN = "-1"; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/GeoIp2/GeoIP2AutoUpdater.php b/plugins/GeoIp2/GeoIP2AutoUpdater.php index dcc79dfdbd..212a4bfaee 100644 --- a/plugins/GeoIp2/GeoIP2AutoUpdater.php +++ b/plugins/GeoIp2/GeoIP2AutoUpdater.php @@ -674,7 +674,7 @@ class GeoIP2AutoUpdater extends Task } /** - * See {@link Piwik\Scheduler\Schedule\Schedule::getRescheduledTime()}. + * See {@link \Piwik\Scheduler\Schedule\Schedule::getRescheduledTime()}. */ public function getRescheduledTime() { diff --git a/plugins/ImageGraph/ImageGraph.php b/plugins/ImageGraph/ImageGraph.php index a9be03e3a5..9cc273906d 100644 --- a/plugins/ImageGraph/ImageGraph.php +++ b/plugins/ImageGraph/ImageGraph.php @@ -32,7 +32,7 @@ class ImageGraph extends \Piwik\Plugin ); /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Insights/Insights.php b/plugins/Insights/Insights.php index 041ddee030..d928a90793 100644 --- a/plugins/Insights/Insights.php +++ b/plugins/Insights/Insights.php @@ -13,7 +13,7 @@ namespace Piwik\Plugins\Insights; class Insights extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Installation/Installation.php b/plugins/Installation/Installation.php index a889d81037..5f9ab44505 100644 --- a/plugins/Installation/Installation.php +++ b/plugins/Installation/Installation.php @@ -26,7 +26,7 @@ class Installation extends \Piwik\Plugin protected $installationControllerName = '\\Piwik\\Plugins\\Installation\\Controller'; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/LanguagesManager/LanguagesManager.php b/plugins/LanguagesManager/LanguagesManager.php index d38176377b..79a90b139c 100644 --- a/plugins/LanguagesManager/LanguagesManager.php +++ b/plugins/LanguagesManager/LanguagesManager.php @@ -27,7 +27,7 @@ use Piwik\View; class LanguagesManager extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Live/VisitorFactory.php b/plugins/Live/VisitorFactory.php index a500013a63..2ebada941a 100644 --- a/plugins/Live/VisitorFactory.php +++ b/plugins/Live/VisitorFactory.php @@ -29,7 +29,7 @@ class VisitorFactory /** * Triggered while visit is filtering in live plugin. Subscribers to this * event can force the use of a custom visitor object that extends from - * {@link Piwik\Plugins\Live\VisitorInterface}. + * {@link \Piwik\Plugins\Live\VisitorInterface}. * * @param \Piwik\Plugins\Live\VisitorInterface &$visitor Initialized to null, but can be set to * a new visitor object. If it isn't modified diff --git a/plugins/Login/Controller.php b/plugins/Login/Controller.php index b5ce90908e..8704b3c1ac 100644 --- a/plugins/Login/Controller.php +++ b/plugins/Login/Controller.php @@ -108,7 +108,6 @@ class Controller extends \Piwik\Plugin\ControllerAdmin /** * Default action * - * @param none * @return string */ function index() @@ -472,7 +471,6 @@ class Controller extends \Piwik\Plugin\ControllerAdmin /** * Logout current user * - * @param none * @return void */ public function logout() diff --git a/plugins/MobileMessaging/MobileMessaging.php b/plugins/MobileMessaging/MobileMessaging.php index 4223db5028..05e1e3a425 100644 --- a/plugins/MobileMessaging/MobileMessaging.php +++ b/plugins/MobileMessaging/MobileMessaging.php @@ -61,7 +61,7 @@ class MobileMessaging extends \Piwik\Plugin ); /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index 8caa71d0c6..fc4a5e34ae 100644 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -161,7 +161,7 @@ class API extends \Piwik\Plugin\API /** * Same as getAll but for a unique Matomo site - * @see Piwik\Plugins\MultiSites\API::getAll() + * @see \Piwik\Plugins\MultiSites\API::getAll() * * @param int $idSite Id of the Matomo site * @param string $period The period type to get data for. diff --git a/plugins/MultiSites/MultiSites.php b/plugins/MultiSites/MultiSites.php index c4fbd355f9..f23379bb2d 100644 --- a/plugins/MultiSites/MultiSites.php +++ b/plugins/MultiSites/MultiSites.php @@ -13,7 +13,7 @@ use Piwik\Piwik; class MultiSites extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Overlay/Overlay.php b/plugins/Overlay/Overlay.php index 58d2f01349..4706be5ab9 100644 --- a/plugins/Overlay/Overlay.php +++ b/plugins/Overlay/Overlay.php @@ -12,7 +12,7 @@ namespace Piwik\Plugins\Overlay; class Overlay extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ function registerEvents() { diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index 2d57805a1b..2586468eca 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -170,7 +170,7 @@ class PrivacyManager extends Plugin } /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/ScheduledReports/API.php b/plugins/ScheduledReports/API.php index bbc800fd20..4288a28f49 100644 --- a/plugins/ScheduledReports/API.php +++ b/plugins/ScheduledReports/API.php @@ -503,7 +503,7 @@ class API extends \Piwik\Plugin\API * handle their new report formats. * * @param ReportRenderer &$reportRenderer This variable should be set to an instance that - * extends {@link Piwik\ReportRenderer} by one of the event + * extends {@link \Piwik\ReportRenderer} by one of the event * subscribers. * @param string $reportType A string ID describing how the report is sent, eg, * `'sms'` or `'email'`. diff --git a/plugins/SegmentEditor/SegmentEditor.php b/plugins/SegmentEditor/SegmentEditor.php index b60861427b..aac0e481f8 100644 --- a/plugins/SegmentEditor/SegmentEditor.php +++ b/plugins/SegmentEditor/SegmentEditor.php @@ -36,7 +36,7 @@ class SegmentEditor extends \Piwik\Plugin const NO_DATA_UNPROCESSED_SEGMENT_ID = 'nodata_segment_not_processed'; /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index b88e5313a9..5e629bf39a 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -19,7 +19,7 @@ use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2; class UserCountry extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php index 9e64e5a08d..7a85832e9d 100644 --- a/plugins/VisitFrequency/VisitFrequency.php +++ b/plugins/VisitFrequency/VisitFrequency.php @@ -14,7 +14,7 @@ use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable; class VisitFrequency extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/VisitsSummary/VisitsSummary.php b/plugins/VisitsSummary/VisitsSummary.php index 466808c173..72365412bc 100644 --- a/plugins/VisitsSummary/VisitsSummary.php +++ b/plugins/VisitsSummary/VisitsSummary.php @@ -21,7 +21,7 @@ use Piwik\Plugins\VisitsSummary\Reports\Get; class VisitsSummary extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { diff --git a/plugins/Widgetize/Widgetize.php b/plugins/Widgetize/Widgetize.php index ce09c2e599..9d9c083b71 100644 --- a/plugins/Widgetize/Widgetize.php +++ b/plugins/Widgetize/Widgetize.php @@ -13,7 +13,7 @@ namespace Piwik\Plugins\Widgetize; class Widgetize extends \Piwik\Plugin { /** - * @see Piwik\Plugin::registerEvents + * @see \Piwik\Plugin::registerEvents */ public function registerEvents() { |