https://github.com/alfonsobries/laravel-data-bags

Data Bags for @laravel
https://github.com/alfonsobries/laravel-data-bags

Last synced: 8 days ago
JSON representation

Data Bags for @laravel

• Host: GitHub
• URL: https://github.com/alfonsobries/laravel-data-bags
• Owner: alfonsobries
• License: mit
• Created: 2021-06-23T14:22:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-23T14:25:49.000Z (over 3 years ago)
• Last Synced: 2024-10-29T21:45:42.839Z (14 days ago)
• Language: PHP
• Size: 239 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Data Bags



[![Latest Version](https://badgen.net/packagist/v/konceiver/laravel-data-bags)](https://packagist.org/packages/konceiver/laravel-data-bags)

[![Software License](https://badgen.net/packagist/license/konceiver/laravel-data-bags)](https://packagist.org/packages/konceiver/laravel-data-bags)

[![Build Status](https://img.shields.io/github/workflow/status/konceiver/laravel-data-bags/run-tests?label=tests)](https://github.com/konceiver/laravel-data-bags/actions?query=workflow%3Arun-tests+branch%3Amaster)

[![Coverage Status](https://badgen.net/codeclimate/coverage/konceiver/laravel-data-bags)](https://codeclimate.com/github/konceiver/laravel-data-bags)

[![Quality Score](https://badgen.net/codeclimate/maintainability/konceiver/laravel-data-bags)](https://codeclimate.com/github/konceiver/laravel-data-bags)

[![Total Downloads](https://badgen.net/packagist/dt/konceiver/laravel-data-bags)](https://packagist.org/packages/konceiver/laravel-data-bags)

This package was created by, and is maintained by [Brian Faust](https://github.com/faustbrian), and provides an easy way of storing generic data that is resolved based on the location.

## Installation

```bash

composer require konceiver/laravel-data-bags

```

## Usage

### Registration & Resolving

``` php

use Konceiver\DataBags\DataBag;

DataBag::register('meta', [

    'users' => ['title' => 'Users'],

    '*'     => ['title' => 'Placeholder'],

]);

Route::get('users', function ($id) {

    // This will return ['title' => 'Users']

    return DataBag::resolveByPath('meta');

});

Route::get('/', function ($id) {

    // This will return ['title' => 'Placeholder']

    return DataBag::resolveByPath('meta');

});

```

### Blade Component

For convenience we offer a Blade component that will make it easy for you to include resolved data into views. We'll use meta tags as an example.

#### Register bag

``` php

use Konceiver\DataBags\DataBag;

DataBag::register('meta', [

    '/' => [

        'title'       => 'My Website',

        'description' => 'Posts, Media & More',

    ],

]);

Route::get('home', function ($id) {

    return view('home');

});

```

#### Create metatag component

```blade

```

#### Include data bag component

```blade

```

## Testing

``` bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](../../contributors).

## Support Us

We invest a lot of resources into creating and maintaining our packages. You can support us and the development through [GitHub Sponsors](https://github.com/sponsors/faustbrian).

## License

Laravel Data Bags is an open-sourced software licensed under the [MIT](LICENSE.md).