\rex_path_default_provider

Utility class to generate absolute paths.

Summary

Methods
Properties
Constants
__construct()
base()
frontend()
frontendController()
backend()
backendController()
media()
assets()
coreAssets()
addonAssets()
pluginAssets()
bin()
data()
coreData()
addonData()
pluginData()
log()
cache()
coreCache()
addonCache()
pluginCache()
src()
core()
addon()
plugin()
No public properties found
No constants found
No protected methods found
$base
$backend
$provideAbsolutes
N/A
No private methods found
No private properties found
N/A

Properties

$base

$base : string

Type

string

$backend

$backend : string

Type

string

$provideAbsolutes

$provideAbsolutes : bool

Type

bool

Methods

__construct()

__construct(string  $htdocs, string  $backend, bool  $provideAbsolutes) : mixed

Initializes the class.

Parameters

string $htdocs

Htdocs path

string $backend

Backend folder name

bool $provideAbsolutes

Flag whether to return absolute path, or relative ones

Returns

mixed —

base()

base(string  $file) : string

Returns the base/root path.

Parameters

string $file

File

Returns

string —

frontend()

frontend(string  $file) : string

Returns the path to the frontend (the document root).

Parameters

string $file

File

Returns

string —

frontendController()

frontendController() : string

Returns the path to the frontend-controller (index.php from frontend).

Returns

string —

backend()

backend(string  $file) : string

Returns the path to the backend (folder where the backend controller is placed).

Parameters

string $file

File

Returns

string —

backendController()

backendController() : string

Returns the path to the backend-controller (index.php from backend).

Returns

string —

media()

media(string  $file) : string

Returns the path to the media-folder.

Parameters

string $file

File

Returns

string —

assets()

assets(string  $file) : string

Returns the path to the assets folder.

Parameters

string $file

File

Returns

string —

coreAssets()

coreAssets(string  $file) : string

Returns the path to the assets folder of the core, which contains all assets required by the core to work properly.

Parameters

string $file

File

Returns

string —

addonAssets()

addonAssets(string  $addon, string  $file) : string

Returns the path to the assets folder of the given addon, which contains all assets required by the addon to work properly.

Parameters

string $addon

Addon

string $file

File

Returns

string —

pluginAssets()

pluginAssets(string  $addon, string  $plugin, string  $file) : string

Returns the path to the assets folder of the given plugin of the given addon.

Parameters

string $addon

Addon

string $plugin

Plugin

string $file

File

Returns

string —

bin()

bin(string  $file) : string

Returns the path to the bin folder.

Parameters

string $file

File

Returns

string —

data()

data(string  $file) : string

Returns the path to the data folder.

Parameters

string $file

File

Returns

string —

coreData()

coreData(string  $file) : string

Returns the path to the data folder of the core.

Parameters

string $file

File

Returns

string —

addonData()

addonData(string  $addon, string  $file) : string

Returns the path to the data folder of the given addon.

Parameters

string $addon

Addon

string $file

File

Returns

string —

pluginData()

pluginData(string  $addon, string  $plugin, string  $file) : string

Returns the path to the data folder of the given plugin of the given addon.

Parameters

string $addon

Addon

string $plugin

Plugin

string $file

File

Returns

string —

log()

log(string  $file) : string

Returns the path to the log folder.

Parameters

string $file

Returns

string —

cache()

cache(string  $file) : string

Returns the path to the cache folder.

Parameters

string $file

File

Returns

string —

coreCache()

coreCache(string  $file) : string

Returns the path to the cache folder of the core.

Parameters

string $file

File

Returns

string —

addonCache()

addonCache(string  $addon, string  $file) : string

Returns the path to the cache folder of the given addon.

Parameters

string $addon

Addon

string $file

File

Returns

string —

pluginCache()

pluginCache(string  $addon, string  $plugin, string  $file) : string

Returns the path to the cache folder of the given plugin.

Parameters

string $addon

Addon

string $plugin

Plugin

string $file

File

Returns

string —

src()

src(string  $file) : string

Returns the path to the src folder.

Parameters

string $file

File

Returns

string —

core()

core(string  $file) : string

Returns the path to the actual core.

Parameters

string $file

File

Returns

string —

addon()

addon(string  $addon, string  $file) : string

Returns the base path to the folder of the given addon.

Parameters

string $addon

Addon

string $file

File

Returns

string —

plugin()

plugin(string  $addon, string  $plugin, string  $file) : string

Returns the base path to the folder of the plugin of the given addon.

Parameters

string $addon

Addon

string $plugin

Plugin

string $file

File

Returns

string —