1. class
  2. phpbb
  3. \
  4. routing
  5. \
  6. helper

helper

class helper

Controller helper class, contains methods that do things for controllers

Properties

protected config $config

config object
protected router $router

phpBB router
protected symfony_request $symfony_request
protected request_interface $request
protected filesystem $filesystem
protected string $phpbb_root_path

phpBB root path
protected string $php_ext

PHP file extension

Methods

__construct(config $config, router $router, symfony_request $symfony_request, request_interface $request, filesystem $filesystem, string $phpbb_root_path, string $php_ext)

Constructor

string
route(string $route, array $params = array(), bool $is_amp = true, string|bool $session_id = false, bool|string $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL to a route

Details

at line 74
__construct(config $config, router $router, symfony_request $symfony_request, request_interface $request, filesystem $filesystem, string $phpbb_root_path, string $php_ext)

Constructor

Parameters

config $config

Config object
router $router

phpBB router
symfony_request $symfony_request

Symfony Request object
request_interface $request

phpBB request object
filesystem $filesystem

The filesystem object
string $phpbb_root_path

phpBB root path
string $php_ext

PHP file extension

at line 95
string route(string $route, array $params = array(), bool $is_amp = true, string|bool $session_id = false, bool|string $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL to a route

Parameters

string $route

Name of the route to travel
array $params

String or array of additional url parameters
bool $is_amp

Is url using & (true) or & (false)
string|bool $session_id

Possibility to use a custom session id instead of the global one
bool|string $reference_type

The type of reference to be generated (one of the constants)

Return Value

string

The URL already passed through append_sid()