Fixes for CodeStyle vol.2

[bookstack] / app / Auth / Access / UserTokenService.php

diff --git a/app/Auth/Access/UserTokenService.php b/app/Auth/Access/UserTokenService.php
index 34f3b285110aa1aa799ef56492f799949e3f5893..565dcb948b4caab36ee2056784d200241417fa27 100644 (file)
--- a/app/Auth/Access/UserTokenService.php
+++ b/app/Auth/Access/UserTokenService.php
@@ -1,23 +1,27 @@
-<?php namespace BookStack\Auth\Access;
+<?php
+
+namespace BookStack\Auth\Access;

 
 use BookStack\Auth\User;
 use BookStack\Exceptions\UserTokenExpiredException;
 use BookStack\Exceptions\UserTokenNotFoundException;
 use Carbon\Carbon;
 use Illuminate\Database\Connection as Database;
 
 use BookStack\Auth\User;
 use BookStack\Exceptions\UserTokenExpiredException;
 use BookStack\Exceptions\UserTokenNotFoundException;
 use Carbon\Carbon;
 use Illuminate\Database\Connection as Database;

+use Illuminate\Support\Str;

 use stdClass;
 
 class UserTokenService
 {
 use stdClass;
 
 class UserTokenService
 {

-

     /**
      * Name of table where user tokens are stored.
     /**
      * Name of table where user tokens are stored.

+     *

      * @var string
      */
     protected $tokenTable = 'user_tokens';
 
     /**
      * Token expiry time in hours.
      * @var string
      */
     protected $tokenTable = 'user_tokens';
 
     /**
      * Token expiry time in hours.

+     *

      * @var int
      */
     protected $expiryTime = 24;
      * @var int
      */
     protected $expiryTime = 24;


@@ -26,6 +30,7 @@ class UserTokenService
 
     /**
      * UserTokenService constructor.
 
     /**
      * UserTokenService constructor.

+     *

      * @param Database $db
      */
     public function __construct(Database $db)
      * @param Database $db
      */
     public function __construct(Database $db)


@@ -35,7 +40,9 @@ class UserTokenService
 
     /**
      * Delete all email confirmations that belong to a user.
 
     /**
      * Delete all email confirmations that belong to a user.

+     *

      * @param User $user
      * @param User $user

+     *

      * @return mixed
      */
     public function deleteByUser(User $user)
      * @return mixed
      */
     public function deleteByUser(User $user)


@@ -47,12 +54,15 @@ class UserTokenService
 
     /**
      * Get the user id from a token, while check the token exists and has not expired.
 
     /**
      * Get the user id from a token, while check the token exists and has not expired.

+     *

      * @param string $token
      * @param string $token

-     * @return int
+     *

      * @throws UserTokenNotFoundException
      * @throws UserTokenExpiredException
      * @throws UserTokenNotFoundException
      * @throws UserTokenExpiredException

+     *
+     * @return int

      */
      */

-    public function checkTokenAndGetUserId(string $token) : int
+    public function checkTokenAndGetUserId(string $token): int

     {
         $entry = $this->getEntryByToken($token);
 
     {
         $entry = $this->getEntryByToken($token);
 


@@ -69,40 +79,47 @@ class UserTokenService
 
     /**
      * Creates a unique token within the email confirmation database.
 
     /**
      * Creates a unique token within the email confirmation database.

+     *

      * @return string
      */
      * @return string
      */

-    protected function generateToken() : string
+    protected function generateToken(): string

     {
     {

-        $token = str_random(24);
+        $token = Str::random(24);

         while ($this->tokenExists($token)) {
         while ($this->tokenExists($token)) {

-            $token = str_random(25);
+            $token = Str::random(25);

         }
         }

+

         return $token;
     }
 
     /**
      * Generate and store a token for the given user.
         return $token;
     }
 
     /**
      * Generate and store a token for the given user.

+     *

      * @param User $user
      * @param User $user

+     *

      * @return string
      */
      * @return string
      */

-    protected function createTokenForUser(User $user) : string
+    protected function createTokenForUser(User $user): string

     {
         $token = $this->generateToken();
         $this->db->table($this->tokenTable)->insert([
     {
         $token = $this->generateToken();
         $this->db->table($this->tokenTable)->insert([

-            'user_id' => $user->id,
-            'token' => $token,
+            'user_id'    => $user->id,
+            'token'      => $token,

             'created_at' => Carbon::now(),
             'created_at' => Carbon::now(),

-            'updated_at' => Carbon::now()
+            'updated_at' => Carbon::now(),

         ]);
         ]);

+

         return $token;
     }
 
     /**
      * Check if the given token exists.
         return $token;
     }
 
     /**
      * Check if the given token exists.

+     *

      * @param string $token
      * @param string $token

+     *

      * @return bool
      */
      * @return bool
      */

-    protected function tokenExists(string $token) : bool
+    protected function tokenExists(string $token): bool

     {
         return $this->db->table($this->tokenTable)
             ->where('token', '=', $token)->exists();
     {
         return $this->db->table($this->tokenTable)
             ->where('token', '=', $token)->exists();


@@ -110,7 +127,9 @@ class UserTokenService
 
     /**
      * Get a token entry for the given token.
 
     /**
      * Get a token entry for the given token.

+     *

      * @param string $token
      * @param string $token

+     *

      * @return object|null
      */
     protected function getEntryByToken(string $token)
      * @return object|null
      */
     protected function getEntryByToken(string $token)


@@ -122,13 +141,14 @@ class UserTokenService
 
     /**
      * Check if the given token entry has expired.
 
     /**
      * Check if the given token entry has expired.

+     *

      * @param stdClass $tokenEntry
      * @param stdClass $tokenEntry

+     *

      * @return bool
      */
      * @return bool
      */

-    protected function entryExpired(stdClass $tokenEntry) : bool
+    protected function entryExpired(stdClass $tokenEntry): bool

     {
         return Carbon::now()->subHours($this->expiryTime)
             ->gt(new Carbon($tokenEntry->created_at));
     }
     {
         return Carbon::now()->subHours($this->expiryTime)
             ->gt(new Carbon($tokenEntry->created_at));
     }

-
-}
\ No newline at end of file
+}