linuxstreet/laravel-registry

Registry package provides a convenient way to manage and use simple key/value pairs (with pre-defined types) by using Laravel's under-laying config() functionality.

1.1 2018-10-25 08:29 UTC

Requires

• ext-json: *
• illuminate/support: ~5

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~7.0
• sempro/phpunit-pretty-print: ^1.0

MIT

• Igor Jovanovic

• registry
• laravel

README

Registry package provides a convenient way to manage and use simple key/value pairs (with pre-defined types) by using Laravel's under-laying config() functionality.

When application boots, registry entries are saved into Laravel's config so no registry calls will hit the database beyond that point.

The main difference is that keys/values are saved in database and there is no need to manually edit config files.

Take a look at contributing.md to see a to do list.

Installation

Requires:

• PHP 7.0+
• Laravel 5.5+

Via Composer:

$ composer require linuxstreet/laravel-registry

Migrate your database:

$ php artisan migrate

If you're using Laravel 5.5 you'll need to add the service provider to your config/app.php

'Linuxstreet\Registry\RegistryServiceProvider::class'

Configuration

You can publish config and view files using the artisan command:

$ php artisan vendor:publish --provider="Linuxstreet\Registry\RegistryServiceProvider"

Usage

Check the 'config/registry.php' config file and make necessary changes if needed.

You can add/edit registry entries by using web provided web forms.

Start your web server:

$ php artisan serve

Go to: http://127.0.0.1:8000/admin/registry

Note: You can customize admin path by changing 'route_prefix' and/or 'path' options in 'config/registry.php'

Console helpers

• List registry key/values as stored in database:

$ php artisan registry:list

• List registry config keys with their real php values:

$ php artisan registry:config

• Flush all registry items (will permanently delete registry entries from database):

$ php artisan registry:flush

Using registry items in your code

You can access registry entries by using provided registry() helper:

registry('key', 'default');

or using Registry facade:

Registry::get('key', 'default');

or using Laravel config() helper:

config('registry.key', 'default');

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ phpunit

Contributing

Please see contributing.md for details and a todolist.

Security

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

Credits

• Igor Jovanovic

License

Please see the license file for more information.