Apply fixes from StyleCI

[ci skip] [skip ci]
antonioribeiro · Oct 6, 2018 · 9ac4355 · 9ac4355
1 parent b0526ba
commit 9ac4355
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 30 deletions.
diff --git a/src/Google2FA.php b/src/Google2FA.php
@@ -2,10 +2,10 @@
 
 namespace PragmaRX\Google2FA;
 
-use PragmaRX\Google2FA\Support\QRCode;
+use PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException;
 use PragmaRX\Google2FA\Support\Base32;
 use PragmaRX\Google2FA\Support\Constants;
-use PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException;
+use PragmaRX\Google2FA\Support\QRCode;
 
 class Google2FA
 {
@@ -41,10 +41,11 @@ class Google2FA
      * @param $timestamp
      * @param string $oldTimestamp
      *
-     * @return bool
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
      * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return bool
      */
     public function findValidOTP($secret, $key, $window, $startingTimestamp, $timestamp, $oldTimestamp = Constants::ARGUMENT_NOT_SET)
     {
@@ -63,12 +64,13 @@ public function findValidOTP($secret, $key, $window, $startingTimestamp, $timest
     /**
      * Generate a digit secret key in base32 format.
      *
-     * @param int $length
+     * @param int    $length
      * @param string $prefix
      *
-     * @return string
      * @throws Exceptions\InvalidCharactersException
      * @throws Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return string
      */
     public function generateSecretKey($length = 16, $prefix = '')
     {
@@ -80,10 +82,11 @@ public function generateSecretKey($length = 16, $prefix = '')
      *
      * @param $secret
      *
-     * @return string
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
      * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return string
      */
     public function getCurrentOtp($secret)
     {
@@ -187,8 +190,8 @@ protected function makeTimestamp($timestamp = null)
      * Takes the secret key and the timestamp and returns the one time
      * password.
      *
-     * @param string $secret - Secret key in binary form.
-     * @param int $counter - Timestamp as returned by getTimestamp.
+     * @param string $secret  - Secret key in binary form.
+     * @param int    $counter - Timestamp as returned by getTimestamp.
      *
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
@@ -298,16 +301,17 @@ public function setWindow($window)
      * Verifies a user inputted key against the current timestamp. Checks $window
      * keys either side of the timestamp.
      *
-     * @param string $key - User specified key
-     * @param null|string $secret
-     * @param null|int $window
-     * @param null|int $timestamp
+     * @param string          $key          - User specified key
+     * @param null|string     $secret
+     * @param null|int        $window
+     * @param null|int        $timestamp
      * @param null|string|int $oldTimestamp
      *
-     * @return bool|int
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
      * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return bool|int
      */
     public function verify($key, $secret = null, $window = null, $timestamp = null, $oldTimestamp = Constants::ARGUMENT_NOT_SET)
     {
@@ -324,16 +328,17 @@ public function verify($key, $secret = null, $window = null, $timestamp = null,
      * Verifies a user inputted key against the current timestamp. Checks $window
      * keys either side of the timestamp.
      *
-     * @param string $secret
-     * @param string $key - User specified key
-     * @param null|int $window
-     * @param null|int $timestamp
+     * @param string          $secret
+     * @param string          $key          - User specified key
+     * @param null|int        $window
+     * @param null|int        $timestamp
      * @param null|string|int $oldTimestamp
      *
-     * @return bool|int
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
      * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return bool|int
      */
     public function verifyKey($secret, $key, $window = null, $timestamp = null, $oldTimestamp = Constants::ARGUMENT_NOT_SET)
     {
@@ -355,17 +360,17 @@ public function verifyKey($secret, $key, $window = null, $timestamp = null, $old
      * the given oldTimestamp. Useful if you need to ensure that a single key cannot
      * be used twice.
      *
-     * @param string $secret
-     * @param string $key - User specified key
-     * @param int $oldTimestamp - The timestamp from the last verified key
+     * @param string   $secret
+     * @param string   $key          - User specified key
+     * @param int      $oldTimestamp - The timestamp from the last verified key
      * @param int|null $window
      * @param int|null $timestamp
      *
-     * @return bool|int - false (not verified) or the timestamp of the verified key
-     *
      * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException
      * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException
      * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException
+     *
+     * @return bool|int - false (not verified) or the timestamp of the verified key
      */
     public function verifyKeyNewer($secret, $key, $oldTimestamp, $window = null, $timestamp = null)
     {

diff --git a/src/Support/Base32.php b/src/Support/Base32.php
@@ -3,8 +3,8 @@
 namespace PragmaRX\Google2FA\Support;
 
 use ParagonIE\ConstantTime\Base32 as ParagonieBase32;
-use PragmaRX\Google2FA\Exceptions\InvalidCharactersException;
 use PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException;
+use PragmaRX\Google2FA\Exceptions\InvalidCharactersException;
 
 trait Base32
 {
@@ -16,12 +16,13 @@ trait Base32
     /**
      * Generate a digit secret key in base32 format.
      *
-     * @param int $length
-     *
+     * @param int    $length
      * @param string $prefix
-     * @return string
+     *
      * @throws IncompatibleWithGoogleAuthenticatorException
      * @throws InvalidCharactersException
+     *
+     * @return string
      */
     public function generateBase32RandomKey($length = 16, $prefix = '')
     {
@@ -59,8 +60,9 @@ public function base32Decode($b32)
      * @param $string
      * @param $length
      *
-     * @return string
      * @throws \Exception
+     *
+     * @return string
      */
     private function strPadBase32($string, $length)
     {
@@ -91,8 +93,9 @@ public function toBase32($string)
      * @param $from
      * @param $to
      *
-     * @return int
      * @throws \Exception
+     *
+     * @return int
      */
     protected function getRandomNumber($from = 0, $to = 31)
     {
@@ -103,6 +106,7 @@ protected function getRandomNumber($from = 0, $to = 31)
      * Validate the secret.
      *
      * @param $b32
+     *
      * @throws IncompatibleWithGoogleAuthenticatorException
      * @throws InvalidCharactersException
      */

diff --git a/src/Support/QRCode.php b/src/Support/QRCode.php
@@ -17,7 +17,7 @@ trait QRCode
      * @param string $company
      * @param string $holder
      * @param string $secret
-     * @param int $size
+     * @param int    $size
      *
      * @throws \PragmaRX\Google2FA\Exceptions\InsecureCallException
      *

diff --git a/tests/Google2FATest.php b/tests/Google2FATest.php
@@ -224,6 +224,7 @@ public function testValidateKey()
     public function setAllowInsecureCallToGoogleApis($allowInsecureCallToGoogleApis)
     {
         $this->allowInsecureCallToGoogleApis = $allowInsecureCallToGoogleApis;
+
         return $this;
     }
 }