IRoute
Interface IRoute
Tags
Table of Contents
- action() : IRoute
- The action to execute when this route matches
- actionInclude() : void
- The action to execute when this route matches, includes a file like it is called directly
- defaults() : IRoute
- Defaults to use for this route
- delete() : IRoute
- Specify DELETE as the method to use with this route
- get() : IRoute
- Specify GET as the method to use with this route
- method() : IRoute
- Specify the method when this route is to be used
- patch() : IRoute
- Specify PATCH as the method to use with this route
- post() : IRoute
- Specify POST as the method to use with this route
- put() : IRoute
- Specify PUT as the method to use with this route
- requirements() : IRoute
- Requirements for this route
Methods
action()
The action to execute when this route matches
public
action(string|callable $class[, string $function = null ]) : IRoute
Parameters
- $class : string|callable
-
the class or a callable
- $function : string = null
-
the function to use with the class
Tags
Return values
IRoute —This function is called with $class set to a callable or to the class with $function
actionInclude()
The action to execute when this route matches, includes a file like it is called directly
public
actionInclude(string $file) : void
Parameters
- $file : string
Tags
defaults()
Defaults to use for this route
public
defaults(array $defaults) : IRoute
Parameters
- $defaults : array
-
The defaults
Tags
Return values
IRoute —delete()
Specify DELETE as the method to use with this route
public
delete() : IRoute
Tags
Return values
IRoute —get()
Specify GET as the method to use with this route
public
get() : IRoute
Tags
Return values
IRoute —method()
Specify the method when this route is to be used
public
method(string $method) : IRoute
Parameters
- $method : string
-
HTTP method (uppercase)
Tags
Return values
IRoute —patch()
Specify PATCH as the method to use with this route
public
patch() : IRoute
Tags
Return values
IRoute —post()
Specify POST as the method to use with this route
public
post() : IRoute
Tags
Return values
IRoute —put()
Specify PUT as the method to use with this route
public
put() : IRoute
Tags
Return values
IRoute —requirements()
Requirements for this route
public
requirements(array $requirements) : IRoute
Parameters
- $requirements : array
-
The requirements