Class Route

Constants summary

• array
  VALID_METHODS ¶
  ['GET','PUT','POST','PATCH','DELETE','OPTIONS','HEAD']

Properties summary

• $_compiledRoute protected
  string|null
  The compiled route regular expression
• $_extensions protected
  string[]
  List of connected extensions for this route.
• $_greedy protected
  boolean

  Is this route a greedy route? Greedy routes have a /* in their template

• $_name protected
  string|null
  The name for a route. Fetch with Route::getName();
• $braceKeys protected
  boolean
  Track whether or not brace keys {var} were used.
• $defaults public
  array
  Default parameters for a Route
• $keys public
  array

  An array of named segments in a Route. /:controller/:action/:id has 3 key elements

• $middleware protected
  array
  List of middleware that should be applied.
• $options public
  array
  An array of additional parameters for the Route.
• $template public
  string|null
  The routes template string.

Method Summary

• __construct() public

  Constructor for a Route

• __set_state() public static

  Set state magic method to support var_export

• _matchMethod() protected

  Check whether or not the URL's HTTP method matches.

• _parseArgs() protected

  Parse passed parameters into a list of passed args.

• _parseExtension() protected

  Removes the extension from $url if it contains a registered extension. If no registered extension is found, no extension is returned and the URL is returned unmodified.

• _persistParams() protected

  Apply persistent parameters to a URL array. Persistent parameters are a special key used during route creation to force route parameters to persist when omitted from a URL array.

• _writeRoute() protected

  Builds a route regular expression.

• _writeUrl() protected

  Converts a matching route array into a URL string.

• compile() public

  Compiles the route's regular expression.

• compiled() public

  Check if a Route has been compiled into a regular expression.

• extensions() public deprecated

  Get/Set the supported extensions for this route.

• getExtensions() public

  Get the supported extensions for this route.

• getMiddleware() public

  Get the names of the middleware that should be applied to this route.

• getName() public

  Get the standardized plugin.controller:action name for a route.

• hostMatches() public

  Check to see if the host matches the route requirements

• match() public

  Check if a URL array matches this route instance.

• parse() public deprecated

  Checks to see if the given URL can be parsed by this route.

• parseRequest() public

  Checks to see if the given URL can be parsed by this route.

• setExtensions() public

  Set the supported extensions for this route.

• setHost() public

  Set host requirement

• setMethods() public

  Set the accepted HTTP methods for this route.

• setMiddleware() public

  Set the names of the middleware that should be applied to this route.

• setPass() public

  Set the names of parameters that will be converted into passed parameters

• setPatterns() public

  Set regexp patterns for routing parameters

• setPersist() public

  Set the names of parameters that will persisted automatically

• staticPath() public

  Get the static path portion for this route.

Method Detail

// remove a persistent 'date' parameter
Router::url(['date' => false', ...]);

Properties detail

[]

false

false

[]

[]

[]

[]