REDAXO 5
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • redaxo
    • backup
    • be-style
    • core
    • cronjob
      • article-status
      • optimize-tables
    • media-manager
    • mediapool
    • metainfo
    • phpmailer
    • structure
      • content
      • history
      • version
    • users

Classes

  • rex
  • rex_addon
  • rex_addon_manager
  • rex_api_function
  • rex_api_result
  • rex_autoload
  • rex_backend_login
  • rex_backend_password_policy
  • rex_be_controller
  • rex_be_navigation
  • rex_be_page
  • rex_be_page_main
  • rex_clang
  • rex_clang_perm
  • rex_clang_service
  • rex_complex_perm
  • rex_config
  • rex_console_application
  • rex_console_command
  • rex_context
  • rex_csrf_token
  • rex_dir
  • rex_error_handler
  • rex_event_select
  • rex_extension
  • rex_extension_point
  • rex_file
  • rex_finder
  • rex_form
  • rex_form_checkbox_element
  • rex_form_container_element
  • rex_form_control_element
  • rex_form_element
  • rex_form_options_element
  • rex_form_prio_element
  • rex_form_radio_element
  • rex_form_raw_element
  • rex_form_select_element
  • rex_formatter
  • rex_fragment
  • rex_i18n
  • rex_list
  • rex_log_entry
  • rex_log_file
  • rex_logger
  • rex_login
  • rex_markdown
  • rex_null_addon
  • rex_null_package
  • rex_null_plugin
  • rex_package
  • rex_package_manager
  • rex_pager
  • rex_password_policy
  • rex_path
  • rex_path_default_provider
  • rex_perm
  • rex_plugin
  • rex_plugin_manager
  • rex_request
  • rex_response
  • rex_select
  • rex_socket
  • rex_socket_proxy
  • rex_socket_response
  • rex_sortable_iterator
  • rex_sql
  • rex_sql_column
  • rex_sql_foreign_key
  • rex_sql_index
  • rex_sql_schema_dumper
  • rex_sql_table
  • rex_sql_util
  • rex_stream
  • rex_string
  • rex_system_setting
  • rex_timer
  • rex_type
  • rex_url
  • rex_user
  • rex_validator
  • rex_var
  • rex_var_clang
  • rex_var_config
  • rex_var_dumper
  • rex_var_property
  • rex_view

Interfaces

  • rex_addon_interface
  • rex_context_provider_interface
  • rex_package_interface
  • rex_plugin_interface
  • rex_url_provider_interface
  • rex_user_role_interface

Traits

  • rex_factory_trait
  • rex_instance_list_pool_trait
  • rex_instance_pool_trait
  • rex_singleton_trait

Exceptions

  • rex_api_exception
  • rex_exception
  • rex_functional_exception
  • rex_http_exception
  • rex_socket_exception
  • rex_sql_exception
  • rex_yaml_parse_exception

Functions

  • rex_cookie
  • rex_delete_cache
  • rex_env
  • rex_escape
  • rex_files
  • rex_get
  • rex_ini_get
  • rex_post
  • rex_request
  • rex_request_method
  • rex_server
  • rex_session
  • rex_set_session
  • rex_unset_session

Class rex_path

Utility class to generate absolute paths.

Package: redaxo\core
Author: gharlan
Located at redaxo/src/core/lib/util/path.php

Methods summary

public static
# init( mixed $pathprovider )

Initializes the class.

Initializes the class.

Parameters

$pathprovider
A path provider
public static string
# base( string $file = '' )

Returns the base/root path.

Returns the base/root path.

Parameters

$file
File

Returns

string
string
public static string
# frontend( string $file = '' )

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

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

Parameters

$file
File

Returns

string
string
public static string
# frontendController( )

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

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

Returns

string
string
public static string
# backend( string $file = '' )

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

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

Parameters

$file
File

Returns

string
string
public static string
# backendController( )

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

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

Returns

string
string
public static string
# media( string $file = '' )

Returns the path to the media-folder.

Returns the path to the media-folder.

Parameters

$file
File

Returns

string
string
public static string
# assets( string $file = '' )

Returns the path to the assets folder.

Returns the path to the assets folder.

Parameters

$file
File

Returns

string
string
public static string
# coreAssets( string $file = '' )

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

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

Parameters

$file
File

Returns

string
string
public static string
# addonAssets( string $addon, string $file = '' )

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

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

Parameters

$addon
Addon
$file
File

Returns

string
string

See

rex_path::assets()
public static string
# pluginAssets( string $addon, string $plugin, string $file = '' )

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

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

Parameters

$addon
Addon
$plugin
Plugin
$file
File

Returns

string
string

See

rex_path::assets()
public static string
# bin( string $file = '' )

Returns the path to the bin folder.

Returns the path to the bin folder.

Parameters

$file
File

Returns

string
string
public static string
# data( string $file = '' )

Returns the path to the data folder.

Returns the path to the data folder.

Parameters

$file
File

Returns

string
string
public static string
# coreData( string $file = '' )

Returns the path to the data folder of the core.

Returns the path to the data folder of the core.

Parameters

$file
File

Returns

string
string
public static string
# addonData( string $addon, string $file = '' )

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

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

Parameters

$addon
Addon
$file
File

Returns

string
string
public static string
# pluginData( string $addon, string $plugin, string $file = '' )

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

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

Parameters

$addon
Addon
$plugin
Plugin
$file
File

Returns

string
string
public static string
# cache( string $file = '' )

Returns the path to the cache folder.

Returns the path to the cache folder.

Parameters

$file
File

Returns

string
string
public static string
# coreCache( string $file = '' )

Returns the path to the cache folder of the core.

Returns the path to the cache folder of the core.

Parameters

$file
File

Returns

string
string
public static string
# addonCache( string $addon, string $file = '' )

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

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

Parameters

$addon
Addon
$file
File

Returns

string
string
public static string
# pluginCache( string $addon, string $plugin, string $file = '' )

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

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

Parameters

$addon
Addon
$plugin
Plugin
$file
File

Returns

string
string
public static string
# src( string $file = '' )

Returns the path to the src folder.

Returns the path to the src folder.

Parameters

$file
File

Returns

string
string
public static string
# core( string $file = '' )

Returns the path to the actual core.

Returns the path to the actual core.

Parameters

$file
File

Returns

string
string
public static string
# addon( string $addon, string $file = '' )

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

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

Parameters

$addon
Addon
$file
File

Returns

string
string
public static string
# plugin( string $addon, string $plugin, string $file = '' )

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

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

Parameters

$addon
Addon
$plugin
Plugin
$file
File

Returns

string
string
public static string
# absolute( string $relPath )

Converts a relative path to an absolute.

Converts a relative path to an absolute.

Parameters

$relPath
The relative path

Returns

string
Absolute path
public static string
# basename( string $path )

Returns the basename (filename) of the path independent of directory separator (/ or ).

Returns the basename (filename) of the path independent of directory separator (/ or ).

This method should be used to secure incoming GET/POST parameters containing a filename.

Parameters

$path

Returns

string
string

Properties summary

protected static mixed $pathprovider
#
REDAXO 5 API documentation generated by ApiGen 3.0dev