1. class
  2. WPEmerge
  3. \
  4. Routing
  5. \
  6. RouteBlueprint

RouteBlueprint

class RouteBlueprint (View source)

Provide a fluent interface for registering routes with the router.

Traits

HasAttributesTrait
Represent an object which has an array of attributes.

Methods

mixed
getAttribute(string $attribute, mixed $default = '')

Get attribute.

from HasAttributesTrait
array
getAttributes()

Get all attributes.

from HasAttributesTrait
void
setAttribute(string $attribute, mixed $value)

Set attribute.

from HasAttributesTrait
HasAttributesTrait
attribute(string $attribute, mixed $value)

Fluent alias for setAttribute().

from HasAttributesTrait
void
setAttributes(array $attributes)

Set all attributes.

from HasAttributesTrait
HasAttributesTrait
attributes(array $attributes)

Fluent alias for setAttributes().

from HasAttributesTrait
__construct(Router $router, ViewService $view_service)

Constructor.

RouteBlueprint
methods(string[] $methods)

Match requests using one of the specified methods.

RouteBlueprint
url(string $url, array $where = [])

Set the condition attribute to a URL.

RouteBlueprint
where($condition)

Set the condition attribute.

RouteBlueprint
middleware(string|string[] $middleware)

Set the middleware attribute.

RouteBlueprint
setNamespace(string $namespace)

Set the namespace attribute.

RouteBlueprint
query(callable $query)

Set the query attribute.

RouteBlueprint
name(string $name)

Set the name attribute.

void
group(Closure|string $routes)

Create a route group.

void
handle(string|Closure $handler = '')

Create a route.

void
view(string|string[] $views)

Handle a request by directly rendering a view.

void
all(string|Closure $handler = '')

Match ALL requests.

RouteBlueprint
get()

Match requests with a method of GET or HEAD.

RouteBlueprint
post()

Match requests with a method of POST.

RouteBlueprint
put()

Match requests with a method of PUT.

RouteBlueprint
patch()

Match requests with a method of PATCH.

RouteBlueprint
delete()

Match requests with a method of DELETE.

RouteBlueprint
options()

Match requests with a method of OPTIONS.

RouteBlueprint
any()

Match requests with any method.

Details

in HasAttributesTrait at line 32
mixed getAttribute(string $attribute, mixed $default = '')

Get attribute.

Parameters

string $attribute
mixed $default

Return Value

mixed

in HasAttributesTrait at line 41
array getAttributes()

Get all attributes.

Return Value

array mixed>

in HasAttributesTrait at line 52
void setAttribute(string $attribute, mixed $value)

Set attribute.

Parameters

string $attribute
mixed $value

Return Value

void

in HasAttributesTrait at line 67
HasAttributesTrait attribute(string $attribute, mixed $value)

Fluent alias for setAttribute().

Parameters

string $attribute
mixed $value

Return Value

HasAttributesTrait $this

in HasAttributesTrait at line 80
void setAttributes(array $attributes)

Set all attributes.

No attempt to merge attributes is done - this is a direct overwrite operation.

Parameters

array $attributes mixed> $attributes

Return Value

void

in HasAttributesTrait at line 91
HasAttributesTrait attributes(array $attributes)

Fluent alias for setAttributes().

Parameters

array $attributes mixed> $attributes

Return Value

HasAttributesTrait $this

at line 44
__construct(Router $router, ViewService $view_service)

Constructor.

Parameters

Router $router
ViewService $view_service

at line 55
RouteBlueprint methods(string[] $methods)

Match requests using one of the specified methods.

Parameters

string[] $methods

Return Value

RouteBlueprint $this

at line 71
RouteBlueprint url(string $url, array $where = [])

Set the condition attribute to a URL.

Parameters

string $url
array $where string> $where

Return Value

RouteBlueprint $this

at line 82
RouteBlueprint where($condition)

Set the condition attribute.

Parameters

$condition

Return Value

RouteBlueprint $this

at line 101
RouteBlueprint middleware(string|string[] $middleware)

Set the middleware attribute.

Parameters

string|string[] $middleware

Return Value

RouteBlueprint $this

at line 118
RouteBlueprint setNamespace(string $namespace)

Set the namespace attribute.

This should be renamed to namespace for consistency once minimum PHP version is increased to 7+.

Parameters

string $namespace

Return Value

RouteBlueprint $this

at line 133
RouteBlueprint query(callable $query)

Set the query attribute.

Parameters

callable $query

Return Value

RouteBlueprint $this

at line 148
RouteBlueprint name(string $name)

Set the name attribute.

Parameters

string $name

Return Value

RouteBlueprint $this

at line 158
void group(Closure|string $routes)

Create a route group.

Parameters

Closure|string $routes Closure or path to file.

Return Value

void

at line 168
void handle(string|Closure $handler = '')

Create a route.

Parameters

string|Closure $handler

Return Value

void

at line 190
void view(string|string[] $views)

Handle a request by directly rendering a view.

Parameters

string|string[] $views

Return Value

void

at line 202
void all(string|Closure $handler = '')

Match ALL requests.

Parameters

string|Closure $handler

Return Value

void

at line 211
RouteBlueprint get()

Match requests with a method of GET or HEAD.

Return Value

RouteBlueprint $this

at line 220
RouteBlueprint post()

Match requests with a method of POST.

Return Value

RouteBlueprint $this

at line 229
RouteBlueprint put()

Match requests with a method of PUT.

Return Value

RouteBlueprint $this

at line 238
RouteBlueprint patch()

Match requests with a method of PATCH.

Return Value

RouteBlueprint $this

at line 247
RouteBlueprint delete()

Match requests with a method of DELETE.

Return Value

RouteBlueprint $this

at line 256
RouteBlueprint options()

Match requests with a method of OPTIONS.

Return Value

RouteBlueprint $this

at line 265
RouteBlueprint any()

Match requests with any method.

Return Value

RouteBlueprint $this