Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antonioribeiro/yaml
A Laravel YAML parser and config loader
https://github.com/antonioribeiro/yaml
config laravel parser php yaml
Last synced: 11 days ago
JSON representation
A Laravel YAML parser and config loader
- Host: GitHub
- URL: https://github.com/antonioribeiro/yaml
- Owner: antonioribeiro
- License: mit
- Created: 2017-11-30T14:59:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-13T21:28:08.000Z (over 2 years ago)
- Last Synced: 2024-05-15T13:26:12.477Z (6 months ago)
- Topics: config, laravel, parser, php, yaml
- Language: PHP
- Size: 276 KB
- Stars: 114
- Watchers: 10
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# YAML
### A Laravel YAML parser and config loader
## Rationale
Config files getting bigger, harder to maintain and look at, every day. Why not just use YAML to load them?
#### Which one is cleaner?
## Key features
### Load one file to Laravel config
``` php
Yaml::loadToConfig(config_path('myapp.yml'), 'my-app-conf');
```
## 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:
``` text
.
└── myapp
├── multiple
│ ├── alter.yml
│ ├── app.yml
│ └── second-level
│ └── third-level
│ ├── alter.yml
│ └── app.yml
├── single
└── single-app.yml
```
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') }}"
```
### Config values can reference config keys, you just have to quote it this way:
``` yaml
{{'format.version'}}
```
### You can add comments to your YAML files, something JSON wouldn't let you do
``` yaml
build:
mode: git-local #### other modes: git-remote or number
```
## 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](https://symfony.com/doc/current/components/yaml.html).
## Install
Via Composer
``` bash
$ composer require pragmarx/yaml
```
## 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:
``` php
$this->app
->make('pragmarx.yaml')
->loadToConfig($this->getConfigFile(), 'my-package');
```
Or use the Facade:
``` php
Yaml::loadToConfig(config_path('myapp.yml'), 'my-package');
```
And it's merged to your Laravel config:
``` php
config('my-package.name');
```
## 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:
``` 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
```
## Minimum requirements
- Laravel 5.5
- PHP 7.0
## Author
[Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro)
## License
This package is licensed under the MIT License - see the `LICENSE` file for details
## Contributing
Pull requests and issues are welcome.