PHP Class phpbb\routing\router

Inheritance: implements Symfony\Component\Routing\RouterInterface

Mostra file Open project: phpbb/phpbb Class Usage Examples

Protected Properties

Property	Type	Description
$context	Symfony\Component\Routing\RequestContext
$environment	string	Name of the current environment
$extension_manager	phpbb\extension\manager	Extension manager
$filesystem	phpbb\filesystem\filesystem_interface
$generator	Symfony\Component\Routing\Generator\UrlGeneratorInterface \| null
$matcher	Symfony\Component\Routing\Matcher\UrlMatcherInterface \| null
$php_ext	string	PHP file extensions
$phpbb_root_path	string	phpBB root path
$route_collection	Symfony\Component\Routing\RouteCollection \| null
$routing_files	array	YAML file(s) containing route information

Public Methods

Method	Description
__construct ( phpbb\filesystem\filesystem_interface $filesystem, string $phpbb_root_path, string $php_ext, string $environment, phpbb\extension\manager $extension_manager = null, array $routing_files = [] )	Construct method
find ( string $base_path = '' ) : router	Find a list of controllers
find_routing_files ( array $paths ) : router	Find the list of routing files
generate ( $name, $parameters = [], $referenceType = self::ABSOLUTE_PATH )
getContext ( )
getRouteCollection ( )
get_generator ( ) : Symfony\Component\Routing\Generator\UrlGeneratorInterface	Gets the UrlGenerator instance associated with this Router.
get_matcher ( ) : Symfony\Component\Routing\Matcher\UrlMatcherInterface	Gets the UrlMatcher instance associated with this Router.
get_routes ( ) : RouteCollection	Get the list of routes
match ( $pathinfo )
setContext ( Symfony\Component\Routing\RequestContext $context )

Protected Methods

Method	Description
create_dumped_url_generator ( )	Creates a new dumped URL Generator (dump it if necessary)
create_dumped_url_matcher ( )	Creates a new dumped URL Matcher (dump it if necessary)
create_new_url_generator ( )	Creates a new URL Generator
create_new_url_matcher ( )	Creates a new URL Matcher

Method Details

__construct() public method

Construct method

public __construct ( phpbb\filesystem\filesystem_interface $filesystem, string $phpbb_root_path, string $php_ext, string $environment, phpbb\extension\manager $extension_manager = null, array $routing_files = [] )
$filesystem	phpbb\filesystem\filesystem_interface	Filesystem helper
$phpbb_root_path	string	phpBB root path
$php_ext	string	PHP file extension
$environment	string	Name of the current environment
$extension_manager	phpbb\extension\manager	Extension manager
$routing_files	array	Array of strings containing paths to YAML files holding route information

create_dumped_url_generator() protected method

Creates a new dumped URL Generator (dump it if necessary)

protected create_dumped_url_generator ( )

create_dumped_url_matcher() protected method

Creates a new dumped URL Matcher (dump it if necessary)

protected create_dumped_url_matcher ( )

create_new_url_generator() protected method

Creates a new URL Generator

protected create_new_url_generator ( )

create_new_url_matcher() protected method

Creates a new URL Matcher

protected create_new_url_matcher ( )

find() public method

Find a list of controllers

public find ( string $base_path = '' ) : router
$base_path	string	Base path to prepend to file paths
return	router

find_routing_files() public method

Find the list of routing files

public find_routing_files ( array $paths ) : router
$paths	array	Array of paths where to look for routing files (they must be relative to the phpBB root path).
return	router

generate() public method

public generate ( $name, $parameters = [], $referenceType = self::ABSOLUTE_PATH )

getContext() public method

public getContext ( )

getRouteCollection() public method

public getRouteCollection ( )

get_generator() public method

Gets the UrlGenerator instance associated with this Router.

public get_generator ( ) : Symfony\Component\Routing\Generator\UrlGeneratorInterface
return	Symfony\Component\Routing\Generator\UrlGeneratorInterface	A UrlGeneratorInterface instance

get_matcher() public method

Gets the UrlMatcher instance associated with this Router.

public get_matcher ( ) : Symfony\Component\Routing\Matcher\UrlMatcherInterface
return	Symfony\Component\Routing\Matcher\UrlMatcherInterface	A UrlMatcherInterface instance

get_routes() public method

Get the list of routes

public get_routes ( ) : RouteCollection
return	Symfony\Component\Routing\RouteCollection	Get the route collection

match() public method

public match ( $pathinfo )

setContext() public method

public setContext ( Symfony\Component\Routing\RequestContext $context )
$context	Symfony\Component\Routing\RequestContext

Property Details

$context protected_oe property

protected RequestContext,Symfony\Component\Routing $context
return	Symfony\Component\Routing\RequestContext

$environment protected_oe property

Name of the current environment

protected string $environment
return	string

$extension_manager protected_oe property

Extension manager

protected manager,phpbb\extension $extension_manager
return	phpbb\extension\manager

$filesystem protected_oe property

protected filesystem_interface,phpbb\filesystem $filesystem
return	phpbb\filesystem\filesystem_interface

$generator protected_oe property

protected UrlGeneratorInterface,Symfony\Component\Routing\Generator\|null $generator
return	Symfony\Component\Routing\Generator\UrlGeneratorInterface \| null

$matcher protected_oe property

protected UrlMatcherInterface,Symfony\Component\Routing\Matcher\|null $matcher
return	Symfony\Component\Routing\Matcher\UrlMatcherInterface \| null

$php_ext protected_oe property

PHP file extensions

protected string $php_ext
return	string

$phpbb_root_path protected_oe property

phpBB root path

protected string $phpbb_root_path
return	string

$route_collection protected_oe property

protected RouteCollection,Symfony\Component\Routing\|null $route_collection
return	Symfony\Component\Routing\RouteCollection \| null

$routing_files protected_oe property

YAML file(s) containing route information

protected array $routing_files
return	array