README

A Laravel adapter for the XDG Base Directory specification.

Install

Via Composer

composer require owenvoke/laravel-xdg

Usage

use OwenVoke\LaravelXdg\Xdg;

// Resolving from the app container
app(Xdg::class)->getHomeDirectory();
app('xdg')->getHomeDirectory();

// Using the facade (with, and without the short alias)
\Xdg::getHomeDirectory();
\OwenVoke\LaravelXdg\Facades\Xdg::getHomeDirectory();

Available methods

Description	Method name	Return Value
Retrieve the XDG home directory.	`getHomeDirectory()`	string
Retrieve the XDG home cache directory.	`getHomeCacheDirectory()`	string
Retrieve the XDG home config directory.	`getHomeConfigDirectory()`	string
Retrieve the XDG home data directory.	`getHomeDataDirectory()`	string
Retrieve the XDG runtime directory.	`getRuntimeDirectory()`	string
Retrieve all XDG config directories.	`getConfigDirectories()`	Collection
Retrieve all XDG data directories.	`getDataDirectories()`	Collection

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.

owenvoke / laravel-xdg

Maintainers

Details