[ Index ]

PHP Cross Reference of phpBB-3.1.10-deutsch

title

Body

[close]

/phpbb/ -> path_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: 492 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

path_helper:: (14 methods):
  __construct()
  get_phpbb_root_path()
  get_adm_relative_path()
  get_php_ext()
  update_web_root_path()
  remove_web_root_path()
  get_web_root_path()
  get_web_root_path_from_ajax_referer()
  clean_url()
  glue_url_params()
  get_url_parts()
  strip_url_params()
  append_url_params()
  get_valid_page()


Class: path_helper  - X-Ref

A class with various functions that are related to paths, files and the filesystem

__construct(\phpbb\symfony_request $symfony_request, \phpbb\filesystem $filesystem, \phpbb\request\request_interface $request, $phpbb_root_path, $php_ext, $adm_relative_path = null)   X-Ref
Constructor

param: \phpbb\symfony_request $symfony_request
param: \phpbb\filesystem $filesystem
param: \phpbb\request\request_interface $request
param: string $phpbb_root_path Relative path to phpBB root
param: string $php_ext PHP file extension
param: mixed $adm_relative_path Relative path admin path to adm/ root

get_phpbb_root_path()   X-Ref
Get the phpBB root path

return: string

get_adm_relative_path()   X-Ref
Get the adm root path

return: string

get_php_ext()   X-Ref
Get the php extension

return: string

update_web_root_path($path)   X-Ref
Update a web path to the correct relative root path

This replaces $phpbb_root_path . some_url with
get_web_root_path() . some_url

return: string
param: string $path The path to be updated

remove_web_root_path($path)   X-Ref
Strips away the web root path and prepends the normal root path

This replaces get_web_root_path() . some_url with
$phpbb_root_path . some_url

return: string
param: string $path The path to be updated

get_web_root_path()   X-Ref
Get a relative root path from the current URL

return: string

get_web_root_path_from_ajax_referer($absolute_referer_url, $absolute_board_url)   X-Ref
Get the web root path of the referer form an ajax request

return: string
param: string $absolute_referer_url
param: string $absolute_board_url

clean_url($url)   X-Ref
Eliminates useless . and .. components from specified URL

return: string Cleaned URL
param: string $url URL to clean

glue_url_params($params)   X-Ref
Glue URL parameters together

return: string Returns the glued string, e.g. name1=value1&name2&name3=value3
param: array $params URL parameters in the form of array(name => value)

get_url_parts($url, $is_amp = true)   X-Ref
Get the base and parameters of a URL

return: array Returns the base and parameters in the form of array('base' => string, 'params' => array(name => value))
param: string $url URL to break apart
param: bool $is_amp Is the parameter separator &. Defaults to true.

strip_url_params($url, $strip, $is_amp = true)   X-Ref
Strip parameters from an already built URL.

return: string Returns the new URL.
param: string $url URL to strip parameters from
param: array|string $strip Parameters to strip.
param: bool $is_amp Is the parameter separator &. Defaults to true.

append_url_params($url, $new_params, $is_amp = true)   X-Ref
Append parameters to an already built URL.

return: string Returns the new URL.
param: string $url URL to append parameters to
param: array $new_params Parameters to add in the form of array(name => value)
param: bool $is_amp Is the parameter separator &. Defaults to true.

get_valid_page($page, $mod_rewrite = false)   X-Ref
Get a valid page

return: string A valid page based on given page and mod_rewrite
param: string $page The page to verify
param: bool $mod_rewrite Whether mod_rewrite is enabled, default: false



Generated: Sun Feb 19 19:52:41 2017 Cross-referenced by PHPXref 0.7.1