Laragear/Meta

View on GitHub
src/Http/Middleware/MiddlewareDeclaration.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Laragear\Meta\Http\Middleware;

use Closure;
use Illuminate\Foundation\Http\Kernel;
use Illuminate\Routing\Router;

/**
 * @internal
 */
class MiddlewareDeclaration
{
    /**
     * Create a new Middleware declaration instance.
     *
     * @param  \Illuminate\Routing\Router  $router
     * @param  \Illuminate\Foundation\Http\Kernel  $kernel
     * @param  string  $middleware
     */
    public function __construct(protected Router $router, protected Kernel $kernel, protected string $middleware)
    {
        //
    }

    /**
     * Aliases the middleware with a friendly name.
     *
     * @param  string  $alias
     * @return $this
     */
    public function as(string $alias): static
    {
        $this->router->aliasMiddleware($alias, $this->middleware);

        return $this;
    }

    /**
     * Registers the middleware in a middleware group.
     *
     * @param  string  $group
     * @return $this
     */
    public function inGroup(string $group): static
    {
        $this->kernel->appendMiddlewareToGroup($group, $this->middleware);

        return $this;
    }

    /**
     * Runs the middleware globally on all routes.
     *
     * @return $this
     */
    public function globally(): static
    {
        $this->kernel->pushMiddleware($this->middleware);

        return $this;
    }

    /**
     * Sets the global middleware priority as first.
     *
     * @return void
     */
    public function first(): void
    {
        $this->kernel->prependToMiddlewarePriority($this->middleware);
    }

    /**
     * Sets the global middleware priority as last.
     *
     * @return void
     */
    public function last(): void
    {
        $this->kernel->appendToMiddlewarePriority($this->middleware);
    }

    /**
     * Makes the middleware a shared instance.
     *
     * @param  (\Closure(\Illuminate\Contracts\Foundation\Application):mixed)|null  $callback
     * @return $this
     */
    public function shared(Closure $callback = null): static
    {
        $this->kernel->getApplication()->singleton($this->middleware, $callback);

        return $this;
    }
}