webklex / helpers
Basic and flexible Laravel helpers
Requires
- php: >=5.5.9
- illuminate/console: >=5.2
- illuminate/contracts: >=5.2
- illuminate/support: >=5.2
Requires (Dev)
- phpunit/phpunit: 4.*
- scrutinizer/ocular: ~1.1
- squizlabs/php_codesniffer: ~2.3
This package is auto-updated.
Last update: 2024-11-13 10:24:19 UTC
README
This is a helpers package that provides some built in helpers, and also provides an Artisan generator to quickly create your own custom helpers.
Install
Via Composer
$ composer require webklex/helpers
Setup
Add the service provider to the providers array in config/app.php
.
'providers' => [ webklex\helpers\HelperServiceProvider::class, ];
Publishing
You can publish everything at once
php artisan vendor:publish --provider="webklex\helpers\HelperServiceProvider"
or you can publish groups individually.
php artisan vendor:publish --provider="webklex\helpers\HelperServiceProvider" --tag="config"
Usage
This package comes with some built in helpers that you can choose to use or not. By default all of these helpers are inactive for your application. To adjust which helpers are active and which are inactive, open config/helpers.php
and find the package_helpers
option. Add any helpers you wish to activate to this key. Check the source code to see what functions are included in each helper and what each does.
You can also create your own custom helpers for inclusion in your application. An Artisan generator helps you quickly make new helpers for your application.
php artisan make:helper MyHelper
Your custom helper will be placed in app/Helpers
, unless you override the default directory in your configuration.
By default, the service provider uses the glob
function to automatically require any PHP files in the 'Helpers' directory. If you prefer a mapper based approach, you may edit the custom_helpers
in the configuration file, and include the file name of any helpers in your custom directory you wish to activate. Within the new helper, define your own custom functions that will be available throughout your application.
if (!function_exists('hello')) { /** * say hello * * @param string $name * @return string */ function hello($name) { return 'Hello ' . $name . '!'; } }
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.
Credits
- Webklex
- Andrew Brown
- All Contributors
License
The MIT License (MIT). Please see License File for more information.