Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[11.x] signature typo #50766

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

abrahamgreyson
Copy link
Contributor

One single Illuminate\Routing\Controllers\Middleware instance may break the request

@abrahamgreyson abrahamgreyson changed the title signature typo [11.x] signature typo Mar 26, 2024
@@ -7,7 +7,7 @@ interface HasMiddleware
/**
* Get the middleware that should be assigned to the controller.
*
* @return \Illuminate\Routing\Controllers\Middleware|array
* @return \Illuminate\Routing\Controllers\Middleware[]|array
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't array become redundant here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stupid me

@taylorotwell taylorotwell merged commit 5daf210 into laravel:11.x Mar 26, 2024
4 of 5 checks passed
@freshnewuniquename
Copy link

The updated type from this MR seems to differ from the allowed array element types given in the 2nd and 3rd official docs (master branch) examples of the middleware function return value.

Examples extracted from the docs
<?php
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use Illuminate\Routing\Controllers\HasMiddleware;
use Illuminate\Routing\Controllers\Middleware;
 
class UserController extends Controller implements HasMiddleware
{
    /**
     * Get the middleware that should be assigned to the controller.
     */
    public static function middleware(): array
    {
        return [
            'auth',
            new Middleware('log', only: ['index']),
            new Middleware('subscribed', except: ['store']),
        ];
    }
 
    // ...
}
use Closure;
use Illuminate\Http\Request;
 
/**
 * Get the middleware that should be assigned to the controller.
 */
public static function middleware(): array
{
    return [
        function (Request $request, Closure $next) {
            return $next($request);
        },
    ];
}

Would a type like this fit better?

     /**
      * Get the middleware that should be assigned to the controller.
      *
-     * @return \Illuminate\Routing\Controllers\Middleware[]
+     * @return (\Illuminate\Routing\Controllers\Middleware|Closure|string)[]
      */
     public static function middleware();

@abrahamgreyson abrahamgreyson deleted the typo_signature branch July 9, 2024 02:44
@abrahamgreyson abrahamgreyson restored the typo_signature branch July 9, 2024 02:45
@abrahamgreyson
Copy link
Contributor Author

You are correct

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants