PathResolver
in package
Configuration File Path Resolver
Tags
Table of Contents
- DEFAULT_CONFIG_SUBDIR = 'config/vufind'
- Default configuration subdirectory.
- $baseDirectorySpec : array<string|int, mixed>
- Base directory
- $localConfigDirStack : array<string|int, mixed>
- Local configuration directory stack. Local configuration files are searched for in all directories until found, starting from the last entry.
- __construct() : mixed
- Constructor
- 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).
- buildPath() : string
- Build a complete file path from a directory specification, optional configuration file sub-directory and a filename.
Constants
DEFAULT_CONFIG_SUBDIR
Default configuration subdirectory.
public
string
DEFAULT_CONFIG_SUBDIR
= 'config/vufind'
Properties
$baseDirectorySpec
Base directory
protected
array<string|int, mixed>
$baseDirectorySpec
Must contain the following keys:
directory - The base configuration directory defaultConfigSubdir - Default subdirectory under directory for configuration files
$localConfigDirStack
Local configuration directory stack. Local configuration files are searched for in all directories until found, starting from the last entry.
protected
array<string|int, mixed>
$localConfigDirStack
Each entry must contain the following keys:
directory - The local configuration directory defaultConfigSubdir - Default subdirectory under directory for configuration files
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $baseDirectorySpec, array<string|int, mixed> $localConfigDirStack) : mixed
Parameters
- $baseDirectorySpec : array<string|int, mixed>
-
Base directory specification
- $localConfigDirStack : array<string|int, mixed>
-
Local configuration directory specification stack
Return values
mixed —getBaseConfigPath()
Get the file path to the base configuration file.
public
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)
Return values
string —getConfigPath()
Get the file path to a config file.
public
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)
Return values
string —getLocalConfigPath()
Get the file path to the local configuration file (null if none found).
public
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)
Return values
string|null —buildPath()
Build a complete file path from a directory specification, optional configuration file sub-directory and a filename.
protected
buildPath(array<string|int, mixed> $directorySpec, string|null $configSubdir, string $filename) : string
Parameters
- $directorySpec : array<string|int, mixed>
-
Directory specification
- $configSubdir : string|null
-
Optional configuration file subdirectory
- $filename : string
-
Filename