YAML
A Laravel YAML parser and config loader
, (*1)
, (*2)
, (*3)
Rationale
Config files getting bigger, harder to maintain and look at, every day. Why not just use YAML to load them?, (*4)
Which one is cleaner?
, (*5)
Key features
Load one file to Laravel config
``` php
Yaml::loadToConfig(config_path('myapp.yml'), 'my-app-conf');, (*6)
## Or a whole directory, recursively, so all those files would be loaded with a single command
``` php
Yaml::loadToConfig(config_path('myapp'), 'my-app-conf');
To load a directory with all your config files:, (*7)
``` text
.
└── myapp
├── multiple
│ ├── alter.yml
│ ├── app.yml
│ └── second-level
│ └── third-level
│ ├── alter.yml
│ └── app.yml
├── single
└── single-app.yml, (*8)
Then you would just have to use it like you usually do in Laravel
``` php
config('my-app-conf.multiple.second-level.third-level.alter.person.name')
Execute functions, like in the usual Laravel PHP array config.
``` php
repository: "{{ env('APP_NAME') }}"
path: "{{ storage_path('app') }}", (*9)
### Config values can reference config keys, you just have to quote it this way:
``` yaml
{{'format.version'}}
``` yaml
build:
mode: git-local #### other modes: git-remote or number, (*10)
## Parser and dumper methods
In case you need to deal with YAML directly, you can use these public methods:
``` php
Yaml::parse($input, $flags) // Parses YAML into a PHP value.
Yaml::parseFile($filename, $flags) // Parses a YAML file into a PHP value.
Yaml::dump($input, $inline, $indent, $flags) // Dumps a PHP value to a YAML string.
Which are simple bridges to Symfony's YAML., (*11)
Install
Via Composer, (*12)
``` bash
$ composer require pragmarx/yaml, (*13)
## Using
Publish your package as you would usually do:
``` php
$this->publishes([
__DIR__.'/../config/version.yml' => $this->getConfigFile(),
]);
Load the configuration in your boot() method:, (*14)
``` php
$this->app
->make('pragmarx.yaml')
->loadToConfig($this->getConfigFile(), 'my-package');, (*15)
Or use the Facade:
``` php
Yaml::loadToConfig(config_path('myapp.yml'), 'my-package');
And it's merged to your Laravel config:, (*16)
``` php
config('my-package.name');, (*17)
## Utilize PECL YAML
To utilize the PECL YAML, you should [install the PECL YAML extension](https://www.php.net/manual/en/yaml.installation.php) and register the binding in the `register()` method of your service provider:
```php
$this->app->bind(\PragmaRX\Yaml\Package\Support\Parser::class, \PragmaRX\Yaml\Package\Support\PeclParser::class);
Example
This is a YAML file from another package using this package:, (*18)
yaml
current:
major: 1
minor: 0
patch: 0
format: "{$major}.{$minor}.{$patch}"
cache:
enabled: true
key: pragmarx-version
build:
mode: git-local # git-remote or number
number: 701031
git-local: "git rev-parse --verify HEAD"
git-remote: "git ls-remote {$repository} refs/heads/master"
repository: "{{ env('APP_GIT_REPOSITORY') }}"
length: 6
format:
version: "{$major}.{$minor}.{$patch} (build {$build})"
full: "version {{'format.version'}}"
compact: "v{$major}.{$minor}.{$patch}-{$build}"
## add as many formats as you need, (*19)
Minimum requirements
Author
Antonio Carlos Ribeiro, (*20)
License
This package is licensed under the MIT License - see the LICENSE file for details, (*21)
Contributing
Pull requests and issues are welcome., (*22)
Wallogit.com
