rex_url
in package
Utility class to generate relative URLs.
Tags
Table of Contents
Properties
Methods
- addonAssets() : non-empty-string
- Returns the url to the assets folder of the given addon, which contains all assets required by the addon to work properly.
- assets() : non-empty-string
- Returns the url to the assets folder.
- backend() : non-empty-string
- Returns the url to the backend.
- backendController() : non-empty-string
- Returns the url to the backend-controller (index.php from backend).
- backendPage() : non-empty-string
- Returns the url to a backend page.
- base() : non-empty-string
- Returns a base url.
- coreAssets() : non-empty-string
- Returns the url to the assets folder of the core, which contains all assets required by the core to work properly.
- currentBackendPage() : non-empty-string
- Returns the url to the current backend page.
- frontend() : non-empty-string
- Returns the url to the frontend.
- frontendController() : non-empty-string
- Returns the url to the frontend-controller (index.php from frontend).
- init() : void
- Initializes the class.
- media() : non-empty-string
- Returns the url to the media-folder.
- pluginAssets() : non-empty-string
- Returns the url to the assets folder of the given plugin of the given addon.
Properties
$pathprovider
protected
static rex_path_default_provider
$pathprovider
Methods
addonAssets()
Returns the url to the assets folder of the given addon, which contains all assets required by the addon to work properly.
public
static addonAssets(string $addon[, string $file = '' ]) : non-empty-string
Parameters
- $addon : string
-
Addon
- $file : string = ''
-
File
Tags
Return values
non-empty-stringassets()
Returns the url to the assets folder.
public
static assets([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringbackend()
Returns the url to the backend.
public
static backend([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringbackendController()
Returns the url to the backend-controller (index.php from backend).
public
static backendController([array<string|int, mixed> $params = [] ][, bool $escape = true ]) : non-empty-string
Parameters
- $params : array<string|int, mixed> = []
-
Params
- $escape : bool = true
-
Flag whether the argument separator "&" should be escaped (&)
Return values
non-empty-stringbackendPage()
Returns the url to a backend page.
public
static backendPage(string $page[, array<string|int, mixed> $params = [] ][, bool $escape = true ]) : non-empty-string
Parameters
- $page : string
-
Page
- $params : array<string|int, mixed> = []
-
Params
- $escape : bool = true
-
Flag whether the argument separator "&" should be escaped (&)
Return values
non-empty-stringbase()
Returns a base url.
public
static base([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringcoreAssets()
Returns the url to the assets folder of the core, which contains all assets required by the core to work properly.
public
static coreAssets([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringcurrentBackendPage()
Returns the url to the current backend page.
public
static currentBackendPage([array<string|int, mixed> $params = [] ][, bool $escape = true ]) : non-empty-string
Parameters
- $params : array<string|int, mixed> = []
-
Params
- $escape : bool = true
-
Flag whether the argument separator "&" should be escaped (&)
Return values
non-empty-stringfrontend()
Returns the url to the frontend.
public
static frontend([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringfrontendController()
Returns the url to the frontend-controller (index.php from frontend).
public
static frontendController([array<string|int, mixed> $params = [] ][, bool $escape = true ]) : non-empty-string
Parameters
- $params : array<string|int, mixed> = []
-
Params
- $escape : bool = true
-
Flag whether the argument separator "&" should be escaped (&)
Return values
non-empty-stringinit()
Initializes the class.
public
static init(rex_path_default_provider $pathprovider) : void
Parameters
- $pathprovider : rex_path_default_provider
-
A path provider
media()
Returns the url to the media-folder.
public
static media([string $file = '' ]) : non-empty-string
Parameters
- $file : string = ''
-
File
Return values
non-empty-stringpluginAssets()
Returns the url to the assets folder of the given plugin of the given addon.
public
static pluginAssets(string $addon, string $plugin[, string $file = '' ]) : non-empty-string
Parameters
- $addon : string
-
Addon
- $plugin : string
-
Plugin
- $file : string = ''
-
File