bgreenacre / env-paths

为给定运行应用程序的环境和用户,提供存储缓存、配置、数据等内容的路径。

dev-main / 1.0.x-dev 2022-04-08 22:00 UTC

This package is auto-updated.

Last update: 2024-09-09 03:08:11 UTC


README

Latest Version Total Downloads Software License Build Status

为给定运行应用程序的环境和用户,提供存储缓存、配置、数据等内容的路径。本库深受envPaths nodejs 包和Composer查找用户主目录方式的影响。

需求

  • PHP (7.2+)

使用方法

示例

$paths = Bgreenacre\EnvPaths\EnvPaths::getPaths('MyApp');

/**
 *  - macOS: `~/Library/Application Support/MyApp-php`
 *  - Windows: `%LOCALAPPDATA%\MyApp-php\Data` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-php\Data`)
 *  - Linux: `~/.local/share/MyApp-php` (or `$XDG_DATA_HOME/MyApp-php`)
 */
echo $paths['data'];

/**
 * - macOS: `~/Library/Caches/MyApp-php`
 * - Windows: `%LOCALAPPDATA%\MyApp-php\Cache` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-php\Cache`)
 * - Linux: `~/.cache/MyApp-php` (or `$XDG_CACHE_HOME/MyApp-php`)
 */
echo $paths['cache'];

/**
 *  - macOS: `~/Library/Preferences/MyApp-php`
 *  - Windows: `%APPDATA%\MyApp-php\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\MyApp-php\Config`)
 *  - Linux: `~/.config/MyApp-php` (or `$XDG_CONFIG_HOME/MyApp-php`)
 */
echo $paths['config'];

/**
 *  - macOS: `~/Library/Logs/MyApp-php`
 *  - Windows: `%LOCALAPPDATA%\MyApp-php\Log` (for example, `C:\Users\USERNAME\AppData\Local\MyApp-php\Log`)
 *  - Linux: `~/.local/state/MyApp-php` (or `$XDG_STATE_HOME/MyApp-php`)
 */
echo $paths['log'];

/**
 *  - macOS: `/var/folders/jf/f2twvvvs5jl_m49tf034ffpw0000gn/T/MyApp-php`
 *  - Windows: `%LOCALAPPDATA%\Temp\MyApp-php` (for example, `C:\Users\USERNAME\AppData\Local\Temp\MyApp-php`)
 *  - Linux: `/tmp/USERNAME/MyApp-php`
 */
echo $paths['temp'];

许可证

本库采用MIT许可证 - 有关详细信息,请参阅LICENSE文件。