www.aleph1.co.uk Git - yaffs-website/blob - vendor/dnoegel/php-xdg-base-dir/README.md

   1 # XDG Base Directory
   2
   3 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
   4
   5 Implementation of XDG Base Directory  specification for php
   6
   7 ## Install
   8
   9 Via Composer
  10
  11 ``` bash
  12 $ composer require dnoegel/php-xdg-base-dir
  13 ```
  14
  15 ## Usage
  16
  17 ``` php
  18 $xdg = \XdgBaseDir\Xdg();
  19
  20 echo $xdg->getHomeDir();
  21 echo $xdg->getHomeConfigDir()
  22 echo $xdg->getHomeDataDir()
  23 echo $xdg->getHomeCacheDir()
  24 echo $xdg->getRuntimeDir()
  25
  26 $xdg->getDataDirs() // returns array
  27 $xdg->getConfigDirs() // returns array
  28 ```
  29
  30 ## Testing
  31
  32 ``` bash
  33 $ phpunit
  34 ```
  35
  36 ## License
  37
  38 The MIT License (MIT). Please see [License File](https://github.com/dnoegel/php-xdg-base-dir/blob/master/LICENSE) for more information.