Locator
in package
VuFind Configuration Locator - A static compatibility wrapper around PathResolver
Tags
Table of Contents
- getBaseConfigPath() : string
- Get the file path to the base configuration file.
- getConfigPath() : string
- Get the file path to a config file.
- getLocalConfigPath() : string|null
- Get the file path to the local configuration file (null if none found).
- getPathResolver() : PathResolver
- Get a PathResolver with default configuration file paths
Methods
getBaseConfigPath()
Get the file path to the base configuration file.
public
static getBaseConfigPath(string $filename[, string|null $path = null ]) : string
Parameters
- $filename : string
-
config file name
- $path : string|null = null
-
path relative to VuFind base (optional; use null for default)
Tags
Return values
string —getConfigPath()
Get the file path to a config file.
public
static getConfigPath(string $filename[, string|null $path = null ]) : string
Parameters
- $filename : string
-
Config file name
- $path : string|null = null
-
Path relative to VuFind base (optional; use null for default)
Tags
Return values
string —getLocalConfigPath()
Get the file path to the local configuration file (null if none found).
public
static getLocalConfigPath(string $filename[, string|null $path = null ][, bool $force = false ]) : string|null
Parameters
- $filename : string
-
config file name
- $path : string|null = null
-
path relative to VuFind base (optional; use null for default)
- $force : bool = false
-
force method to return path even if file does not exist (default = false, do not force)
Tags
Return values
string|null —getPathResolver()
Get a PathResolver with default configuration file paths
protected
static getPathResolver() : PathResolver