ConfigPaths
in package
A Psy Shell configuration path helper.
Table of Contents
- getConfigDirs() : array<string|int, string>
- Get potential config directory paths.
- getConfigFiles() : array<string|int, string>
- Find real config files in config directories.
- getCurrentConfigDir() : string
- Get the current home config directory.
- getDataDirs() : array<string|int, string>
- Get potential data directory paths.
- getDataFiles() : array<string|int, string>
- Find real data files in config directories.
- getHomeConfigDirs() : array<string|int, string>
- Get potential home config directory paths.
- getRuntimeDir() : string
- Get a runtime directory.
- touchFileWithMkdir() : string|false
- Ensure that $file exists and is writable, make the parent directory if necessary.
- getDirNames() : mixed
- getRealFiles() : mixed
Methods
getConfigDirs()
Get potential config directory paths.
public
static getConfigDirs() : array<string|int, string>
Returns ~/.psysh, %APPDATA%/PsySH (when on Windows), and all
XDG Base Directory config directories:
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Return values
array<string|int, string> —getConfigFiles()
Find real config files in config directories.
public
static getConfigFiles(array<string|int, string> $names[, string $configDir = null ]) : array<string|int, string>
Parameters
- $names : array<string|int, string>
-
Config file names
- $configDir : string = null
-
Optionally use a specific config directory
Return values
array<string|int, string> —getCurrentConfigDir()
Get the current home config directory.
public
static getCurrentConfigDir() : string
Returns the highest precedence home config directory which actually
exists. If none of them exists, returns the highest precedence home
config directory (%APPDATA%/PsySH on Windows, ~/.config/psysh
everywhere else).
Tags
Return values
string —getDataDirs()
Get potential data directory paths.
public
static getDataDirs() : array<string|int, string>
If a dataDir option was explicitly set, returns an array containing
just that directory.
Otherwise, it returns ~/.psysh and all XDG Base Directory data directories:
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Return values
array<string|int, string> —getDataFiles()
Find real data files in config directories.
public
static getDataFiles(array<string|int, string> $names[, string $dataDir = null ]) : array<string|int, string>
Parameters
- $names : array<string|int, string>
-
Config file names
- $dataDir : string = null
-
Optionally use a specific config directory
Return values
array<string|int, string> —getHomeConfigDirs()
Get potential home config directory paths.
public
static getHomeConfigDirs() : array<string|int, string>
Returns ~/.psysh, %APPDATA%/PsySH (when on Windows), and the
XDG Base Directory home config directory:
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Return values
array<string|int, string> —getRuntimeDir()
Get a runtime directory.
public
static getRuntimeDir() : string
Defaults to /psysh inside the system's temp dir.
Return values
string —touchFileWithMkdir()
Ensure that $file exists and is writable, make the parent directory if necessary.
public
static touchFileWithMkdir(string $file) : string|false
Generates E_USER_NOTICE error if either $file or its directory is not writable.
Parameters
- $file : string
Return values
string|false —Full path to $file, or false if file is not writable
getDirNames()
private
static getDirNames(array<string|int, mixed> $baseDirs) : mixed
Parameters
- $baseDirs : array<string|int, mixed>
Return values
mixed —getRealFiles()
private
static getRealFiles(array<string|int, mixed> $dirNames, array<string|int, mixed> $fileNames) : mixed
Parameters
- $dirNames : array<string|int, mixed>
- $fileNames : array<string|int, mixed>