Improve PHPDoc of CheckIfAdmin middleware

phpfour · web-flow · commit f98154357b9c · 2022-08-11T20:27:55.000+06:00
diff --git a/src/app/Http/Middleware/CheckIfAdmin.php b/src/app/Http/Middleware/CheckIfAdmin.php
@@ -22,8 +22,8 @@ class CheckIfAdmin
      * does not have a '/home' route, use something you've built for your users
      * (again - users, not admins).
      *
-     * @param [type] $user [description]
-     * @return bool [description]
+     * @param  \Illuminate\Contracts\Auth\Authenticatable|null  $user
+     * @return bool
      */
     private function checkIfUserIsAdmin($user)
     {
@@ -34,8 +34,8 @@ private function checkIfUserIsAdmin($user)
     /**
      * Answer to unauthorized access request.
      *
-     * @param [type] $request [description]
-     * @return [type] [description]
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
      */
     private function respondToUnauthorizedRequest($request)
     {

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ class CheckIfAdmin`
`22`	`22`	`* does not have a '/home' route, use something you've built for your users`
`23`	`23`	`* (again - users, not admins).`
`24`	`24`	`*`
`25`		`- * @param [type] $user [description]`
`26`		`- * @return bool [description]`
	`25`	`+ * @param \Illuminate\Contracts\Auth\Authenticatable\|null $user`
	`26`	`+ * @return bool`
`27`	`27`	`*/`
`28`	`28`	`private function checkIfUserIsAdmin($user)`
`29`	`29`	`{`
`@@ -34,8 +34,8 @@ private function checkIfUserIsAdmin($user)`
`34`	`34`	`/**`
`35`	`35`	`* Answer to unauthorized access request.`
`36`	`36`	`*`
`37`		`- * @param [type] $request [description]`
`38`		`- * @return [type] [description]`
	`37`	`+ * @param \Illuminate\Http\Request $request`
	`38`	`+ * @return \Illuminate\Http\Response\|\Illuminate\Http\RedirectResponse`
`39`	`39`	`*/`
`40`	`40`	`private function respondToUnauthorizedRequest($request)`
`41`	`41`	`{`