Adding type hinting to API classes

27 files changed, 32 insertions, 1 deletions

diff --git a/plugins/API/API.php b/plugins/API/API.php
index a8e72b0c92..7f4017c238 100644
--- a/plugins/API/API.php
+++ b/plugins/API/API.php
@@ -45,6 +45,7 @@ require_once PIWIK_INCLUDE_PATH . '/core/Config.php';
  * More information on the <a href='http://piwik.org/docs/analytics-api/metadata/' target='_blank'>Metadata API documentation page</a>
  *
  * @package Piwik_API
+ * @method static \Piwik\Plugins\API\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php
index a37ae1fd94..0bd3aa66d6 100644
--- a/plugins/Actions/API.php
+++ b/plugins/Actions/API.php
@@ -37,6 +37,7 @@ use Piwik\Tracker\PageUrl;
  *
  * Note: pageName, pageUrl, outlinkUrl, downloadUrl parameters must be URL encoded before you call the API.
  * @package Actions
+ * @method static \Piwik\Plugins\Actions\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Annotations/API.php b/plugins/Annotations/API.php
index 2a1848ab85..fe2cdba8e1 100755
--- a/plugins/Annotations/API.php
+++ b/plugins/Annotations/API.php
@@ -28,6 +28,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/Annotations/AnnotationList.php';
  * annotations.
  *
  * @package Annotations
+ * @method static \Piwik\Plugins\Annotations\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/CoreAdminHome/API.php b/plugins/CoreAdminHome/API.php
index ab3ff062a8..0c1ccfc10a 100644
--- a/plugins/CoreAdminHome/API.php
+++ b/plugins/CoreAdminHome/API.php
@@ -26,6 +26,7 @@ use Piwik\TaskScheduler;
 
 /**
  * @package CoreAdminHome
+ * @method static \Piwik\Plugins\CoreAdminHome\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php
index 358cfceffd..85474ea7d8 100644
--- a/plugins/CustomVariables/API.php
+++ b/plugins/CustomVariables/API.php
@@ -21,6 +21,7 @@ use Piwik\Tracker\ActionSiteSearch;
  * The Custom Variables API lets you access reports for your <a href='http://piwik.org/docs/custom-variables/' target='_blank'>Custom Variables</a> names and values.
  *
  * @package CustomVariables
+ * @method static \Piwik\Plugins\CustomVariables\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/DBStats/API.php b/plugins/DBStats/API.php
index af71b4cf42..79169ac422 100644
--- a/plugins/DBStats/API.php
+++ b/plugins/DBStats/API.php
@@ -23,6 +23,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/DBStats/MySQLMetadataProvider.php';
  * DBStats API is used to request the overall status of the Mysql tables in use by Piwik.
  *
  * @package DBStats
+ * @method static \Piwik\Plugins\DBStats\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Dashboard/API.php b/plugins/Dashboard/API.php
index 1841775211..23577b970a 100644
--- a/plugins/Dashboard/API.php
+++ b/plugins/Dashboard/API.php
@@ -16,6 +16,7 @@ use Piwik\WidgetsList;
  * This API is the <a href='http://piwik.org/docs/analytics-api/reference/' target='_blank'>Dashboard API</a>: it gives information about dashboards.
  *
  * @package Piwik_API
+ * @method static \Piwik\Plugins\Dashboard\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/DevicesDetection/API.php b/plugins/DevicesDetection/API.php
index 0c466ef0b6..d205b6a6d3 100644
--- a/plugins/DevicesDetection/API.php
+++ b/plugins/DevicesDetection/API.php
@@ -18,6 +18,7 @@ use Piwik\Piwik;
 
 /**
  * The DevicesDetection API lets you access reports on your visitors devices, brands, models, Operating system, Browsers.
+ * @method static \Piwik\Plugins\DevicesDetection\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/ExampleAPI/API.php b/plugins/ExampleAPI/API.php
index 5d9809334b..3972fb82e2 100644
--- a/plugins/ExampleAPI/API.php
+++ b/plugins/ExampleAPI/API.php
@@ -20,6 +20,7 @@ use Piwik\Version;
  *
  * Please see the <a href='http://dev.piwik.org/trac/browser/trunk/plugins/ExampleAPI/API.php#L1' target='_blank'>source code in in the file plugins/ExampleAPI/API.php</a> for more documentation.
  * @package Piwik_ExampleAPI
+ * @method static \Piwik\Plugins\ExampleAPI\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/ExamplePlugin/API.php b/plugins/ExamplePlugin/API.php
index b1dde60f50..5f4eb4b14c 100644
--- a/plugins/ExamplePlugin/API.php
+++ b/plugins/ExamplePlugin/API.php
@@ -13,7 +13,8 @@ namespace Piwik\Plugins\ExamplePlugin;
 /**
  * API for plugin ExamplePlugin
  *
- * @package Piwik_ExamplePlugin
+ * @package ExamplePlugin
+ * @method static \Piwik\Plugins\ExamplePlugin\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/ExampleUI/API.php b/plugins/ExampleUI/API.php
index 67f1f1d79a..3927ce5b89 100644
--- a/plugins/ExampleUI/API.php
+++ b/plugins/ExampleUI/API.php
@@ -21,6 +21,7 @@ use Piwik\Period\Range;
  * display tables. See also the ExampleAPI plugin for an introduction to Piwik APIs.
  *
  * @package ExampleUI
+ * @method static \Piwik\Plugins\ExampleUI\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/ImageGraph/API.php b/plugins/ImageGraph/API.php
index 8f95ab8da0..f6e703ebd4 100644
--- a/plugins/ImageGraph/API.php
+++ b/plugins/ImageGraph/API.php
@@ -32,6 +32,7 @@ use Piwik\Translate;
  * See also <a href='http://piwik.org/docs/analytics-api/metadata/#toc-static-image-graphs'>How to embed static Image Graphs?</a> for more information.
  *
  * @package ImageGraph
+ * @method static \Piwik\Plugins\ImageGraph\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/LanguagesManager/API.php b/plugins/LanguagesManager/API.php
index 6309ff5a39..07cd97c0e8 100644
--- a/plugins/LanguagesManager/API.php
+++ b/plugins/LanguagesManager/API.php
@@ -27,6 +27,7 @@ use Piwik\Piwik;
  * or update it via "setLanguageForUser".
  *
  * @package LanguagesManager
+ * @method static \Piwik\Plugins\LanguagesManager\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Live/API.php b/plugins/Live/API.php
index 1ee1c6c2d6..0f13d1f33f 100644
--- a/plugins/Live/API.php
+++ b/plugins/Live/API.php
@@ -52,6 +52,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/Live/Visitor.php';
  *
  * See also the documentation about <a href='http://piwik.org/docs/real-time/' target='_blank'>Real time widget and visitor level reports</a> in Piwik.
  * @package Live
+ * @method static \Piwik\Plugins\Live\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/MobileMessaging/API.php b/plugins/MobileMessaging/API.php
index 0aa7e3b924..60ec6661a1 100644
--- a/plugins/MobileMessaging/API.php
+++ b/plugins/MobileMessaging/API.php
@@ -23,6 +23,7 @@ use Piwik\Plugins\ScheduledReports\API as APIScheduledReports;
  *  - check remaining credits
  *  - send SMS
  * @package MobileMessaging
+ * @method static \Piwik\Plugins\MobileMessaging\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php
index 96bd11a257..b7e70d6492 100755
--- a/plugins/MultiSites/API.php
+++ b/plugins/MultiSites/API.php
@@ -25,6 +25,7 @@ use Piwik\TaskScheduler;
 
 /**
  * The MultiSites API lets you request the key metrics (visits, page views, revenue) for all Websites in Piwik.
+ * @method static \Piwik\Plugins\MultiSites\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Overlay/API.php b/plugins/Overlay/API.php
index 7fe54d1484..05f27e7e2c 100644
--- a/plugins/Overlay/API.php
+++ b/plugins/Overlay/API.php
@@ -20,6 +20,11 @@ use Piwik\Plugins\SitesManager\SitesManager;
 use Piwik\Plugins\Transitions\API as APITransitions;
 use Piwik\Tracker\PageUrl;
 
+/**
+ * Class API
+ * @package Overlay
+ * @method static \Piwik\Plugins\Overlay\API getInstance()
+ */
 class API extends \Piwik\Plugin\API
 {
     /**
diff --git a/plugins/Provider/API.php b/plugins/Provider/API.php
index ae53d0f2f8..4b14c23018 100644
--- a/plugins/Provider/API.php
+++ b/plugins/Provider/API.php
@@ -23,6 +23,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/Provider/functions.php';
  * The Provider API lets you access reports for your visitors Internet Providers.
  *
  * @package Provider
+ * @method static \Piwik\Plugins\Provider\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/Referrers/API.php b/plugins/Referrers/API.php
index 910ca86488..bc32fbfb99 100644
--- a/plugins/Referrers/API.php
+++ b/plugins/Referrers/API.php
@@ -29,6 +29,7 @@ use Piwik\Piwik;
  * The methods "getKeywordsForPageUrl" and "getKeywordsForPageTitle" are used to output the top keywords used to find a page.
  * Check out the widget <a href='http://demo.piwik.org/index.php?module=Widgetize&action=iframe&moduleToWidgetize=Referrers&actionToWidgetize=getKeywordsForPage&idSite=7&period=day&date=2011-02-15&disableLink=1' target='_blank'>"Top keywords used to find this page"</a> that you can easily re-use on your website.
  * @package Referrers
+ * @method static \Piwik\Plugins\Referrers\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/SEO/API.php b/plugins/SEO/API.php
index 770f626c4c..47663427a2 100644
--- a/plugins/SEO/API.php
+++ b/plugins/SEO/API.php
@@ -24,6 +24,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/Referrers/functions.php';
  * Alexa Rank, age of the Domain name and count of DMOZ entries.
  *
  * @package SEO
+ * @method static \Piwik\Plugins\SEO\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/ScheduledReports/API.php b/plugins/ScheduledReports/API.php
index bafea9ad79..de854a715b 100644
--- a/plugins/ScheduledReports/API.php
+++ b/plugins/ScheduledReports/API.php
@@ -34,6 +34,7 @@ use Zend_Mime;
  * See also the documentation about <a href='http://piwik.org/docs/email-reports/' target='_blank'>Scheduled Email reports</a> in Piwik.
  *
  * @package ScheduledReports
+ * @method static \Piwik\Plugins\ScheduledReports\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/SegmentEditor/API.php b/plugins/SegmentEditor/API.php
index 4d98450f57..34994bfd59 100644
--- a/plugins/SegmentEditor/API.php
+++ b/plugins/SegmentEditor/API.php
@@ -21,6 +21,7 @@ use Piwik\Segment;
  * The SegmentEditor API lets you add, update, delete custom Segments, and list saved segments.a
  *
  * @package SegmentEditor
+ * @method static \Piwik\Plugins\SegmentEditor\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php
index ddd7edb231..f954f79ec9 100644
--- a/plugins/UserSettings/API.php
+++ b/plugins/UserSettings/API.php
@@ -25,6 +25,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/UserSettings/functions.php';
  * operating systems, plugins supported in their browser, Screen resolution and Screen types (normal, widescreen, dual screen or mobile).
  *
  * @package UserSettings
+ * @method static \Piwik\Plugins\UserSettings\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/VisitFrequency/API.php b/plugins/VisitFrequency/API.php
index ec30bd4a54..5b7786898d 100644
--- a/plugins/VisitFrequency/API.php
+++ b/plugins/VisitFrequency/API.php
@@ -18,6 +18,7 @@ use Piwik\SegmentExpression;
 /**
  * VisitFrequency API lets you access a list of metrics related to Returning Visitors.
  * @package VisitFrequency
+ * @method static \Piwik\Plugins\VisitFrequency\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php
index fe5c70bd05..6e6ac82d7e 100644
--- a/plugins/VisitTime/API.php
+++ b/plugins/VisitTime/API.php
@@ -25,6 +25,7 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/VisitTime/functions.php';
  * VisitTime API lets you access reports by Hour (Server time), and by Hour Local Time of your visitors.
  *
  * @package VisitTime
+ * @method static \Piwik\Plugins\VisitTime\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/VisitorInterest/API.php b/plugins/VisitorInterest/API.php
index 68b6c44715..65526bf57d 100644
--- a/plugins/VisitorInterest/API.php
+++ b/plugins/VisitorInterest/API.php
@@ -20,6 +20,7 @@ use Piwik\Piwik;
  * and number of visits per visit duration.
  *
  * @package VisitorInterest
+ * @method static \Piwik\Plugins\VisitorInterest\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php
index c0f32f39f1..fdac26480a 100644
--- a/plugins/VisitsSummary/API.php
+++ b/plugins/VisitsSummary/API.php
@@ -20,6 +20,7 @@ use Piwik\SettingsPiwik;
  * count of actions (page views & downloads & clicks on outlinks), time on site, bounces and converted visits.
  *
  * @package VisitsSummary
+ * @method static \Piwik\Plugins\VisitsSummary\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {