W3cubDocs

/Laravel 8

PendingResourceRegistration

class PendingResourceRegistration (View source)

Traits

CreatesRegularExpressionRouteConstraints
Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected ResourceRegistrar $registrar The resource registrar.
protected string $name The resource name.
protected string $controller The resource controller.
protected array $options The resource options.
protected bool $registered The resource's registration status.

Methods

$this whereAlpha(array|string $parameters)

Specify that the given route parameters must be alphabetic.

 from CreatesRegularExpressionRouteConstraints
$this whereAlphaNumeric(array|string $parameters)

Specify that the given route parameters must be alphanumeric.

 from CreatesRegularExpressionRouteConstraints
$this whereNumber(array|string $parameters)

Specify that the given route parameters must be numeric.

 from CreatesRegularExpressionRouteConstraints
$this whereUuid(array|string $parameters)

Specify that the given route parameters must be UUIDs.

 from CreatesRegularExpressionRouteConstraints
$this assignExpressionToParameters(array|string $parameters, string $expression)

Apply the given regular expression to the given parameters.

 from CreatesRegularExpressionRouteConstraints
static void macro(string $name, object|callable $macro)

Register a custom macro.

 from Macroable
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

 from Macroable
static bool hasMacro(string $name)

Checks if macro is registered.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
void __construct(ResourceRegistrar $registrar, string $name, string $controller, array $options)

Create a new pending resource registration instance.
PendingResourceRegistration only(array|string|dynamic $methods)

Set the methods the controller should apply to.
PendingResourceRegistration except(array|string|dynamic $methods)

Set the methods the controller should exclude.
PendingResourceRegistration names(array|string $names)

Set the route names for controller actions.
PendingResourceRegistration name(string $method, string $name)

Set the route name for a controller action.
PendingResourceRegistration parameters(array|string $parameters)

Override the route parameter names.
PendingResourceRegistration parameter(string $previous, string $new)

Override a route parameter's name.
PendingResourceRegistration middleware(mixed $middleware)

Add middleware to the resource routes.
$this|array withoutMiddleware(array|string $middleware)

Specify middleware that should be removed from the resource routes.
PendingResourceRegistration where(mixed $wheres)

Add "where" constraints to the resource routes.
PendingResourceRegistration shallow(bool $shallow = true)

Indicate that the resource routes should have "shallow" nesting.
PendingResourceRegistration scoped(array $fields = [])

Indicate that the resource routes should be scoped using the given binding fields.
RouteCollection register()

Register the resource route.
void __destruct()

Handle the object's destruction.

Details

$this whereAlpha(array|string $parameters)

Specify that the given route parameters must be alphabetic.

Parameters

array|string $parameters

Return Value

$this

$this whereAlphaNumeric(array|string $parameters)

Specify that the given route parameters must be alphanumeric.

Parameters

array|string $parameters

Return Value

$this

$this whereNumber(array|string $parameters)

Specify that the given route parameters must be numeric.

Parameters

array|string $parameters

Return Value

$this

$this whereUuid(array|string $parameters)

Specify that the given route parameters must be UUIDs.

Parameters

array|string $parameters

Return Value

$this

protected $this assignExpressionToParameters(array|string $parameters, string $expression)

Apply the given regular expression to the given parameters.

Parameters

array|string $parameters
string $expression

Return Value

$this

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(ResourceRegistrar $registrar, string $name, string $controller, array $options)

Create a new pending resource registration instance.

Parameters

ResourceRegistrar $registrar
string $name
string $controller
array $options

Return Value

void

PendingResourceRegistration only(array|string|dynamic $methods)

Set the methods the controller should apply to.

Parameters

array|string|dynamic $methods

Return Value

PendingResourceRegistration

PendingResourceRegistration except(array|string|dynamic $methods)

Set the methods the controller should exclude.

Parameters

array|string|dynamic $methods

Return Value

PendingResourceRegistration

PendingResourceRegistration names(array|string $names)

Set the route names for controller actions.

Parameters

array|string $names

Return Value

PendingResourceRegistration

PendingResourceRegistration name(string $method, string $name)

Set the route name for a controller action.

Parameters

string $method
string $name

Return Value

PendingResourceRegistration

PendingResourceRegistration parameters(array|string $parameters)

Override the route parameter names.

Parameters

array|string $parameters

Return Value

PendingResourceRegistration

PendingResourceRegistration parameter(string $previous, string $new)

Override a route parameter's name.

Parameters

string $previous
string $new

Return Value

PendingResourceRegistration

PendingResourceRegistration middleware(mixed $middleware)

Add middleware to the resource routes.

Parameters

mixed $middleware

Return Value

PendingResourceRegistration

$this|array withoutMiddleware(array|string $middleware)

Specify middleware that should be removed from the resource routes.

Parameters

array|string $middleware

Return Value

$this|array

PendingResourceRegistration where(mixed $wheres)

Add "where" constraints to the resource routes.

Parameters

mixed $wheres

Return Value

PendingResourceRegistration

PendingResourceRegistration shallow(bool $shallow = true)

Indicate that the resource routes should have "shallow" nesting.

Parameters

bool $shallow

Return Value

PendingResourceRegistration

PendingResourceRegistration scoped(array $fields = [])

Indicate that the resource routes should be scoped using the given binding fields.

Parameters

array $fields

Return Value

PendingResourceRegistration

RouteCollection register()

Register the resource route.

Return Value

RouteCollection

void __destruct()

Handle the object's destruction.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Routing/PendingResourceRegistration.html