MC-30537: Test automation with the new 2FA enabled by default

- Static fixes

Author: nathanjosiah

TwoFactorAuth/Api/CountryRepositoryInterface.php

@@ -14,40 +14,46 @@
 
 /**
  * Countries repository
+ *
  * @SuppressWarnings(PHPMD.ShortVariable)
  */
 interface CountryRepositoryInterface
 {
     /**
      * Save object
+     *
      * @param CountryInterface $object
      * @return CountryInterface
      */
     public function save(CountryInterface $object): CountryInterface;
 
     /**
      * Get object by id
+     *
      * @param int $id
      * @return CountryInterface
      */
     public function getById(int $id): CountryInterface;
 
     /**
      * Get by Code value
+     *
      * @param string $value
      * @return CountryInterface
      */
     public function getByCode(string $value): CountryInterface;
 
     /**
      * Delete object
+     *
      * @param CountryInterface $object
      * @return void
      */
     public function delete(CountryInterface $object): void;
 
     /**
      * Get a list of object
+     *
      * @param SearchCriteriaInterface $searchCriteria
      * @return CountrySearchResultsInterface
      */

TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php

@@ -10,18 +10,20 @@
 use Magento\Framework\Api\SearchResultsInterface;
 
 /**
- * Country search results interface
+ * Represent country search results
  */
 interface CountrySearchResultsInterface extends SearchResultsInterface
 {
     /**
      * Get an array of objects
+     *
      * @return CountryInterface[]
      */
     public function getItems(): array;
 
     /**
      * Set objects list
+     *
      * @param CountryInterface[] $items
      * @return CountrySearchResultsInterface
      */

TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php

@@ -16,12 +16,14 @@ interface UserConfigSearchResultsInterface extends SearchResultsInterface
 {
     /**
      * Get an array of objects
+     *
      * @return UserConfigInterface[]
      */
     public function getItems(): array;
 
     /**
      * Set objects list
+     *
      * @param UserConfigInterface[] $items
      * @return UserConfigSearchResultsInterface
      */

TwoFactorAuth/Api/EngineInterface.php

@@ -24,6 +24,7 @@ public function isEnabled(): bool;
 
     /**
      * Return true on token validation
+     *
      * @param UserInterface $user
      * @param DataObject $request
      * @return bool

TwoFactorAuth/Api/ProviderPoolInterface.php

@@ -16,12 +16,14 @@ interface ProviderPoolInterface
 {
     /**
      * Get a list of providers
+     *
      * @return \Magento\TwoFactorAuth\Api\ProviderInterface[]
      */
     public function getProviders(): array;
 
     /**
      * Get provider by code
+     *
      * @param string $code
      * @return \Magento\TwoFactorAuth\Api\ProviderInterface
      * @throws NoSuchEntityException

TwoFactorAuth/Api/TfaSessionInterface.php

@@ -24,6 +24,7 @@ public function grantAccess(): void;
 
     /**
      * Return true if 2FA session has been passed
+     *
      * @return bool
      */
     public function isGranted(): bool;

TwoFactorAuth/Api/UserConfigManagerInterface.php

@@ -21,6 +21,7 @@ interface UserConfigManagerInterface
 
     /**
      * Get a provider configuration for a given user
+     *
      * @param int $userId
      * @param string $providerCode
      * @return array|null
@@ -30,26 +31,29 @@ public function getProviderConfig(int $userId, string $providerCode): ?array;
 
     /**
      * Set provider configuration
+     *
      * @param int $userId
      * @param string $providerCode
      * @param array|null $config
      * @return bool
      * @throws NoSuchEntityException
      */
-    public function setProviderConfig(int $userId, string $providerCode, ?array $config=null): bool;
+    public function setProviderConfig(int $userId, string $providerCode, ?array $config = null): bool;
 
     /**
      * Set provider configuration
+     *
      * @param int $userId
      * @param string $providerCode
      * @param array|null $config
      * @return bool
      * @throws NoSuchEntityException
      */
-    public function addProviderConfig(int $userId, string $providerCode, ?array $config=null): bool;
+    public function addProviderConfig(int $userId, string $providerCode, ?array $config = null): bool;
 
     /**
      * Reset provider configuration
+     *
      * @param int $userId
      * @param string $providerCode
      * @return bool
@@ -59,6 +63,7 @@ public function resetProviderConfig(int $userId, string $providerCode): bool;
 
     /**
      * Set providers list for a given user
+     *
      * @param int $userId
      * @param string|array $providersCodes
      * @return bool
@@ -68,13 +73,15 @@ public function setProvidersCodes(int $userId, $providersCodes): bool;
 
     /**
      * Set providers list for a given user
+     *
      * @param int $userId
      * @return string[]
      */
     public function getProvidersCodes(int $userId): array;
 
     /**
      * Activate a provider configuration
+     *
      * @param int $userId
      * @param string $providerCode
      * @return bool
@@ -84,6 +91,7 @@ public function activateProviderConfiguration(int $userId, string $providerCode)
 
     /**
      * Return true if a provider configuration has been activated
+     *
      * @param int $userId
      * @param string $providerCode
      * @return bool
@@ -93,6 +101,7 @@ public function isProviderConfigurationActive(int $userId, string $providerCode)
 
     /**
      * Set default provider
+     *
      * @param int $userId
      * @param string $providerCode
      * @return bool
@@ -101,7 +110,8 @@ public function isProviderConfigurationActive(int $userId, string $providerCode)
     public function setDefaultProvider(int $userId, string $providerCode): bool;
 
     /**
-     * get default provider
+     * Get default provider
+     *
      * @param int $userId
      * @return string
      */

TwoFactorAuth/Api/UserConfigRepositoryInterface.php

@@ -14,40 +14,46 @@
 
 /**
  * User configuration repository
+ *
  * @SuppressWarnings(PHPMD.ShortVariable)
  */
 interface UserConfigRepositoryInterface
 {
     /**
      * Save object
+     *
      * @param UserConfigInterface $object
      * @return UserConfigInterface
      */
     public function save(UserConfigInterface $object): UserConfigInterface;
 
     /**
      * Get object by id
+     *
      * @param int $id
      * @return UserConfigInterface
      */
     public function getById(int $id): UserConfigInterface;
 
     /**
      * Get by UserId value
+     *
      * @param int $value
      * @return UserConfigInterface
      */
     public function getByUserId(int $value): UserConfigInterface;
 
     /**
      * Delete object
+     *
      * @param UserConfigInterface $object
      * @return bool
      */
     public function delete(UserConfigInterface $object): bool;
 
     /**
      * Get a list of object
+     *
      * @param SearchCriteriaInterface $searchCriteria
      * @return UserConfigSearchResultsInterface
      */

TwoFactorAuth/Block/ChangeProvider.php

@@ -14,6 +14,8 @@
 use Magento\TwoFactorAuth\Api\ProviderInterface;
 
 /**
+ * Represent the change providers block for authentication workflow
+ *
  * @api
  */
 class ChangeProvider extends Template
@@ -34,7 +36,6 @@ class ChangeProvider extends Template
     private $session;
 
     /**
-     * ChangeProvider constructor.
      * @param Template\Context $context
      * @param Session $session
      * @param UserContextInterface $userContext
@@ -97,6 +98,7 @@ public function getJsLayout()
 
     /**
      * Get a list of available providers
+     *
      * @return ProviderInterface[]
      */
     private function getProvidersList(): array

TwoFactorAuth/Block/Configure.php

@@ -27,8 +27,8 @@ class Configure extends Template
 
     /**
      * @param Template\Context $context
-     * @param array $data
      * @param TfaInterface $tfa
+     * @param array $data
      */
     public function __construct(Template\Context $context, TfaInterface $tfa, array $data = [])
     {