Route final readonly class

Minn\Http\Route · public/minn/src/Minn/Http/Route.php · 75 lines

Declares a handler method as a route. The policy lives here, as metadata the router enforces before the handler runs, so the authorization surface of the engine is a grep away; a route with no policy is one the ratchet in the style suite counts down. The parameter sets it reads live here too, judged before the policy is (the reference refuses a bad argument before it refuses a caller), so the REST index can tell a client what a route takes as well as what it requires of them.

Patterns: "/wp/v2/posts/{id}" captures one segment, "{id:\d+}" constrains it, and "/{path*}" captures the rest of the path (slashes included).

Uses 4

Http Args Method Policy

Used by 53 (show)

Admin\AppController Admin\BundleController Admin\EditorController Admin\LanguageController Admin\OverviewController Admin\PackagesController Admin\PreferencesController Admin\RenderController Admin\SessionsController Admin\SiteController Admin\StructureController Admin\SystemController Admin\ThemesController Admin\UpdatesController Admin\V1Controller Front\AssetsController Front\CommentPostController Front\FrontController Front\ProbeController Front\SitemapController Matched RouteRow Router Login\LoginController Rest\ApplicationPasswordsController Rest\ArgCheck Rest\BatchController Rest\BlockRendererController Rest\BlockTypesController Rest\BlocksController Rest\Catalogue Rest\CommentsController Rest\DeclaredPostsController Rest\DeclaredTermsController Rest\GlobalStylesController Rest\IndexController Rest\InstalledThemesController Rest\MediaController Rest\MenusController Rest\NavigationController Rest\PluginsController Rest\PostsController Rest\PostsWriteController Rest\RevisionsController Rest\SearchController Rest\SettingsController Rest\SidebarsController Rest\StatusesController Rest\TemplatesController Rest\TermsController Rest\UsersController Rest\WidgetsController Runtime\AjaxController

Constants and properties

prop	`readonly Minn\Http\Method $method`	Promoted from the constructor.
prop	`readonly string $pattern`	Promoted from the constructor.
prop	`readonly ?Minn\Http\Policy $policy`	Promoted from the constructor.
prop	`readonly array $args`	Promoted from the constructor.
prop	`readonly bool $index`	Promoted from the constructor.
prop	`readonly array $body`	Promoted from the constructor.
prop	`readonly ?string $name`	Promoted from the constructor.
prop	`readonly ?string $params`	Promoted from the constructor.
prop	`readonly ?string $refuse`	Promoted from the constructor.

Public

new

__construct(Minn\Http\Method $method, string $pattern, ?Minn\Http\Policy $policy = NULL, array $args = array ( ), bool $index = true, array $body = array ( ), ?string $name = NULL, ?string $params = NULL, ?string $refuse = NULL)

`$args`	`list<array<string, array<string, mixed>>>`	the parameter sets this route reads, from Args
`$index`	`bool`	whether the route is listed in the REST index (a route the index spells itself is not)
`$body`	`list<array<string, array<string, mixed>>>`	the parameter sets this route reads from the JSON body, from Args or the shape that owns them
`$name`	`string\|null`	the route's name in the catalogue; the handler's Class::method when null
`$params`	`class-string<RouteParams>\|null`	the parameters' source when they depend on the captures; $args otherwise
`$refuse`	`class-string<Refusal>\|null`	a refusal judged after the arguments and before the policy

method

arguments(array $captures = array ( )): array#

The parameters this route accepts, as the REST index publishes them: from its params source for these captures (a capture the pattern fixes, such as {base:posts}, counts when none is given), or its fixed sets.

$captures array<string, string>

@return array<string, array<string, mixed>>

method

bodyArguments(): array#

The parameters this route reads from the JSON body, validated before the caller is judged.

@return array<string, array<string, mixed>>

method

regex(): string#

The pattern as a regular expression with named captures.