[ Index ]

PHP Cross Reference of phpBB-3.3.5-deutsch

title

Body

[close]

/vendor/symfony/routing/ -> RouteCollectionBuilder.php (summary)

(no description)

File Size: 377 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

RouteCollectionBuilder:: (17 methods):
  __construct()
  import()
  add()
  createBuilder()
  mount()
  addRoute()
  setHost()
  setCondition()
  setDefault()
  setRequirement()
  setOption()
  setSchemes()
  setMethods()
  addResource()
  build()
  generateRouteName()
  load()


Class: RouteCollectionBuilder  - X-Ref

Helps add and import routes into a RouteCollection.

__construct(LoaderInterface $loader = null)   X-Ref


import($resource, $prefix = '/', $type = null)   X-Ref
Import an external routing resource and returns the RouteCollectionBuilder.

$routes->import('blog.yml', '/blog');

param: mixed       $resource
param: string|null $prefix
param: string      $type
return: self

add($path, $controller, $name = null)   X-Ref
Adds a route and returns it for future modification.

param: string      $path       The route path
param: string      $controller The route's controller
param: string|null $name       The name to give this route
return: Route

createBuilder()   X-Ref
Returns a RouteCollectionBuilder that can be configured and then added with mount().

return: self

mount($prefix, self $builder)   X-Ref
Add a RouteCollectionBuilder.

param: string                 $prefix
param: RouteCollectionBuilder $builder

addRoute(Route $route, $name = null)   X-Ref
Adds a Route object to the builder.

param: string|null $name
return: $this

setHost($pattern)   X-Ref
Sets the host on all embedded routes (unless already set).

param: string $pattern
return: $this

setCondition($condition)   X-Ref
Sets a condition on all embedded routes (unless already set).

param: string $condition
return: $this

setDefault($key, $value)   X-Ref
Sets a default value that will be added to all embedded routes (unless that
default value is already set).

param: string $key
param: mixed  $value
return: $this

setRequirement($key, $regex)   X-Ref
Sets a requirement that will be added to all embedded routes (unless that
requirement is already set).

param: string $key
param: mixed  $regex
return: $this

setOption($key, $value)   X-Ref
Sets an option that will be added to all embedded routes (unless that
option is already set).

param: string $key
param: mixed  $value
return: $this

setSchemes($schemes)   X-Ref
Sets the schemes on all embedded routes (unless already set).

param: array|string $schemes
return: $this

setMethods($methods)   X-Ref
Sets the methods on all embedded routes (unless already set).

param: array|string $methods
return: $this

addResource(ResourceInterface $resource)   X-Ref
Adds a resource for this collection.

return: $this

build()   X-Ref
Creates the final RouteCollection and returns it.

return: RouteCollection

generateRouteName(Route $route)   X-Ref
Generates a route name based on details of this route.

return: string

load($resource, $type = null)   X-Ref
Finds a loader able to load an imported resource and loads it.

param: mixed       $resource A resource
param: string|null $type     The resource type or null if unknown
return: RouteCollection[]



Generated: Mon Oct 4 17:42:11 2021 Cross-referenced by PHPXref 0.7.1