Documentation

rex_path_default_provider
in package

Utility class to generate absolute paths.

Tags
author

gharlan

Table of Contents

Properties

$backend  : string
$base  : non-empty-string
$provideAbsolutes  : bool

Methods

__construct()  : mixed
Initializes the class.
addon()  : non-empty-string
Returns the base path to the folder of the given addon.
addonAssets()  : non-empty-string
Returns the path to the assets folder of the given addon, which contains all assets required by the addon to work properly.
addonCache()  : non-empty-string
Returns the path to the cache folder of the given addon.
addonData()  : non-empty-string
Returns the path to the data folder of the given addon.
assets()  : non-empty-string
Returns the path to the assets folder.
backend()  : non-empty-string
Returns the path to the backend (folder where the backend controller is placed).
backendController()  : non-empty-string
Returns the path to the backend-controller (index.php from backend).
base()  : non-empty-string
Returns the base/root path.
bin()  : non-empty-string
Returns the path to the bin folder.
cache()  : non-empty-string
Returns the path to the cache folder.
core()  : non-empty-string
Returns the path to the actual core.
coreAssets()  : non-empty-string
Returns the path to the assets folder of the core, which contains all assets required by the core to work properly.
coreCache()  : non-empty-string
Returns the path to the cache folder of the core.
coreData()  : non-empty-string
Returns the path to the data folder of the core.
data()  : non-empty-string
Returns the path to the data folder.
frontend()  : non-empty-string
Returns the path to the frontend (the document root).
frontendController()  : non-empty-string
Returns the path to the frontend-controller (index.php from frontend).
log()  : non-empty-string
Returns the path to the log folder.
media()  : non-empty-string
Returns the path to the media-folder.
plugin()  : non-empty-string
Returns the base path to the folder of the plugin of the given addon.
pluginAssets()  : non-empty-string
Returns the path to the assets folder of the given plugin of the given addon.
pluginCache()  : non-empty-string
Returns the path to the cache folder of the given plugin.
pluginData()  : non-empty-string
Returns the path to the data folder of the given plugin of the given addon.
src()  : non-empty-string
Returns the path to the src folder.

Properties

Methods

__construct()

Initializes the class.

public __construct(non-empty-string $htdocs, non-empty-string $backend, bool $provideAbsolutes) : mixed
Parameters
$htdocs : non-empty-string

Htdocs path

$backend : non-empty-string

Backend folder name

$provideAbsolutes : bool

Flag whether to return absolute path, or relative ones

addon()

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

public addon(non-empty-string $addon, string $file) : non-empty-string
Parameters
$addon : non-empty-string

Addon

$file : string

File

Return values
non-empty-string

addonAssets()

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

public addonAssets(string $addon, string $file) : non-empty-string
Parameters
$addon : string

Addon

$file : string

File

Tags
see
assets()
Return values
non-empty-string

addonCache()

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

public addonCache(string $addon, string $file) : non-empty-string
Parameters
$addon : string

Addon

$file : string

File

Return values
non-empty-string

addonData()

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

public addonData(non-empty-string $addon, string $file) : non-empty-string
Parameters
$addon : non-empty-string

Addon

$file : string

File

Return values
non-empty-string

assets()

Returns the path to the assets folder.

public assets(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

backend()

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

public backend([string $file = '' ]) : non-empty-string
Parameters
$file : string = ''

File

Tags
psalm-taint-specialize
Return values
non-empty-string

backendController()

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

public backendController() : non-empty-string
Return values
non-empty-string

base()

Returns the base/root path.

public base(string $file) : non-empty-string
Parameters
$file : string

File

Tags
psalm-taint-specialize
Return values
non-empty-string

bin()

Returns the path to the bin folder.

public bin(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

cache()

Returns the path to the cache folder.

public cache(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

core()

Returns the path to the actual core.

public core(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

coreAssets()

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

public coreAssets(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

coreCache()

Returns the path to the cache folder of the core.

public coreCache(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

coreData()

Returns the path to the data folder of the core.

public coreData(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

data()

Returns the path to the data folder.

public data(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

frontend()

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

public frontend(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

frontendController()

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

public frontendController() : non-empty-string
Return values
non-empty-string

log()

Returns the path to the log folder.

public log(string $file) : non-empty-string
Parameters
$file : string
Return values
non-empty-string

media()

Returns the path to the media-folder.

public media(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string

plugin()

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

public plugin(non-empty-string $addon, non-empty-string $plugin, string $file) : non-empty-string
Parameters
$addon : non-empty-string

Addon

$plugin : non-empty-string

Plugin

$file : string

File

Return values
non-empty-string

pluginAssets()

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

public pluginAssets(string $addon, string $plugin, string $file) : non-empty-string
Parameters
$addon : string

Addon

$plugin : string

Plugin

$file : string

File

Tags
see
assets()
Return values
non-empty-string

pluginCache()

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

public pluginCache(string $addon, string $plugin, string $file) : non-empty-string
Parameters
$addon : string

Addon

$plugin : string

Plugin

$file : string

File

Return values
non-empty-string

pluginData()

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

public pluginData(non-empty-string $addon, non-empty-string $plugin, string $file) : non-empty-string
Parameters
$addon : non-empty-string

Addon

$plugin : non-empty-string

Plugin

$file : string

File

Return values
non-empty-string

src()

Returns the path to the src folder.

public src(string $file) : non-empty-string
Parameters
$file : string

File

Return values
non-empty-string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results