don't specify optional parameters before required parameters (#16185)

refs https://github.com/matomo-org/matomo/pull/16182

I suppose eventually we'll go over all of them since the IDE should be able to detect all usages

7 files changed, 27 insertions, 12 deletions

diff --git a/plugins/CoreHome/Controller.php b/plugins/CoreHome/Controller.php
index b152e31dcf..1eb51f06f4 100644
--- a/plugins/CoreHome/Controller.php
+++ b/plugins/CoreHome/Controller.php
@@ -116,7 +116,10 @@ class Controller extends \Piwik\Plugin\Controller
 
     function redirectToCoreHomeIndex()
     {
-        $defaultReport = API::getInstance()->getUserPreference(Piwik::getCurrentUserLogin(), API::PREFERENCE_DEFAULT_REPORT);
+        $defaultReport = API::getInstance()->getUserPreference(
+            API::PREFERENCE_DEFAULT_REPORT,
+            Piwik::getCurrentUserLogin()
+        );
         $module = 'CoreHome';
         $action = 'index';
 
diff --git a/plugins/SegmentEditor/SegmentSelectorControl.php b/plugins/SegmentEditor/SegmentSelectorControl.php
index 476fa1ba33..4957a137bc 100644
--- a/plugins/SegmentEditor/SegmentSelectorControl.php
+++ b/plugins/SegmentEditor/SegmentSelectorControl.php
@@ -80,7 +80,10 @@ class SegmentSelectorControl extends UIControl
         $this->isUserAnonymous = Piwik::isUserIsAnonymous();
         $this->segmentTranslations = $this->getTranslations();
         $this->segmentProcessedOnRequest = Rules::isBrowserArchivingAvailableForSegments();
-        $this->hideSegmentDefinitionChangeMessage = UsersManagerAPI::getInstance()->getUserPreference(Piwik::getCurrentUserLogin(), 'hideSegmentDefinitionChangeMessage');
+        $this->hideSegmentDefinitionChangeMessage = UsersManagerAPI::getInstance()->getUserPreference(
+            'hideSegmentDefinitionChangeMessage',
+            Piwik::getCurrentUserLogin()
+        );
     }
 
     public function getClientSideProperties()
diff --git a/plugins/UsersManager/API.php b/plugins/UsersManager/API.php
index bc4cb9e08d..5286973b84 100644
--- a/plugins/UsersManager/API.php
+++ b/plugins/UsersManager/API.php
@@ -193,11 +193,11 @@ class API extends \Piwik\Plugin\API
 
     /**
      * Gets a user preference
-     * @param string $userLogin  Optional, defaults to current user log in.
      * @param string $preferenceName
+     * @param string|bool $userLogin Optional, defaults to current user log in when set to false.
      * @return bool|string
      */
-    public function getUserPreference($userLogin = false, $preferenceName)
+    public function getUserPreference($preferenceName, $userLogin = false)
     {
         if ($userLogin === false) {
             // the default value for first parameter is there to have it an optional parameter in the HTTP API
diff --git a/plugins/UsersManager/Controller.php b/plugins/UsersManager/Controller.php
index 47a721c426..a7e0159ee5 100644
--- a/plugins/UsersManager/Controller.php
+++ b/plugins/UsersManager/Controller.php
@@ -139,7 +139,7 @@ class Controller extends ControllerAdmin
      */
     protected function getDefaultDateForUser($user)
     {
-        return APIUsersManager::getInstance()->getUserPreference($user, APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE);
+        return APIUsersManager::getInstance()->getUserPreference(APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE, $user);
     }
 
     /**
diff --git a/plugins/UsersManager/UserPreferences.php b/plugins/UsersManager/UserPreferences.php
index a3b868d432..d99578cd9b 100644
--- a/plugins/UsersManager/UserPreferences.php
+++ b/plugins/UsersManager/UserPreferences.php
@@ -62,7 +62,10 @@ class UserPreferences
     public function getDefaultReport()
     {
         // User preference: default website ID to load
-        $defaultReport = $this->api->getUserPreference(Piwik::getCurrentUserLogin(), APIUsersManager::PREFERENCE_DEFAULT_REPORT);
+        $defaultReport = $this->api->getUserPreference(
+            APIUsersManager::PREFERENCE_DEFAULT_REPORT,
+            Piwik::getCurrentUserLogin()
+        );
 
         if (!is_numeric($defaultReport)) {
             return $defaultReport;
@@ -123,7 +126,10 @@ class UserPreferences
     public function getDefaultDateWithoutValidation()
     {
         // NOTE: a change in this function might mean a change in plugins/UsersManager/javascripts/usersSettings.js as well
-        $userSettingsDate = $this->api->getUserPreference(Piwik::getCurrentUserLogin(), APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE);
+        $userSettingsDate = $this->api->getUserPreference(
+            APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE,
+            Piwik::getCurrentUserLogin()
+        );
         if ($userSettingsDate == 'yesterday') {
             return $userSettingsDate;
         }
@@ -140,7 +146,10 @@ class UserPreferences
     public function getDefaultPeriodWithoutValidation($defaultDate = null)
     {
         if (empty($defaultDate)) {
-            $defaultDate = $this->api->getUserPreference(Piwik::getCurrentUserLogin(), APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE);
+            $defaultDate = $this->api->getUserPreference(
+                APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE,
+                Piwik::getCurrentUserLogin()
+            );
         }
 
         if (empty($defaultDate)) {
diff --git a/plugins/UsersManager/tests/Integration/APITest.php b/plugins/UsersManager/tests/Integration/APITest.php
index 3150f154b9..e69da89f95 100644
--- a/plugins/UsersManager/tests/Integration/APITest.php
+++ b/plugins/UsersManager/tests/Integration/APITest.php
@@ -209,7 +209,7 @@ class APITest extends IntegrationTestCase
 
     public function test_getUserPreference_ShouldReturnADefaultPreference_IfNoneIsSet()
     {
-        $siteId = $this->api->getUserPreference($this->login, API::PREFERENCE_DEFAULT_REPORT);
+        $siteId = $this->api->getUserPreference(API::PREFERENCE_DEFAULT_REPORT, $this->login);
         $this->assertEquals('1', $siteId);
     }
 
@@ -217,7 +217,7 @@ class APITest extends IntegrationTestCase
     {
         $this->api->setUserPreference($this->login, API::PREFERENCE_DEFAULT_REPORT, 5);
 
-        $siteId = $this->api->getUserPreference($this->login, API::PREFERENCE_DEFAULT_REPORT);
+        $siteId = $this->api->getUserPreference(API::PREFERENCE_DEFAULT_REPORT, $this->login);
         $this->assertEquals('5', $siteId);
     }
 
diff --git a/plugins/UsersManager/tests/Integration/UsersManagerTest.php b/plugins/UsersManager/tests/Integration/UsersManagerTest.php
index bd8807f1c7..248c0315b7 100644
--- a/plugins/UsersManager/tests/Integration/UsersManagerTest.php
+++ b/plugins/UsersManager/tests/Integration/UsersManagerTest.php
@@ -1021,8 +1021,8 @@ class UsersManagerTest extends IntegrationTestCase
         $defaultReportPref = API::PREFERENCE_DEFAULT_REPORT;
         $defaultReportDatePref = API::PREFERENCE_DEFAULT_REPORT_DATE;
 
-        $this->assertEquals(1, $this->api->getUserPreference('someUser', $defaultReportPref));
-        $this->assertEquals('yesterday', $this->api->getUserPreference('someUser', $defaultReportDatePref));
+        $this->assertEquals(1, $this->api->getUserPreference($defaultReportPref, 'someUser'));
+        $this->assertEquals('yesterday', $this->api->getUserPreference($defaultReportDatePref, 'someUser'));
     }
 
     public function testGetAvailableRoles()