[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

/phpbb/install/controller/ -> helper.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 413 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

helper:: (10 methods):
  __construct()
  render()
  route()
  handle_language_select()
  handle_navigation()
  page_header()
  render_navigation()
  render_language_select()
  get_active_main_menu()
  sort_navigation_level()


Class: helper  - X-Ref

A duplicate of \phpbb\controller\helper

This class is necessary because of controller\helper's legacy function calls
to page_header() page_footer() functions which has unavailable dependencies.
__construct(config $config, language $language, language_file_helper $lang_helper, navigation_provider $nav, template $template, path_helper $path_helper, request $phpbb_request, symfony_request $request, router $router, $phpbb_root_path)   X-Ref
Constructor

param: config                $config
param: language                $language
param: language_file_helper    $lang_helper
param: navigation_provider    $nav
param: template                $template
param: path_helper            $path_helper
param: request                $phpbb_request
param: symfony_request        $request
param: router                $router
param: string                $phpbb_root_path

render($template_file, $page_title = '', $selected_language = false, $status_code = 200)   X-Ref
Automate setting up the page and creating the response object.

return: Response object containing rendered page
param: string    $template_file        The template handle to render
param: string    $page_title            The title of the page to output
param: bool        $selected_language    True to enable language selector it, false otherwise
param: int        $status_code        The status code to be sent to the page header

route($route_name, $parameters = array()   X-Ref
Returns path from route name

return: string
param: string    $route_name
param: array        $parameters

handle_language_select()   X-Ref
Handles language selector form


handle_navigation($iohandler = null)   X-Ref
Process navigation data to reflect active/completed stages

param: \phpbb\install\helper\iohandler\iohandler_interface|null    $iohandler

page_header($page_title, $selected_language = false)   X-Ref
Set default template variables

param: string    $page_title            Title of the page
param: bool        $selected_language    True to enable language selector it, false otherwise

render_navigation()   X-Ref
Render navigation


render_language_select($selected_language = null)   X-Ref
Render language select form

param: string    $selected_language

get_active_main_menu($nav_array)   X-Ref
Returns the name of the active main menu item

return: string|bool    Returns the name of the active main menu element, if the element not found, returns false
param: array    $nav_array

sort_navigation_level($nav_array)   X-Ref
Sorts the top level of navigation array

return: array
param: array    $nav_array    Navigation array



Generated: Tue Apr 7 19:44:41 2020 Cross-referenced by PHPXref 0.7.1