Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsgiehl <stefangiehl@gmail.com>2012-05-03 02:08:23 +0400
committersgiehl <stefangiehl@gmail.com>2012-05-03 02:08:23 +0400
commit0e64dd6c7cdfa5c10a71e2c354cc545b2c592c81 (patch)
tree3c0d8708a7e5cb3287ab17394d107543eeb819d3
parent9f5147e17b2f728e1071b2e7f18dd386e92f70a5 (diff)
added/fixed several doc blocks; fixed some css
git-svn-id: http://dev.piwik.org/svn/trunk@6243 59fd770c-687e-43c8-a1e3-f5a4ff64c105
-rw-r--r--core/Plugin.php2
-rw-r--r--core/TaskScheduler.php4
-rw-r--r--plugins/API/API.php39
-rw-r--r--plugins/API/css/styles.css14
-rw-r--r--plugins/Actions/API.php18
-rw-r--r--plugins/Actions/Actions.php45
-rw-r--r--plugins/Actions/Controller.php22
-rw-r--r--plugins/AnonymizeIP/AnonymizeIP.php5
-rw-r--r--plugins/CoreAdminHome/API.php5
-rw-r--r--plugins/CoreAdminHome/CoreAdminHome.php15
-rw-r--r--plugins/CoreAdminHome/templates/styles.css5
-rw-r--r--plugins/CoreHome/CoreHome.php6
-rw-r--r--plugins/CoreHome/DataTableRowAction/RowEvolution.php15
-rw-r--r--plugins/CoreHome/templates/html_report_body.tpl4
-rw-r--r--plugins/CoreHome/templates/jquery.ui.autocomplete.css1
-rw-r--r--plugins/CoreUpdater/templates/update_welcome.tpl1
-rw-r--r--plugins/CustomVariables/CustomVariables.php16
-rw-r--r--plugins/Dashboard/Dashboard.php13
-rw-r--r--plugins/Dashboard/templates/dashboard.css2
-rw-r--r--plugins/DoNotTrack/DoNotTrack.php3
-rw-r--r--plugins/ExampleFeedburner/ExampleFeedburner.php7
-rw-r--r--plugins/ExampleFeedburner/templates/feedburner.tpl2
-rw-r--r--plugins/ExamplePlugin/ExamplePlugin.php5
-rw-r--r--plugins/ExampleRssWidget/ExampleRssWidget.php3
-rw-r--r--plugins/ExampleRssWidget/templates/styles.css15
-rw-r--r--plugins/Feedback/Controller.php1
-rw-r--r--plugins/Feedback/Feedback.php6
-rw-r--r--plugins/Feedback/templates/styles.css2
-rw-r--r--plugins/Goals/API.php30
-rw-r--r--plugins/Goals/Goals.php28
-rw-r--r--plugins/ImageGraph/ImageGraph.php6
-rw-r--r--plugins/Installation/Controller.php1
-rw-r--r--plugins/Installation/Installation.php3
-rw-r--r--plugins/Installation/templates/install.css7
-rw-r--r--plugins/LanguagesManager/API.php5
-rw-r--r--plugins/LanguagesManager/LanguagesManager.php17
-rw-r--r--plugins/Live/API.php30
-rw-r--r--plugins/Live/Live.php10
-rw-r--r--plugins/Login/Controller.php3
-rw-r--r--plugins/Login/Login.php11
-rwxr-xr-xplugins/MultiSites/API.php7
-rw-r--r--plugins/MultiSites/MultiSites.php11
-rw-r--r--plugins/PDFReports/API.php21
-rw-r--r--plugins/PDFReports/PDFReports.php17
-rwxr-xr-xplugins/PrivacyManager/LogDataPurger.php9
-rw-r--r--plugins/PrivacyManager/PrivacyManager.php7
-rwxr-xr-xplugins/PrivacyManager/ReportsPurger.php5
-rwxr-xr-xplugins/PrivacyManager/tests/PrivacyManager.test.php2
-rw-r--r--plugins/Provider/Controller.php4
-rw-r--r--plugins/Provider/Provider.php22
-rw-r--r--plugins/Proxy/Controller.php1
-rw-r--r--plugins/Referers/Referers.php17
-rw-r--r--plugins/Referers/functions.php4
-rw-r--r--plugins/SitesManager/API.php57
-rw-r--r--plugins/SitesManager/SitesManager.php6
-rw-r--r--plugins/SitesManager/templates/SitesManager.tpl4
-rw-r--r--plugins/UserCountry/UserCountry.php18
-rw-r--r--plugins/UserCountryMap/templates/worldmap.tpl2
-rw-r--r--plugins/UserSettings/UserSettings.php8
-rw-r--r--plugins/UsersManager/API.php52
-rw-r--r--plugins/UsersManager/Controller.php3
-rw-r--r--plugins/UsersManager/UsersManager.php8
-rw-r--r--plugins/UsersManager/templates/UsersManager.tpl1
-rw-r--r--plugins/VisitFrequency/VisitFrequency.php15
-rw-r--r--plugins/VisitTime/VisitTime.php23
-rw-r--r--plugins/VisitorInterest/VisitorInterest.php23
-rw-r--r--plugins/VisitsSummary/VisitsSummary.php5
-rw-r--r--plugins/Widgetize/Widgetize.php8
68 files changed, 551 insertions, 236 deletions
diff --git a/core/Plugin.php b/core/Plugin.php
index 1cf987d9a9..d2de582cda 100644
--- a/core/Plugin.php
+++ b/core/Plugin.php
@@ -34,7 +34,7 @@ abstract class Piwik_Plugin
/**
* Returns the list of hooks registered with the methods names
- * @var array
+ * @return array
*/
function getListHooksRegistered()
{
diff --git a/core/TaskScheduler.php b/core/TaskScheduler.php
index 5747a3315f..7f2ae066f3 100644
--- a/core/TaskScheduler.php
+++ b/core/TaskScheduler.php
@@ -29,9 +29,11 @@ class Piwik_TaskScheduler
const TIMETABLE_OPTION_STRING = "TaskScheduler.timetable";
static private $running = false;
- /*
+ /**
* runTasks collects tasks defined within piwik plugins, runs them if they are scheduled and reschedules
* the tasks that have been executed.
+ *
+ * @return array
*/
static public function runTasks()
{
diff --git a/plugins/API/API.php b/plugins/API/API.php
index 3312475842..bf590293a6 100644
--- a/plugins/API/API.php
+++ b/plugins/API/API.php
@@ -50,6 +50,9 @@ class Piwik_API extends Piwik_Plugin {
}
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getCssFiles($notification) {
$cssFiles = &$notification->getNotificationObject();
@@ -90,9 +93,12 @@ class Piwik_API_API
}
return self::$instance;
}
-
+
/**
* Derive the unit name from a column name
+ * @param $columnName
+ * @param $idSite
+ * @return string
*/
static public function getUnit($columnName, $idSite)
{
@@ -112,9 +118,11 @@ class Piwik_API_API
return '';
}
-
+
/**
* Is a lower value for a given column better?
+ * @param $columnName
+ * @return bool
*/
static public function isLowerValueBetter($columnName)
{
@@ -138,6 +146,7 @@ class Piwik_API_API
* This is used for exports with translated labels. The exports contain columns that
* are not visible in the UI and not present in the API meta data. These columns are
* translated here.
+ * @return array
*/
static public function getDefaultMetricTranslations()
{
@@ -1109,10 +1118,17 @@ class Piwik_API_API
'metadata' => $metadata
);
}
-
+
/**
- *
- * @return Piwik_DataTable_Array
+ * @param $idSite
+ * @param $period
+ * @param $date
+ * @param $apiModule
+ * @param $apiAction
+ * @param $label
+ * @param $segment
+ * @throws Exception
+ * @return Piwik_DataTable_Array
*/
private function loadRowEvolutionDataFromAPI($idSite, $period, $date, $apiModule, $apiAction, $label, $segment)
{
@@ -1156,11 +1172,18 @@ class Piwik_API_API
return $dataTable;
}
-
+
/**
- * For a given API report, returns a simpler version
+ * For a given API report, returns a simpler version
* of the metadata (will return only the metrics and the dimension name)
- * @return array
+ * @param $idSite
+ * @param $period
+ * @param $date
+ * @param $apiModule
+ * @param $apiAction
+ * @param $language
+ * @throws Exception
+ * @return array
*/
private function getRowEvolutionMetaData($idSite, $period, $date, $apiModule, $apiAction, $language)
{
diff --git a/plugins/API/css/styles.css b/plugins/API/css/styles.css
index ca78a2ae8b..b62e0c822e 100644
--- a/plugins/API/css/styles.css
+++ b/plugins/API/css/styles.css
@@ -1,10 +1,8 @@
#token_auth {
background-color:#E8FFE9;
- border-color:#00CC3A;
- border-style: solid;
- border-width: 1px;
- margin: 0pt 0pt 16px 8px;
- padding: 12px;
+ border:1px solid #00CC3A;
+ margin: 0 0 16px 8px;
+ padding: 12px;
line-height:4em;
}
.example, .example A {
@@ -12,14 +10,14 @@
}
.page_api{
- padding:0px 15px 0 15px;
+ padding:0 15px 0 15px;
font-size:13px;
}
.page_api h2 {
border-bottom:1px solid #DADADA;
- margin:10px -15px 15px 0px;
- padding:0pt 0px 5px 0pt;
+ margin:10px -15px 15px 0;
+ padding:0 0 5px 0;
font-size:24px;
}
diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php
index bc4d3904b6..f2dd2597bf 100644
--- a/plugins/Actions/API.php
+++ b/plugins/Actions/API.php
@@ -39,25 +39,35 @@ class Piwik_Actions_API
}
return self::$instance;
}
-
+
/**
* Backward compatibility. Fallsback to getPageTitles() instead.
* @deprecated Deprecated since Piwik 0.5
* @ignore
+ *
+ * @param int $idSite
+ * @param string $period
+ * @param $date
+ * @param bool $segment
+ * @param bool $expanded
+ * @param bool|int $idSubtable
+ * @return Piwik_DataTable
*/
public function getActions( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
{
return $this->getPageTitles( $idSite, $period, $date, $segment, $expanded, $idSubtable );
}
-
+
/**
* Returns the list of metrics (pages, downloads, outlinks)
- *
+ *
* @param int $idSite
* @param string $period
* @param string $date
- * @param string $segment
+ * @param bool|string $segment
+ * @param bool|array $columns
+ * @return Piwik_DataTable
*/
public function get( $idSite, $period, $date, $segment = false, $columns = false)
{
diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php
index 865b28db5d..97b9c5b865 100644
--- a/plugins/Actions/Actions.php
+++ b/plugins/Actions/Actions.php
@@ -52,7 +52,10 @@ class Piwik_Actions extends Piwik_Plugin
);
return $hooks;
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -111,15 +114,20 @@ class Piwik_Actions extends Piwik_Plugin
'sqlFilter' => $sqlFilter,
);
}
-
- /**
- * Convert segment expression to an action ID or an SQL expression.
- *
- * This method is used as a sqlFilter-callback for the segments of this plugin.
- * Usually, these callbacks only return a value that should be compared to the
- * column in the database. In this case, that doesn't work since multiple IDs
- * can match an expression (e.g. "pageUrl=@foo").
- */
+
+ /**
+ * Convert segment expression to an action ID or an SQL expression.
+ *
+ * This method is used as a sqlFilter-callback for the segments of this plugin.
+ * Usually, these callbacks only return a value that should be compared to the
+ * column in the database. In this case, that doesn't work since multiple IDs
+ * can match an expression (e.g. "pageUrl=@foo").
+ * @param string $string
+ * @param string $sqlField
+ * @param string $matchType
+ * @throws Exception
+ * @return array|int|string
+ */
function getIdActionFromSegment($string, $sqlField, $matchType='==')
{
// Field is visit_*_idaction_url or visit_*_idaction_name
@@ -167,7 +175,12 @@ class Piwik_Actions extends Piwik_Plugin
'bind' => $string
);
}
-
+
+ /**
+ * Returns metadata for available reports
+ *
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -383,7 +396,11 @@ class Piwik_Actions extends Piwik_Plugin
$this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_actions'];
$this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_actions'];
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
@@ -412,9 +429,9 @@ class Piwik_Actions extends Piwik_Plugin
* Compute all the actions along with their hierarchies.
*
* For each action we process the "interest statistics" :
- * visits, unique visitors, bouce count, sum visit length.
- *
+ * visits, unique visitors, bounce count, sum visit length.
*
+ * @param Piwik_Event_Notification $notification notification object
*/
public function archiveDay( $notification )
{
diff --git a/plugins/Actions/Controller.php b/plugins/Actions/Controller.php
index e03a4b0d43..ec0ac8cedd 100644
--- a/plugins/Actions/Controller.php
+++ b/plugins/Actions/Controller.php
@@ -29,10 +29,12 @@ class Piwik_Actions_Controller extends Piwik_Controller
$view->setColumnTranslation('label', Piwik_Translate('Actions_ColumnPageURL'));
return $view;
}
-
-
+
+
/**
* PAGES
+ * @param bool $fetch
+ * @return string
*/
public function indexPageUrls($fetch = false)
@@ -62,10 +64,12 @@ class Piwik_Actions_Controller extends Piwik_Controller
{
$view->setColumnsToDisplay( array('label','nb_hits','nb_visits', 'bounce_rate', 'avg_time_on_page', 'exit_rate') );
}
-
-
+
+
/**
* ENTRY PAGES
+ * @param bool $fetch
+ * @return string|void
*/
public function indexEntryPageUrls($fetch = false)
@@ -101,10 +105,9 @@ class Piwik_Actions_Controller extends Piwik_Controller
}
- /**
+ /*
* EXIT PAGES
*/
-
public function indexExitPageUrls($fetch = false)
{
return Piwik_View::singleReport(
@@ -138,7 +141,7 @@ class Piwik_Actions_Controller extends Piwik_Controller
}
- /**
+ /*
* PAGE TITLES
*/
@@ -175,7 +178,7 @@ class Piwik_Actions_Controller extends Piwik_Controller
}
- /**
+ /*
* DOWNLOADS
*/
@@ -210,7 +213,7 @@ class Piwik_Actions_Controller extends Piwik_Controller
}
- /**
+ /*
* OUTLINKS
*/
@@ -344,7 +347,6 @@ class Piwik_Actions_Controller extends Piwik_Controller
}
}
- $label = $row->getColumn('label');
$newRow = array(
'level' => $depth,
'columns' => $row->getColumns(),
diff --git a/plugins/AnonymizeIP/AnonymizeIP.php b/plugins/AnonymizeIP/AnonymizeIP.php
index 8b0f7c8b9c..b5de767947 100644
--- a/plugins/AnonymizeIP/AnonymizeIP.php
+++ b/plugins/AnonymizeIP/AnonymizeIP.php
@@ -19,6 +19,7 @@ class Piwik_AnonymizeIP extends Piwik_Plugin
{
/**
* Get plugin information
+ * @return array
*/
public function getInformation()
{
@@ -33,6 +34,7 @@ class Piwik_AnonymizeIP extends Piwik_Plugin
/**
* Get list of hooks to register
+ * @return array
*/
public function getListHooksRegistered()
{
@@ -46,6 +48,7 @@ class Piwik_AnonymizeIP extends Piwik_Plugin
*
* @param string $ip IP address in network address format
* @param int $maskLength Number of octets to reset
+ * @return string
*/
static public function applyIPMask($ip, $maskLength)
{
@@ -65,6 +68,8 @@ class Piwik_AnonymizeIP extends Piwik_Plugin
/**
* Hook on Tracker.Visit.setVisitorIp to anonymize visitor IP addresses
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
function setVisitorIpAddress($notification)
{
diff --git a/plugins/CoreAdminHome/API.php b/plugins/CoreAdminHome/API.php
index 7876038c0a..e8daa45b2a 100644
--- a/plugins/CoreAdminHome/API.php
+++ b/plugins/CoreAdminHome/API.php
@@ -30,7 +30,8 @@ class Piwik_CoreAdminHome_API
/**
* Will run all scheduled tasks due to run at this time.
- * @return void
+ *
+ * @return array
*/
public function runScheduledTasks()
{
@@ -64,6 +65,7 @@ class Piwik_CoreAdminHome_API
*
* @param string $idSites Comma separated list of idSite that have had data imported for the specified dates
* @param string $dates Comma separated list of dates to invalidate for all these websites
+ * @return array
*/
public function invalidateArchivedReports($idSites, $dates)
{
@@ -221,6 +223,7 @@ class Piwik_CoreAdminHome_API
* Returns array of idSites to force re-process next time archive.php runs
*
* @ignore
+ * @return mixed
*/
static public function getWebsiteIdsToInvalidate()
{
diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php
index 1351da4b86..8bf2ac65cd 100644
--- a/plugins/CoreAdminHome/CoreAdminHome.php
+++ b/plugins/CoreAdminHome/CoreAdminHome.php
@@ -35,7 +35,10 @@ class Piwik_CoreAdminHome extends Piwik_Plugin
'TaskScheduler.getScheduledTasks' => 'getScheduledTasks',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getScheduledTasks ( $notification )
{
$tasks = &$notification->getNotificationObject();
@@ -48,7 +51,10 @@ class Piwik_CoreAdminHome extends Piwik_Plugin
$priority );
$tasks[] = $optimizeArchiveTableTask;
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
@@ -58,7 +64,10 @@ class Piwik_CoreAdminHome extends Piwik_Plugin
$cssFiles[] = "themes/default/common.css";
$cssFiles[] = "plugins/CoreAdminHome/templates/styles.css";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles ( $notification )
{
$jsFiles = &$notification->getNotificationObject();
diff --git a/plugins/CoreAdminHome/templates/styles.css b/plugins/CoreAdminHome/templates/styles.css
index ab571b1df3..174513781f 100644
--- a/plugins/CoreAdminHome/templates/styles.css
+++ b/plugins/CoreAdminHome/templates/styles.css
@@ -83,7 +83,7 @@ table.admin tbody td:hover, table.admin tbody th:hover {
}
.admin p {
- smargin-top:10px;
+ margin-top:10px;
line-height:140%;
padding-bottom:20px;
}
@@ -101,8 +101,7 @@ table.admin tbody td:hover, table.admin tbody th:hover {
}
.adminTable td {
font-size: 13px;
- vertical-align: text-top;
- vertical-align:top;
+ vertical-align: top;
padding: 7px 15px 9px 10px;
vertical-align: top;
}
diff --git a/plugins/CoreHome/CoreHome.php b/plugins/CoreHome/CoreHome.php
index 530065eeda..d0361c571a 100644
--- a/plugins/CoreHome/CoreHome.php
+++ b/plugins/CoreHome/CoreHome.php
@@ -34,6 +34,9 @@ class Piwik_CoreHome extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
@@ -48,6 +51,9 @@ class Piwik_CoreHome extends Piwik_Plugin
$cssFiles[] = "plugins/CoreHome/templates/jqplot.css";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
diff --git a/plugins/CoreHome/DataTableRowAction/RowEvolution.php b/plugins/CoreHome/DataTableRowAction/RowEvolution.php
index 8abc627ab8..05a8e9f04f 100644
--- a/plugins/CoreHome/DataTableRowAction/RowEvolution.php
+++ b/plugins/CoreHome/DataTableRowAction/RowEvolution.php
@@ -62,12 +62,13 @@ class Piwik_CoreHome_DataTableRowAction_RowEvolution
/** Whether or not to show all metrics in the evolution graph when to popover opens */
protected $initiallyShowAllMetrics = false;
-
+
/**
* The constructor
* Initialize some local variables from the request
- * @param int
- * @param Piwik_Date ($this->date from controller)
+ * @param int $idSite
+ * @param Piwik_Date $date ($this->date from controller)
+ * @throws Exception
*/
public function __construct($idSite, $date)
{
@@ -205,8 +206,12 @@ class Piwik_CoreHome_DataTableRowAction_RowEvolution
return $view;
}
-
- /** Prepare metrics toggles with spark lines */
+
+ /**
+ * Prepare metrics toggles with spark lines
+ * @param $controller
+ * @return array
+ */
protected function getMetricsToggles($controller)
{
$chart = new Piwik_Visualization_Chart_Evolution;
diff --git a/plugins/CoreHome/templates/html_report_body.tpl b/plugins/CoreHome/templates/html_report_body.tpl
index 657a87a5d1..9bea5d007d 100644
--- a/plugins/CoreHome/templates/html_report_body.tpl
+++ b/plugins/CoreHome/templates/html_report_body.tpl
@@ -27,7 +27,7 @@
<table style="border-collapse:collapse; margin-left: 5px">
<thead style="background-color: rgb({$tableHeaderBgColor}); color: rgb({$tableHeaderTextColor}); font-size: {$reportTableHeaderTextSize}pt;">
{foreach from=$reportColumns item=columnName}
- <th style="padding: 6px 0px;">
+ <th style="padding: 6px 0;">
&nbsp;{$columnName}&nbsp;&nbsp;
</th>
{/foreach}
@@ -45,7 +45,7 @@
<tr style="{cycle delimiter=';' values=";background-color: rgb(`$tableBgColor`)" }">
{foreach from=$reportColumns key=columnId item=columnName}
- <td style="font-size: {$reportTableRowTextSize}pt; border-bottom: 1px solid rgb({$tableCellBorderColor}); padding: 5px 0px 5px 5px;">
+ <td style="font-size: {$reportTableRowTextSize}pt; border-bottom: 1px solid rgb({$tableCellBorderColor}); padding: 5px 0 5px 5px;">
{if $columnId eq 'label'}
{if isset($rowMetrics[$columnId])}
{if isset($rowMetadata.logo)}
diff --git a/plugins/CoreHome/templates/jquery.ui.autocomplete.css b/plugins/CoreHome/templates/jquery.ui.autocomplete.css
index a3bd1d4aa8..7b7e1eac18 100644
--- a/plugins/CoreHome/templates/jquery.ui.autocomplete.css
+++ b/plugins/CoreHome/templates/jquery.ui.autocomplete.css
@@ -55,7 +55,6 @@
.ui-widget-content {
background:url("../../../libs/jquery/themes/base/images/ui-bg_flat_75_ffffff_40x100.png") repeat-x scroll 50% 50% #FFFFFF;
border: 0 solid #D4D4D4;
- border-top: 0;
color:#222;
}
.ui-corner-all {
diff --git a/plugins/CoreUpdater/templates/update_welcome.tpl b/plugins/CoreUpdater/templates/update_welcome.tpl
index aae319f716..ad7be091e1 100644
--- a/plugins/CoreUpdater/templates/update_welcome.tpl
+++ b/plugins/CoreUpdater/templates/update_welcome.tpl
@@ -82,7 +82,6 @@
{literal}
<style type="text/css">
-submit
code {
background-color:#F0F7FF;
border-color:#00008B;
diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php
index 4669f14b05..0da2418208 100644
--- a/plugins/CustomVariables/CustomVariables.php
+++ b/plugins/CustomVariables/CustomVariables.php
@@ -57,6 +57,11 @@ class Piwik_CustomVariables extends Piwik_Plugin
Piwik_AddMenu('General_Visitors', 'CustomVariables_CustomVariables', array('module' => 'CustomVariables', 'action' => 'index'), $display = true, $order = 50);
}
+ /**
+ * Returns metadata for available reports
+ *
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -74,6 +79,9 @@ class Piwik_CustomVariables extends Piwik_Plugin
));
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -116,6 +124,8 @@ class Piwik_CustomVariables extends Piwik_Plugin
/**
* Adds Goal dimensions, so that the dimensions are displayed in the UI Goal Overview page
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
function getReportsWithGoalMetrics( $notification )
{
@@ -141,7 +151,7 @@ class Piwik_CustomVariables extends Piwik_Plugin
/**
* Hooks on daily archive to trigger various log processing
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
public function archiveDay( $notification )
@@ -302,6 +312,10 @@ class Piwik_CustomVariables extends Piwik_Plugin
destroy($table);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
diff --git a/plugins/Dashboard/Dashboard.php b/plugins/Dashboard/Dashboard.php
index cbd781b017..699c210edb 100644
--- a/plugins/Dashboard/Dashboard.php
+++ b/plugins/Dashboard/Dashboard.php
@@ -91,7 +91,10 @@ class Piwik_Dashboard extends Piwik_Plugin
{
Piwik_AddTopMenu('General_Dashboard', array('module' => 'CoreHome', 'action' => 'index'), true, 1);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
@@ -101,7 +104,10 @@ class Piwik_Dashboard extends Piwik_Plugin
$jsFiles[] = "plugins/Dashboard/templates/Dashboard.js";
$jsFiles[] = "plugins/Dashboard/templates/dashboardWidget.js";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
@@ -110,6 +116,9 @@ class Piwik_Dashboard extends Piwik_Plugin
$cssFiles[] = "plugins/Dashboard/templates/dashboard.css";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function deleteDashboardLayout($notification)
{
$userLogin = $notification->getNotificationObject();
diff --git a/plugins/Dashboard/templates/dashboard.css b/plugins/Dashboard/templates/dashboard.css
index 393be5f0f0..72cf88d082 100644
--- a/plugins/Dashboard/templates/dashboard.css
+++ b/plugins/Dashboard/templates/dashboard.css
@@ -306,7 +306,7 @@ ul.widgetpreview-categorylist {
ul.widgetpreview-categorylist li,
ul.widgetpreview-widgetlist li {
line-height:20px;
- padding:0px 25px 0px 5px;
+ padding:0 25px 0 5px;
border-radius:2px;
-moz-border-radius:2px;
-webkit-border-radius:2px;
diff --git a/plugins/DoNotTrack/DoNotTrack.php b/plugins/DoNotTrack/DoNotTrack.php
index 09beb27b8e..2eff7d7a81 100644
--- a/plugins/DoNotTrack/DoNotTrack.php
+++ b/plugins/DoNotTrack/DoNotTrack.php
@@ -45,6 +45,9 @@ class Piwik_DoNotTrack extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function checkHeader($notification)
{
if((isset($_SERVER['HTTP_X_DO_NOT_TRACK']) && $_SERVER['HTTP_X_DO_NOT_TRACK'] === '1')
diff --git a/plugins/ExampleFeedburner/ExampleFeedburner.php b/plugins/ExampleFeedburner/ExampleFeedburner.php
index 71cab7f9bf..0f26ec33fb 100644
--- a/plugins/ExampleFeedburner/ExampleFeedburner.php
+++ b/plugins/ExampleFeedburner/ExampleFeedburner.php
@@ -82,13 +82,14 @@ class Piwik_ExampleFeedburner_Controller extends Piwik_Controller
$view->fbStats = $this->getFeedData($feedburnerFeedName);
echo $view->render();
}
-
+
/**
* Returns array of counts and images based on Feedburner URI
- *
+ *
* @param string $uri
- * @return array()
+ * @throws Exception
+ * @return array
*/
protected function getFeedData($uri)
{
diff --git a/plugins/ExampleFeedburner/templates/feedburner.tpl b/plugins/ExampleFeedburner/templates/feedburner.tpl
index 447fd9cf6f..f01c80d6fc 100644
--- a/plugins/ExampleFeedburner/templates/feedburner.tpl
+++ b/plugins/ExampleFeedburner/templates/feedburner.tpl
@@ -28,7 +28,7 @@ $(document).ready(function(){
</script>
<style type="text/css">
.metric { font-weight:bold;text-align:left; }
-.feedburner td { padding:0px 3px; }
+.feedburner td { padding:0 3px; }
</style>
{/literal}
diff --git a/plugins/ExamplePlugin/ExamplePlugin.php b/plugins/ExamplePlugin/ExamplePlugin.php
index 2d5e3bafb6..5fc32afcda 100644
--- a/plugins/ExamplePlugin/ExamplePlugin.php
+++ b/plugins/ExamplePlugin/ExamplePlugin.php
@@ -43,7 +43,10 @@ class Piwik_ExamplePlugin extends Piwik_Plugin
// 'Controller.renderView' => 'addUniqueVisitorsColumnToGivenReport',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function addUniqueVisitorsColumnToGivenReport($notification)
{
$view = $notification->getNotificationInfo();
diff --git a/plugins/ExampleRssWidget/ExampleRssWidget.php b/plugins/ExampleRssWidget/ExampleRssWidget.php
index d4ceceac82..7f56701325 100644
--- a/plugins/ExampleRssWidget/ExampleRssWidget.php
+++ b/plugins/ExampleRssWidget/ExampleRssWidget.php
@@ -38,6 +38,9 @@ class Piwik_ExampleRssWidget extends Piwik_Plugin
return array( 'AssetManager.getCssFiles' => 'getCssFiles');
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
diff --git a/plugins/ExampleRssWidget/templates/styles.css b/plugins/ExampleRssWidget/templates/styles.css
index 43722016e1..185e57088b 100644
--- a/plugins/ExampleRssWidget/templates/styles.css
+++ b/plugins/ExampleRssWidget/templates/styles.css
@@ -1,14 +1,11 @@
.rss ul {
- list-style-image:none;
- list-style-position:outside;
- list-style-type:none;
- padding:0pt;
+ list-style:none outside none;
+ padding:0;
}
.rss li {
line-height:140%;
- margin-bottom:6px;
- margin:0.5em 0pt 1em;
-}
+ margin:0.5em 0 1em;
+}
.rss-title, .rss-date {
float:left;
font-size:14px;
@@ -16,12 +13,12 @@
}
.rss-title{
color:#2583AD;
- margin:0pt 0.5em 0.2em 0pt;
+ margin:0 0.5em 0.2em 0;
font-weight:bold;
}
.rss-date {
color:#999999;
- margin:0pt;
+ margin:0;
}
.rss-content, .rss-description {
clear:both;
diff --git a/plugins/Feedback/Controller.php b/plugins/Feedback/Controller.php
index e279429272..9c5ef12369 100644
--- a/plugins/Feedback/Controller.php
+++ b/plugins/Feedback/Controller.php
@@ -25,6 +25,7 @@ class Piwik_Feedback_Controller extends Piwik_Controller
/**
* send email to Piwik team and display nice thanks
+ * @throws Exception
*/
function sendFeedback()
{
diff --git a/plugins/Feedback/Feedback.php b/plugins/Feedback/Feedback.php
index b15b8b2af5..d665391102 100644
--- a/plugins/Feedback/Feedback.php
+++ b/plugins/Feedback/Feedback.php
@@ -40,6 +40,9 @@ class Piwik_Feedback extends Piwik_Plugin
Piwik_AddTopMenu('General_GiveUsYourFeedback', array('module' => 'Feedback', 'action' => 'index'), true, $order = 20);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
@@ -47,6 +50,9 @@ class Piwik_Feedback extends Piwik_Plugin
$cssFiles[] = "plugins/Feedback/templates/styles.css";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
diff --git a/plugins/Feedback/templates/styles.css b/plugins/Feedback/templates/styles.css
index 48eebb4f55..5a7810b70b 100644
--- a/plugins/Feedback/templates/styles.css
+++ b/plugins/Feedback/templates/styles.css
@@ -3,7 +3,7 @@
color:#5e5e5c;
font-size:14px;
line-height:24px;
- padding:0px 20px 15px 0;
+ padding:0 20px 15px 0;
}
#feedback-faq strong, #feedback-sent strong {
color:#5e5e5c;
diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php
index bc3a92c1f3..4cee07f05c 100644
--- a/plugins/Goals/API.php
+++ b/plugins/Goals/API.php
@@ -83,16 +83,16 @@ class Piwik_Goals_API
/**
* Creates a Goal for a given website.
- *
+ *
* @param int $idSite
* @param string $name
* @param string $matchAttribute 'url', 'title', 'file', 'external_website' or 'manually'
* @param string $pattern eg. purchase-confirmation.htm
- * @param string $patternType 'regex', 'contains', 'exact'
+ * @param string $patternType 'regex', 'contains', 'exact'
* @param bool $caseSensitive
- * @param float|string $revenue If set, default revenue to assign to conversions
+ * @param bool|float $revenue If set, default revenue to assign to conversions
* @param bool $allowMultipleConversionsPerVisit By default, multiple conversions in the same visit will only record the first conversion.
- * If set to true, multiple conversions will all be recorded within a visit (useful for Ecommerce goals)
+ * If set to true, multiple conversions will all be recorded within a visit (useful for Ecommerce goals)
* @return int ID of the new goal
*/
public function addGoal( $idSite, $name, $matchAttribute, $pattern, $patternType, $caseSensitive = false, $revenue = false, $allowMultipleConversionsPerVisit = false)
@@ -127,12 +127,21 @@ class Piwik_Goals_API
Piwik_Common::regenerateCacheWebsiteAttributes($idSite);
return $idGoal;
}
-
+
/**
* Updates a Goal description.
- * Will not update or re-process the conversions already recorded
- *
+ * Will not update or re-process the conversions already recorded
+ *
* @see addGoal() for parameters description
+ * @param int $idSite
+ * @param int $idGoal
+ * @param $name
+ * @param $matchAttribute
+ * @param string $pattern
+ * @param string $patternType
+ * @param bool $caseSensitive
+ * @param bool|float $revenue
+ * @param bool $allowMultipleConversionsPerVisit
* @return void
*/
public function updateGoal( $idSite, $idGoal, $name, $matchAttribute, $pattern, $patternType, $caseSensitive = false, $revenue = false, $allowMultipleConversionsPerVisit = false)
@@ -368,14 +377,15 @@ class Piwik_Goals_API
return $idGoal;
}
}
-
+
/**
* Returns Goals data
- *
+ *
* @param int $idSite
* @param string $period
* @param string $date
- * @param int $idGoal
+ * @param bool $segment
+ * @param bool|int $idGoal
* @param array $columns Array of metrics to fetch: nb_conversions, conversion_rate, revenue
* @return Piwik_DataTable
*/
diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php
index 041ba491f1..40dc474a82 100644
--- a/plugins/Goals/Goals.php
+++ b/plugins/Goals/Goals.php
@@ -92,8 +92,10 @@ class Piwik_Goals extends Piwik_Plugin
/**
* Delete goals recorded for this site
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
- function deleteSiteGoals($notification )
+ function deleteSiteGoals($notification)
{
$idSite = &$notification->getNotificationObject();
Piwik_Query("DELETE FROM ".Piwik_Common::prefixTable('goal') . " WHERE idsite = ? ", array($idSite));
@@ -105,6 +107,8 @@ class Piwik_Goals extends Piwik_Plugin
* and for each goal.
*
* Also, this will update metadata of all other reports that have Goal segmentation
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
public function getReportMetadata($notification)
{
@@ -342,7 +346,10 @@ class Piwik_Goals extends Piwik_Plugin
}
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -388,19 +395,28 @@ class Piwik_Goals extends Piwik_Plugin
}
return $dimensionsByGroup;
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
$jsFiles[] = "plugins/Goals/templates/GoalForm.js";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
$cssFiles[] = "plugins/Goals/templates/goals.css";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function fetchGoalsFromDb($notification)
{
$idsite = $notification->getNotificationInfo();
@@ -488,7 +504,7 @@ class Piwik_Goals extends Piwik_Plugin
/**
* @param string $recordName 'nb_conversions'
- * @param int $idGoal idGoal to return the metrics for, or false to return overall
+ * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall
* @return string Archive record name
*/
static public function getRecordName($recordName, $idGoal = false)
@@ -527,7 +543,7 @@ class Piwik_Goals extends Piwik_Plugin
{
$dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName);
}
- $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum);
+ $archiveProcessing->archiveDataTable($dataTableToSum);
}
/*
@@ -862,6 +878,8 @@ class Piwik_Goals extends Piwik_Plugin
* This function executes when the 'Goals.getReportsWithGoalMetrics' event fires. It
* adds the 'visits to conversion' report metadata to the list of goal reports so
* this report will be displayed.
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
function getActualReportsWithGoalMetrics( $notification )
{
diff --git a/plugins/ImageGraph/ImageGraph.php b/plugins/ImageGraph/ImageGraph.php
index c28e200ed0..64213b46de 100644
--- a/plugins/ImageGraph/ImageGraph.php
+++ b/plugins/ImageGraph/ImageGraph.php
@@ -36,7 +36,11 @@ class Piwik_ImageGraph extends Piwik_Plugin
// Number of periods to plot on an evolution graph
const GRAPH_EVOLUTION_LAST_PERIODS = 30;
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
public function getReportMetadata($notification)
{
$info = $notification->getNotificationInfo();
diff --git a/plugins/Installation/Controller.php b/plugins/Installation/Controller.php
index f8d1f65f5a..a68278f334 100644
--- a/plugins/Installation/Controller.php
+++ b/plugins/Installation/Controller.php
@@ -144,6 +144,7 @@ class Piwik_Installation_Controller extends Piwik_Controller
/**
* Installation Step 3: Database Set-up
+ * @throws Exception|Zend_Db_Adapter_Exception
*/
function databaseSetup()
{
diff --git a/plugins/Installation/Installation.php b/plugins/Installation/Installation.php
index a326543818..b4fa0ca9ed 100644
--- a/plugins/Installation/Installation.php
+++ b/plugins/Installation/Installation.php
@@ -49,6 +49,9 @@ class Piwik_Installation extends Piwik_Plugin
return new $this->installationControllerName();
}
+ /**
+ * @param Piwik_Event_Notification|null $notification notification object
+ */
function dispatch($notification = null)
{
if($notification)
diff --git a/plugins/Installation/templates/install.css b/plugins/Installation/templates/install.css
index 8e4e664aef..93590cd488 100644
--- a/plugins/Installation/templates/install.css
+++ b/plugins/Installation/templates/install.css
@@ -89,8 +89,7 @@ h3 {
/* Cadre general */
#main {
- margin: 5px;
- margin-top:30px;
+ margin: 30px 5px 5px;
text-align: left;
}
@@ -159,7 +158,7 @@ td {
}
.submit input{
margin-top:15px;
- background:transparent url(./themes/default/images/background-submit.png) repeat scroll 0%;
+ background:transparent url(./themes/default/images/background-submit.png) repeat scroll 0;
font-size:1.4em;
border-color:#CCCCCC rgb(153, 153, 153) rgb(153, 153, 153) rgb(204, 204, 204);
border-style:double;
@@ -183,7 +182,7 @@ input {
}
#systemCheckLegend img {
padding-right:10px;
- vertical-align: text-middle;
+ vertical-align: middle;
}
.infos img , .infosServer img {
diff --git a/plugins/LanguagesManager/API.php b/plugins/LanguagesManager/API.php
index be90209482..5a259faa89 100644
--- a/plugins/LanguagesManager/API.php
+++ b/plugins/LanguagesManager/API.php
@@ -157,12 +157,12 @@ class Piwik_LanguagesManager_API
}
return $languageInfo;
}
-
+
/**
* Returns the language for the user
*
* @param string $login
- * @param string|false $layout
+ * @return string
*/
public function getLanguageForUser( $login )
{
@@ -176,6 +176,7 @@ class Piwik_LanguagesManager_API
*
* @param string $login
* @param string $languageCode
+ * @return bool
*/
public function setLanguageForUser($login, $languageCode)
{
diff --git a/plugins/LanguagesManager/LanguagesManager.php b/plugins/LanguagesManager/LanguagesManager.php
index d1345cd59a..038aecc0f1 100644
--- a/plugins/LanguagesManager/LanguagesManager.php
+++ b/plugins/LanguagesManager/LanguagesManager.php
@@ -37,7 +37,10 @@ class Piwik_LanguagesManager extends Piwik_Plugin
'UsersManager.deleteUser' => 'deleteUserLanguage',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
@@ -45,6 +48,9 @@ class Piwik_LanguagesManager extends Piwik_Plugin
$cssFiles[] = "themes/default/styles.css";
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
@@ -66,7 +72,10 @@ class Piwik_LanguagesManager extends Piwik_Plugin
$view->currentLanguageName = self::getLanguageNameForCurrentUser();
Piwik_AddTopMenu('LanguageSelector', $view->render(), true, $order = 30, true);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getLanguageToLoad($notification)
{
$language =& $notification->getNotificationObject();
@@ -80,6 +89,9 @@ class Piwik_LanguagesManager extends Piwik_Plugin
}
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function deleteUserLanguage($notification)
{
$userLogin = $notification->getNotificationObject();
@@ -189,6 +201,7 @@ class Piwik_LanguagesManager extends Piwik_Plugin
* Set the language for the session
*
* @param string $languageCode ISO language code
+ * @return bool
*/
static public function setLanguageForSession($languageCode)
{
diff --git a/plugins/Live/API.php b/plugins/Live/API.php
index 841ba35d1a..6f9eed508f 100644
--- a/plugins/Live/API.php
+++ b/plugins/Live/API.php
@@ -88,12 +88,16 @@ class Piwik_Live_API
empty($data[0]['visitsConverted']) ? $data[0]['visitsConverted'] = 0 : '';
return $data;
}
-
+
/**
* The same functionnality can be obtained using segment=visitorId==$visitorId with getLastVisitsDetails
- *
+ *
* @deprecated
* @ignore
+ * @param int $visitorId
+ * @param int $idSite
+ * @param int $filter_limit
+ * @return Piwik_DataTable
*/
public function getLastVisitsForVisitor( $visitorId, $idSite, $filter_limit = 10 )
{
@@ -106,14 +110,15 @@ class Piwik_Live_API
/**
* Returns the last visits tracked in the specified website
* You can define any number of filters: none, one, many or all parameters can be defined
- *
- * @param int Site ID
- * @param string (optional) Period to restrict to when looking at the logs
- * @param string (optional) Date to restrict to
- * @param int (optional) Number of visits rows to return
- * @param int (optional) Maximum idvisit to restrict the query to (useful when paginating)
- * @param int (optional) Minimum timestamp to restrict the query to (useful when paginating or refreshing visits)
- *
+ *
+ * @param int $idSite Site ID
+ * @param bool|string $period (optional) Period to restrict to when looking at the logs
+ * @param bool|string $date (optional) Date to restrict to
+ * @param bool|int $segment (optional) Number of visits rows to return
+ * @param bool|int $filter_limit (optional)
+ * @param bool|int $maxIdVisit (optional) Maximum idvisit to restrict the query to (useful when paginating)
+ * @param bool|int $minTimestamp (optional) Minimum timestamp to restrict the query to (useful when paginating or refreshing visits)
+ *
* @return Piwik_DataTable
*/
public function getLastVisitsDetails( $idSite, $period = false, $date = false, $segment = false, $filter_limit = false, $maxIdVisit = false, $minTimestamp = false )
@@ -137,8 +142,11 @@ class Piwik_Live_API
}
/**
- * For an array of visits, query the list of pages for this visit
+ * For an array of visits, query the list of pages for this visit
* as well as make the data human readable
+ * @param array $visitorDetails
+ * @param int $idSite
+ * @return Piwik_DataTable
*/
private function getCleanedVisitorsFromDetails($visitorDetails, $idSite)
{
diff --git a/plugins/Live/Live.php b/plugins/Live/Live.php
index 17b21c2029..e88abcba92 100644
--- a/plugins/Live/Live.php
+++ b/plugins/Live/Live.php
@@ -35,14 +35,20 @@ class Piwik_Live extends Piwik_Plugin
'Menu.add' => 'addMenu',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
$cssFiles[] = "plugins/Live/templates/live.css";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
diff --git a/plugins/Login/Controller.php b/plugins/Login/Controller.php
index 8722704f58..6daf725bb6 100644
--- a/plugins/Login/Controller.php
+++ b/plugins/Login/Controller.php
@@ -106,7 +106,7 @@ class Piwik_Login_Controller extends Piwik_Controller
/**
* Form-less login
* @see how to use it on http://piwik.org/faq/how-to/#faq_30
- * @param none
+ * @throws Exception
* @return void
*/
function logme()
@@ -298,6 +298,7 @@ class Piwik_Login_Controller extends Piwik_Controller
* @param string $loginMail user name or email address
* @param string $token password reset token
* @param string $password new password
+ * @throws Exception
* @return string failure message
*/
protected function resetPasswordFormValidated($loginMail, $token, $password)
diff --git a/plugins/Login/Login.php b/plugins/Login/Login.php
index 1f836e72cb..7c8bcbe994 100644
--- a/plugins/Login/Login.php
+++ b/plugins/Login/Login.php
@@ -42,7 +42,7 @@ class Piwik_Login extends Piwik_Plugin
* Redirects to Login form with error message.
* Listens to FrontController.NoAccessException hook.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function noAccess( $notification )
{
@@ -57,7 +57,7 @@ class Piwik_Login extends Piwik_Plugin
* Set login name and autehntication token for authentication request.
* Listens to API.Request.authenticate hook.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function ApiRequestAuthenticate($notification)
{
@@ -70,7 +70,7 @@ class Piwik_Login extends Piwik_Plugin
* Initializes the authentication object.
* Listens to FrontController.initAuthenticationObject hook.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function initAuthenticationObject($notification)
{
@@ -98,12 +98,13 @@ class Piwik_Login extends Piwik_Plugin
$auth->setLogin($defaultLogin);
$auth->setTokenAuth($defaultTokenAuth);
}
-
+
/**
* Authenticate user and initializes the session.
* Listens to Login.initSession hook.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
+ * @throws Exception
*/
function initSession($notification)
{
diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php
index 30c7f2812a..7a654ea706 100755
--- a/plugins/MultiSites/API.php
+++ b/plugins/MultiSites/API.php
@@ -79,9 +79,10 @@ class Piwik_MultiSites_API
*
* @param string $period The period type to get data for.
* @param string $date The date(s) to get data for.
- * @param string $segment The segments to get data for.
- * @param string $_restrictSitesToLogin Hack used to enforce we restrict the returned data to the specified username
- * Only used when a scheduled task is running
+ * @param bool|string $segment The segments to get data for.
+ * @param bool|string $_restrictSitesToLogin Hack used to enforce we restrict the returned data to the specified username
+ * Only used when a scheduled task is running
+ * @return Piwik_DataTable
*/
public function getAll($period, $date, $segment = false, $_restrictSitesToLogin = false)
{
diff --git a/plugins/MultiSites/MultiSites.php b/plugins/MultiSites/MultiSites.php
index 323b494950..df7472e714 100644
--- a/plugins/MultiSites/MultiSites.php
+++ b/plugins/MultiSites/MultiSites.php
@@ -36,6 +36,9 @@ class Piwik_MultiSites extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$isGoalPluginEnabled = Piwik_Common::isGoalPluginEnabled();
@@ -65,13 +68,19 @@ class Piwik_MultiSites extends Piwik_Plugin
Piwik_AddTopMenu('General_MultiSitesSummary', array('module' => 'MultiSites', 'action' => 'index'), true, 3);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
$jsFiles[] = "plugins/MultiSites/templates/common.js";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles( $notification )
{
$cssFiles = &$notification->getNotificationObject();
diff --git a/plugins/PDFReports/API.php b/plugins/PDFReports/API.php
index 10c1b5c036..52bbffcf58 100644
--- a/plugins/PDFReports/API.php
+++ b/plugins/PDFReports/API.php
@@ -238,19 +238,20 @@ class Piwik_PDFReports_API
return $reports;
}
-
- /**
+
+ /**
* Generates a report file.
*
- * @param int $idReport ID of the report to generate. If idReport=0 it will generate a report containing all reports
+ * @param int $idReport ID of the report to generate. If idReport=0 it will generate a report containing all reports
* for the specified period & date
- * @param string $date YYYY-MM-DD
- * @param int|false $idSite
- * @param string|false $language If not passed, will use default language.
- * @param int|false $outputType 1 = download report, 2 = save report to disk, defaults to download
- * @param string|false $period Defaults to 'day'. If not specified, will default to the report's period set when creating the report
- * @param string $reportFormat pdf, html
- * @param int|false $displayFormat see Piwik_PDFReports_API::getDisplayFormats()
+ * @param string $date YYYY-MM-DD
+ * @param bool|false|int $idSite
+ * @param bool|false|string $language If not passed, will use default language.
+ * @param bool|false|int $outputType 1 = download report, 2 = save report to disk, defaults to download
+ * @param bool|false|string $period Defaults to 'day'. If not specified, will default to the report's period set when creating the report
+ * @param bool|string $reportFormat pdf, html
+ * @param bool|false|int $displayFormat see Piwik_PDFReports_API::getDisplayFormats()
+ * @return array
*/
public function generateReport($idReport, $date, $idSite = false, $language = false, $outputType = false, $period = false, $reportFormat = false, $displayFormat = false)
{
diff --git a/plugins/PDFReports/PDFReports.php b/plugins/PDFReports/PDFReports.php
index 456d7d2d5f..aea8b708ff 100644
--- a/plugins/PDFReports/PDFReports.php
+++ b/plugins/PDFReports/PDFReports.php
@@ -48,7 +48,7 @@ class Piwik_PDFReports extends Piwik_Plugin
/**
* Delete reports for the website
*
- * @param Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function deleteSiteReport( $notification )
{
@@ -62,13 +62,19 @@ class Piwik_PDFReports extends Piwik_Plugin
Piwik_PDFReports_API::getInstance()->deleteReport($idReport);
}
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles( $notification )
{
$jsFiles = &$notification->getNotificationObject();
$jsFiles[] = "plugins/PDFReports/templates/pdf.js";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getScheduledTasks ( $notification )
{
// Reports have to be sent when the period ends for all websites
@@ -139,7 +145,10 @@ class Piwik_PDFReports extends Piwik_Plugin
{
Piwik_AddTopMenu( 'PDFReports_EmailReports', array('module' => 'PDFReports', 'action' => 'index'), true, 13);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function deleteUserReport($notification)
{
$userLogin = $notification->getNotificationObject();
diff --git a/plugins/PrivacyManager/LogDataPurger.php b/plugins/PrivacyManager/LogDataPurger.php
index 628dee2261..68f657c15d 100755
--- a/plugins/PrivacyManager/LogDataPurger.php
+++ b/plugins/PrivacyManager/LogDataPurger.php
@@ -138,6 +138,7 @@ class Piwik_PrivacyManager_LogDataPurger
/**
* get highest idVisit to delete rows from
+ * @return string
*/
private function getDeleteIdVisitOffset()
{
@@ -269,17 +270,19 @@ class Piwik_PrivacyManager_LogDataPurger
'log_conversion_item',
'log_action');
}
-
+
/**
* Utility function. Creates a new instance of LogDataPurger with the supplied array
* of settings.
- *
+ *
* $settings must contain values for the following keys:
* - 'delete_logs_older_than': The number of days after which log entries are considered
* old.
* - 'delete_logs_max_rows_per_query': Max number of rows to DELETE in one query.
- *
+ *
* @param array $settings Array of settings
+ * @param bool $useRealTable
+ * @return Piwik_PrivacyManager_LogDataPurger
*/
public static function make( $settings, $useRealTable = false )
{
diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php
index 565766e144..6a08a10d01 100644
--- a/plugins/PrivacyManager/PrivacyManager.php
+++ b/plugins/PrivacyManager/PrivacyManager.php
@@ -67,6 +67,9 @@ class Piwik_PrivacyManager extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getScheduledTasks($notification)
{
$tasks = &$notification->getNotificationObject();
@@ -83,6 +86,9 @@ class Piwik_PrivacyManager extends Piwik_Plugin
$tasks[] = $purgeLogDataTask;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles($notification)
{
$jsFiles = &$notification->getNotificationObject();
@@ -298,6 +304,7 @@ class Piwik_PrivacyManager extends Piwik_Plugin
* @param int|Piwik_Date $reportsOlderThan If an int, the number of months a report must be older than
* in order to be purged. If a date, the date a report must be
* older than in order to be purged.
+ * @return bool
*/
public static function shouldReportBePurged( $reportDateYear, $reportDateMonth, $reportsOlderThan = null )
{
diff --git a/plugins/PrivacyManager/ReportsPurger.php b/plugins/PrivacyManager/ReportsPurger.php
index 3343b9b6e0..33e7a7a6f7 100755
--- a/plugins/PrivacyManager/ReportsPurger.php
+++ b/plugins/PrivacyManager/ReportsPurger.php
@@ -252,10 +252,11 @@ class Piwik_PrivacyManager_ReportsPurger
/**
* Returns true if a report with the given year & month should be purged or not.
- *
+ *
* @param int $reportDateYear The year of the report in question.
* @param int $reportDateMonth The month of the report in question.
- * @param Piwik_Date $reportsOlderThan The date a report must be older than in order to be purged.
+ * @param Piwik_Date $toRemoveDate The date a report must be older than in order to be purged.
+ * @return bool
*/
public static function shouldReportBePurged( $reportDateYear, $reportDateMonth, $toRemoveDate )
{
diff --git a/plugins/PrivacyManager/tests/PrivacyManager.test.php b/plugins/PrivacyManager/tests/PrivacyManager.test.php
index 403409af4c..8e2ac39c7e 100755
--- a/plugins/PrivacyManager/tests/PrivacyManager.test.php
+++ b/plugins/PrivacyManager/tests/PrivacyManager.test.php
@@ -733,6 +733,8 @@ class Test_Piwik_PrivacyManager extends Test_Integration
* does the insert into the temporary table. When log_actions are deleted, this idaction should still
* be kept. w/ the wrong strategy, it won't be and there will be a dangling reference
* in the log_link_visit_action table.
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
public function addReferenceToUnusedAction( $notification )
{
diff --git a/plugins/Provider/Controller.php b/plugins/Provider/Controller.php
index 63a307ba56..d00315fe69 100644
--- a/plugins/Provider/Controller.php
+++ b/plugins/Provider/Controller.php
@@ -15,9 +15,11 @@
* @package Piwik_Provider
*/
class Piwik_Provider_Controller extends Piwik_Controller
-{
+{
/**
* Provider
+ * @param bool $fetch
+ * @return string|void
*/
function getProvider($fetch = false)
{
diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php
index 60214f8268..9f9d8f380a 100644
--- a/plugins/Provider/Provider.php
+++ b/plugins/Provider/Provider.php
@@ -43,6 +43,9 @@ class Piwik_Provider extends Piwik_Plugin
return $hooks;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -57,6 +60,9 @@ class Piwik_Provider extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -112,6 +118,10 @@ class Piwik_Provider extends Piwik_Plugin
Piwik_AddAction('template_footerUserCountry', array('Piwik_Provider','footerUserCountry'));
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard'];
@@ -125,6 +135,8 @@ class Piwik_Provider extends Piwik_Plugin
/**
* Daily archive: processes the report Visits by Provider
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
function archiveDay($notification)
{
@@ -144,6 +156,8 @@ class Piwik_Provider extends Piwik_Plugin
/**
* Logs the provider in the log_visit table
+ *
+ * @param Piwik_Event_Notification $notification notification object
*/
public function logProviderInfo($notification)
{
@@ -233,12 +247,18 @@ class Piwik_Provider extends Piwik_Plugin
return trim(strtolower(@Piwik_IP::getHostByAddr($ip)));
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
static public function headerUserCountry($notification)
{
$out =& $notification->getNotificationObject();
$out = '<div id="leftcolumn">';
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
static public function footerUserCountry($notification)
{
$out =& $notification->getNotificationObject();
diff --git a/plugins/Proxy/Controller.php b/plugins/Proxy/Controller.php
index 9f88b17486..800950cf26 100644
--- a/plugins/Proxy/Controller.php
+++ b/plugins/Proxy/Controller.php
@@ -131,7 +131,6 @@ class Piwik_Proxy_Controller extends Piwik_Controller
if(!empty($referrer) && !Piwik_Url::isLocalUrl($referrer))
{
die('Invalid Referer detected - check that your browser sends the Referer header. <br/>The link you would have been redirected to is: '.$url);
- exit;
}
// mask visits to *.piwik.org
diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php
index eab4c37a0d..34ac6decc8 100644
--- a/plugins/Referers/Referers.php
+++ b/plugins/Referers/Referers.php
@@ -51,6 +51,9 @@ class Piwik_Referers extends Piwik_Plugin
return $hooks;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -114,7 +117,10 @@ class Piwik_Referers extends Piwik_Plugin
),
));
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -184,7 +190,7 @@ class Piwik_Referers extends Piwik_Plugin
/**
* Adds Goal dimensions, so that the dimensions are displayed in the UI Goal Overview page
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function getReportsWithGoalMetrics( $notification )
@@ -230,7 +236,7 @@ class Piwik_Referers extends Piwik_Plugin
* Period archiving: sums up daily stats and sums report tables,
* making sure that tables are still truncated.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function archivePeriod( $notification )
@@ -306,7 +312,7 @@ class Piwik_Referers extends Piwik_Plugin
/**
* Hooks on daily archive to trigger various log processing
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
public function archiveDay( $notification )
@@ -337,12 +343,13 @@ class Piwik_Referers extends Piwik_Plugin
destroy($this->interestByType);
destroy($this->distinctUrls);
}
-
+
/**
* Daily archive: processes all Referers reports, eg. Visits by Keyword,
* Visits by websites, etc.
*
* @param Piwik_ArchiveProcessing $archiveProcessing
+ * @throws Exception
* @return void
*/
protected function archiveDayAggregateVisits(Piwik_ArchiveProcessing $archiveProcessing)
diff --git a/plugins/Referers/functions.php b/plugins/Referers/functions.php
index 1b99f3a2c0..96bda73a46 100644
--- a/plugins/Referers/functions.php
+++ b/plugins/Referers/functions.php
@@ -169,7 +169,9 @@ function Piwik_getRefererTypeLabel($label)
/**
* Works in both directions
- * @param mixed
+ * @param string $name
+ * @throws Exception
+ * @return string
*/
function Piwik_getRefererTypeFromShortName($name)
{
diff --git a/plugins/SitesManager/API.php b/plugins/SitesManager/API.php
index c5b8d9b488..1265fd5071 100644
--- a/plugins/SitesManager/API.php
+++ b/plugins/SitesManager/API.php
@@ -516,13 +516,14 @@ class Piwik_SitesManager_API
Piwik_Site::clearCache();
Piwik_Common::regenerateCacheWebsiteAttributes($idSite);
}
-
+
/**
* Delete a website from the database, given its Id.
- *
- * Requires Super User access.
+ *
+ * Requires Super User access.
*
* @param int $idSite
+ * @throws Exception
*/
public function deleteSite( $idSite )
{
@@ -554,12 +555,13 @@ class Piwik_SitesManager_API
Piwik_PostEvent('SitesManager.deleteSite', $idSite);
}
-
-
+
+
/**
* Checks that the array has at least one element
- *
- * @exception if the parameter is not an array or if array empty
+ *
+ * @param array $urls
+ * @throws Exception
*/
private function checkAtLeastOneUrl( $urls )
{
@@ -593,12 +595,13 @@ class Piwik_SitesManager_API
throw new Exception(Piwik_TranslateException('SitesManager_ExceptionInvalidCurrency', array($currency, "USD, EUR, etc.")));
}
}
-
+
/**
* Checks that the submitted IPs (comma separated list) are valid
* Returns the cleaned up IPs
*
* @param string $excludedIps Comma separated list of IP addresses
+ * @throws Exception
* @return array of IPs
*/
private function checkAndReturnExcludedIps($excludedIps)
@@ -773,23 +776,24 @@ class Piwik_SitesManager_API
Piwik_SetOption(self::OPTION_DEFAULT_TIMEZONE, $defaultTimezone);
return true;
}
-
+
/**
* Update an existing website.
* If only one URL is specified then only the main url will be updated.
* If several URLs are specified, both the main URL and the alias URLs will be updated.
- *
- * @param int website ID defining the website to edit
- * @param string website name
- * @param string|array the website URLs
- * @param string Comma separated list of IPs to exclude from being tracked (allows wildcards)
- * @param string Timezone
- * @param string Currency code
- * @param string Group name where this website belongs
- * @param string Date at which the statistics for this website will start. Defaults to today's date in YYYY-MM-DD format
- *
- * @exception if any of the parameter is not correct
- *
+ *
+ * @param int $idSite website ID defining the website to edit
+ * @param string $siteName website name
+ * @param string|array $urls the website URLs
+ * @param null $ecommerce
+ * @param string $excludedIps Comma separated list of IPs to exclude from being tracked (allows wildcards)
+ * @param null $excludedQueryParameters
+ * @param string $timezone Timezone
+ * @param string $currency Currency code
+ * @param string $group Group name where this website belongs
+ * @param string $startDate Date at which the statistics for this website will start. Defaults to today's date in YYYY-MM-DD format
+ *
+ * @throws Exception
* @return bool true on success
*/
public function updateSite( $idSite, $siteName, $urls = null, $ecommerce = null, $excludedIps = null, $excludedQueryParameters = null, $timezone = null, $currency = null, $group = null, $startDate = null)
@@ -1063,11 +1067,12 @@ class Piwik_SitesManager_API
{
return Piwik_IP::getIpsForRange($ip) !== false;
}
-
+
/**
* Check that the website name has a correct format.
- *
- * @exception if the website name is empty
+ *
+ * @param $siteName
+ * @throws Exception
*/
private function checkName($siteName)
{
@@ -1080,8 +1085,8 @@ class Piwik_SitesManager_API
/**
* Check that the array of URLs are valid URLs
*
- * @exception if any of the urls is not valid
- * @param array
+ * @param array $urls
+ * @throws Exception if any of the urls is not valid
*/
private function checkUrls($urls)
{
diff --git a/plugins/SitesManager/SitesManager.php b/plugins/SitesManager/SitesManager.php
index 5b5a111373..ff4af21b8a 100644
--- a/plugins/SitesManager/SitesManager.php
+++ b/plugins/SitesManager/SitesManager.php
@@ -48,7 +48,7 @@ class Piwik_SitesManager extends Piwik_Plugin
/**
* Get CSS files
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function getCssFiles( $notification )
{
@@ -60,7 +60,7 @@ class Piwik_SitesManager extends Piwik_Plugin
/**
* Get JavaScript files
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function getJsFiles( $notification )
{
@@ -73,7 +73,7 @@ class Piwik_SitesManager extends Piwik_Plugin
* Hooks when a website tracker cache is flushed (website updated, cache deleted, or empty cache)
* Will record in the tracker config file all data needed for this website in Tracker.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function recordWebsiteDataInCache($notification)
diff --git a/plugins/SitesManager/templates/SitesManager.tpl b/plugins/SitesManager/templates/SitesManager.tpl
index a42d584d30..db8a84dbdc 100644
--- a/plugins/SitesManager/templates/SitesManager.tpl
+++ b/plugins/SitesManager/templates/SitesManager.tpl
@@ -67,12 +67,10 @@ $(document).ready( function() {
}
.addRowSite {
padding:1em;
- font-color:#3A477B;
- padding:1em;
font-weight:bold;
}
#editSites {
- valign: top;
+ vertical-align: top;
}
option, select {
font-size:11px;
diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php
index 1bfcdff065..e3c02cd67c 100644
--- a/plugins/UserCountry/UserCountry.php
+++ b/plugins/UserCountry/UserCountry.php
@@ -52,7 +52,9 @@ class Piwik_UserCountry extends Piwik_Plugin
Piwik_AddMenu('General_Visitors', 'UserCountry_SubmenuLocations', array('module' => 'UserCountry', 'action' => 'index'));
}
-
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -74,6 +76,9 @@ class Piwik_UserCountry extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$metrics = array(
@@ -105,6 +110,9 @@ class Piwik_UserCountry extends Piwik_Plugin
);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getReportsWithGoalMetrics( $notification )
{
$dimensions =& $notification->getNotificationObject();
@@ -122,6 +130,10 @@ class Piwik_UserCountry extends Piwik_Plugin
));
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
/**
@@ -141,6 +153,10 @@ class Piwik_UserCountry extends Piwik_Plugin
$nameToCount['UserCountry_country']['level0']);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archiveDay($notification)
{
/**
diff --git a/plugins/UserCountryMap/templates/worldmap.tpl b/plugins/UserCountryMap/templates/worldmap.tpl
index 61a9bbab5c..bab3129e92 100644
--- a/plugins/UserCountryMap/templates/worldmap.tpl
+++ b/plugins/UserCountryMap/templates/worldmap.tpl
@@ -1,7 +1,7 @@
<div id="UserCountryMap_content" style="position:relative; overflow:hidden;">
<div id="UserCountryMap_map">{'General_RequiresFlash'|translate}</div>
<div style="height:3px"></div>
- <select id="userCountryMapSelectMetrics" style="position:absolute; left: 5px; bottom: 0px;">
+ <select id="userCountryMapSelectMetrics" style="position:absolute; left: 5px; bottom: 0;">
{foreach from=$metrics item=metric}
<option value="{$metric[0]}" {if $metric[0] == $defaultMetric}selected="selected"{/if}>{$metric[1]}</option>
{/foreach}
diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php
index 68da147ebc..1aae436c92 100644
--- a/plugins/UserSettings/UserSettings.php
+++ b/plugins/UserSettings/UserSettings.php
@@ -146,7 +146,7 @@ class Piwik_UserSettings extends Piwik_Plugin
/*
* Registers reports metadata
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
public function getReportMetadata($notification)
{
@@ -192,7 +192,7 @@ class Piwik_UserSettings extends Piwik_Plugin
/**
* Get segments meta data
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
public function getSegmentsMetadata($notification)
{
@@ -240,7 +240,7 @@ class Piwik_UserSettings extends Piwik_Plugin
* by Browser, Browser family, etc. Some reports are built from the logs, some reports
* are superset of an existing report (eg. Browser family is built from the Browser report)
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function archiveDay( $notification )
@@ -304,7 +304,7 @@ class Piwik_UserSettings extends Piwik_Plugin
/**
* Period archiving: simply sums up daily archives
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function archivePeriod( $notification )
diff --git a/plugins/UsersManager/API.php b/plugins/UsersManager/API.php
index 5b071f468b..ee28df7216 100644
--- a/plugins/UsersManager/API.php
+++ b/plugins/UsersManager/API.php
@@ -26,14 +26,15 @@
class Piwik_UsersManager_API
{
static private $instance = null;
-
+
/**
- * You can create your own Users Plugin to override this class.
+ * You can create your own Users Plugin to override this class.
* Example of how you would overwrite the UsersManager_API with your own class:
* Call the following in your plugin __construct() for example:
- *
+ *
* Zend_Registry::set('UsersManager_API',Piwik_MyCustomUsersManager_API::getInstance());
- *
+ *
+ * @throws Exception
* @return Piwik_UsersManager_API
*/
static public function getInstance()
@@ -67,13 +68,12 @@ class Piwik_UsersManager_API
Piwik::checkUserIsSuperUserOrTheUser($userLogin);
Piwik_SetOption($this->getPreferenceId($userLogin, $preferenceName), $preferenceValue);
}
-
+
/**
* Gets a user preference
* @param string $userLogin
* @param string $preferenceName
- * @param string $preferenceValue
- * @return void
+ * @return bool|string
*/
public function getUserPreference($userLogin, $preferenceName)
{
@@ -89,7 +89,7 @@ class Piwik_UsersManager_API
/**
* Returns the list of all the users
*
- * @param string Comma separated list of users to select. If not specified, will return all users
+ * @param string $userLogins Comma separated list of users to select. If not specified, will return all users
* @return array the list of all the users
*/
public function getUsers( $userLogins = '' )
@@ -467,9 +467,9 @@ class Piwik_UsersManager_API
/**
* Delete a user and all its access, given its login.
*
- * @param string the user login.
+ * @param string $userLogin the user login.
*
- * @exception if the user doesn't exist
+ * @throws Exception if the user doesn't exist
*
* @return bool true on success
*/
@@ -520,15 +520,15 @@ class Piwik_UsersManager_API
*
* If access = 'noaccess' the current access (if any) will be deleted.
* If access = 'view' or 'admin' the current access level is deleted and updated with the new value.
- *
- * @param string Access to grant. Must have one of the following value : noaccess, view, admin
- * @param string The user login
- * @param int|array The array of idSites on which to apply the access level for the user.
+ *
+ * @param string $userLogin The user login
+ * @param string $access Access to grant. Must have one of the following value : noaccess, view, admin
+ * @param int|array $idSites The array of idSites on which to apply the access level for the user.
* If the value is "all" then we apply the access level to all the websites ID for which the current authentificated user has an 'admin' access.
*
- * @exception if the user doesn't exist
- * @exception if the access parameter doesn't have a correct value
- * @exception if any of the given website ID doesn't exist
+ * @throws Exception if the user doesn't exist
+ * @throws Exception if the access parameter doesn't have a correct value
+ * @throws Exception if any of the given website ID doesn't exist
*
* @return bool true on success
*/
@@ -587,8 +587,8 @@ class Piwik_UsersManager_API
/**
* Throws an exception is the user login doesn't exist
*
- * @param string user login
- * @exception if the user doesn't exist
+ * @param string $userLogin user login
+ * @throws Exception if the user doesn't exist
*/
private function checkUserExists( $userLogin )
{
@@ -601,8 +601,8 @@ class Piwik_UsersManager_API
/**
* Throws an exception is the user email cannot be found
*
- * @param string user email
- * @exception if the user doesn't exist
+ * @param string $userEmail user email
+ * @throws Exception if the user doesn't exist
*/
private function checkUserEmailExists( $userEmail )
{
@@ -687,12 +687,14 @@ class Piwik_UsersManager_API
}
}
}
-
+
/**
* Generates a unique MD5 for the given login & password
- *
- * @param string Login
- * @param string MD5ied string of the password
+ *
+ * @param string $userLogin Login
+ * @param string $md5Password MD5ied string of the password
+ * @throws Exception
+ * @return string
*/
public function getTokenAuth($userLogin, $md5Password)
{
diff --git a/plugins/UsersManager/Controller.php b/plugins/UsersManager/Controller.php
index 533e9cbb83..1202620fea 100644
--- a/plugins/UsersManager/Controller.php
+++ b/plugins/UsersManager/Controller.php
@@ -251,9 +251,10 @@ class Piwik_UsersManager_Controller extends Piwik_Controller_Admin
}
echo $toReturn;
}
-
+
/**
* Records settings from the "User Settings" page
+ * @throws Exception
*/
public function recordUserSettings()
{
diff --git a/plugins/UsersManager/UsersManager.php b/plugins/UsersManager/UsersManager.php
index 136ada7962..0ffb7336ab 100644
--- a/plugins/UsersManager/UsersManager.php
+++ b/plugins/UsersManager/UsersManager.php
@@ -59,7 +59,7 @@ class Piwik_UsersManager extends Piwik_Plugin
* Will record in the tracker config file the list of Admin token_auth for this website. This
* will be used when the Tracking API is used with setIp(), setForceDateTime(), setVisitorId(), etc.
*
- * @param Piwik_Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
* @return void
*/
function recordAdminUsersInCache($notification)
@@ -80,7 +80,7 @@ class Piwik_UsersManager extends Piwik_Plugin
/**
* Delete user preferences associated with a particular site
*
- * @param Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function deleteSite( $notification )
{
@@ -94,7 +94,7 @@ class Piwik_UsersManager extends Piwik_Plugin
*
* @see Piwik_AssetManager
*
- * @param Event_Notification $notification
+ * @param Piwik_Event_Notification $notification notification object
*/
function getJsFiles( $notification )
{
@@ -106,8 +106,6 @@ class Piwik_UsersManager extends Piwik_Plugin
/**
* Add admin menu items
- *
- * @param Event_Notification $notification (not used)
*/
function addMenu()
{
diff --git a/plugins/UsersManager/templates/UsersManager.tpl b/plugins/UsersManager/templates/UsersManager.tpl
index 471e0da89a..4d848db027 100644
--- a/plugins/UsersManager/templates/UsersManager.tpl
+++ b/plugins/UsersManager/templates/UsersManager.tpl
@@ -18,7 +18,6 @@
cursor: pointer;
}
.addrow {
- font-color:#3A477B;
padding:1em;
font-weight:bold;
}
diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php
index 74b5d54435..bc534495dc 100644
--- a/plugins/VisitFrequency/VisitFrequency.php
+++ b/plugins/VisitFrequency/VisitFrequency.php
@@ -39,6 +39,9 @@ class Piwik_VisitFrequency extends Piwik_Plugin
return $hooks;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -75,7 +78,11 @@ class Piwik_VisitFrequency extends Piwik_Plugin
{
Piwik_AddMenu('General_Visitors', 'VisitFrequency_SubmenuFrequency', array('module' => 'VisitFrequency', 'action' => 'index'));
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
@@ -92,7 +99,11 @@ class Piwik_VisitFrequency extends Piwik_Plugin
$archiveProcessing->archiveNumericValuesSum($numericToSum);
$archiveProcessing->archiveNumericValuesMax('max_actions_returning');
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archiveDay($notification)
{
/* @var $archiveProcessing Piwik_ArchiveProcessing */
diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php
index ce2c36ea17..572431f50e 100644
--- a/plugins/VisitTime/VisitTime.php
+++ b/plugins/VisitTime/VisitTime.php
@@ -41,6 +41,9 @@ class Piwik_VisitTime extends Piwik_Plugin
return $hooks;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -78,6 +81,9 @@ class Piwik_VisitTime extends Piwik_Plugin
Piwik_AddMenu('General_Visitors', 'VisitTime_SubmenuTimes', array('module' => 'VisitTime', 'action' => 'index'));
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getReportsWithGoalMetrics( $notification )
{
$dimensions =& $notification->getNotificationObject();
@@ -87,7 +93,10 @@ class Piwik_VisitTime extends Piwik_Plugin
'action' => 'getVisitInformationPerServerTime',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getSegmentsMetadata($notification)
{
$segments =& $notification->getNotificationObject();
@@ -109,7 +118,11 @@ class Piwik_VisitTime extends Piwik_Plugin
'acceptedValues' => $acceptedValues
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
@@ -122,7 +135,11 @@ class Piwik_VisitTime extends Piwik_Plugin
);
$archiveProcessing->archiveDataTable($dataTableToSum);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
public function archiveDay( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php
index d06d586c8d..ab79039071 100644
--- a/plugins/VisitorInterest/VisitorInterest.php
+++ b/plugins/VisitorInterest/VisitorInterest.php
@@ -39,6 +39,9 @@ class Piwik_VisitorInterest extends Piwik_Plugin
return $hooks;
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
@@ -186,6 +189,10 @@ class Piwik_VisitorInterest extends Piwik_Plugin
array(364)
);
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
function archivePeriod( $notification )
{
$archiveProcessing = $notification->getNotificationObject();
@@ -200,7 +207,11 @@ class Piwik_VisitorInterest extends Piwik_Plugin
);
$archiveProcessing->archiveDataTable($dataTableToSum);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ * @return mixed
+ */
public function archiveDay( $notification )
{
$this->archiveProcessing = $notification->getNotificationObject();
@@ -298,13 +309,19 @@ class Piwik_VisitorInterest extends Piwik_Plugin
$this->archiveProcessing->insertBlobRecord($recordName, $dataTable->getSerialized());
destroy($dataTable);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
static public function headerVisitsFrequency($notification)
{
$out =& $notification->getNotificationObject();
$out = '<div id="leftcolumn">';
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
static public function footerVisitsFrequency($notification)
{
$out =& $notification->getNotificationObject();
diff --git a/plugins/VisitsSummary/VisitsSummary.php b/plugins/VisitsSummary/VisitsSummary.php
index e1ce17d21a..756953aa7e 100644
--- a/plugins/VisitsSummary/VisitsSummary.php
+++ b/plugins/VisitsSummary/VisitsSummary.php
@@ -39,7 +39,10 @@ class Piwik_VisitsSummary extends Piwik_Plugin
'Menu.add' => 'addMenu',
);
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
public function getReportMetadata($notification)
{
$reports = &$notification->getNotificationObject();
diff --git a/plugins/Widgetize/Widgetize.php b/plugins/Widgetize/Widgetize.php
index af8035d3ad..b3a7830998 100644
--- a/plugins/Widgetize/Widgetize.php
+++ b/plugins/Widgetize/Widgetize.php
@@ -42,6 +42,9 @@ class Piwik_Widgetize extends Piwik_Plugin
Piwik_AddTopMenu('General_Widgets', array('module' => 'Widgetize', 'action' => 'index'), true, 5);
}
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getJsFiles($notification)
{
$jsFiles = &$notification->getNotificationObject();
@@ -55,7 +58,10 @@ class Piwik_Widgetize extends Piwik_Plugin
$jsFiles[] = "plugins/Dashboard/templates/widgetMenu.js";
$jsFiles[] = "plugins/Widgetize/templates/widgetize.js";
}
-
+
+ /**
+ * @param Piwik_Event_Notification $notification notification object
+ */
function getCssFiles($notification)
{
$cssFiles = &$notification->getNotificationObject();