Binput Is An Input Protector For Laravel 5

Installs: 26 105

Dependents: 7

Stars: 40

Watchers: 5

Forks: 6

Open Issues: 1

Language: PHP

v3.2.0 2015-06-26 17:33 UTC

README

Laravel Binput was created by, and is maintained by Graham Campbell, and is an input protector for Laravel 5. It utilises my Laravel Security package. Feel free to check out the change log, releases, license, and contribution guidelines.

Laravel Binput

Build Status Coverage Status Quality Score Software License Latest Version

Installation

PHP 5.5+ or HHVM 3.6+, and Composer are required.

To get the latest version of Laravel Binput, simply add the following line to the require block of your composer.json file:

"graham-campbell/binput": "~3.2"

You'll then need to run composer install or composer update to download it and have the autoloader updated.

You will need to register the Laravel Security service provider before you attempt to load the Laravel Binput service provider. Open up config/app.php and add the following to the providers key.

  • 'GrahamCampbell\Security\SecurityServiceProvider'

Once Laravel Binput is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • 'GrahamCampbell\Binput\BinputServiceProvider'

You can register the Binput facade in the aliases key of your config/app.php file if you like.

  • 'Binput' => 'GrahamCampbell\Binput\Facades\Binput'

Configuration

Laravel Binput requires no configuration. Just follow the simple install instructions and go!

Usage

Binput

This is the class of most interest. It is bound to the ioc container as 'binput' and can be accessed using the Facades\Binput facade. There are a few public methods of interest.

The 'all', 'get', 'input', 'only', 'except', and 'old' methods have an identical api to the methods found on the laravel request class accept from they all accept two extra parameters at the end. The first extra parameter is a boolean representing if the input should be trimmed. The second extra parameter is a boolean representing if the input should be xss cleaned. Both extra parameters are default to true.

There are two additional methods added to the public api. The first is a method called 'map' which will remap the output from the 'only' method. The 'map' function requires an associative array as the first parameter. The second method is the 'clean' function. It takes three parameters. The first is the value to be cleaned (it can be an array, and will be recursively iterated over and cleaned), and the final two are trim and clean, which behave in the same way as earlier.

Any methods not found on this binput class will actually fall back to the laravel request class with a dynamic call function, so every other method on the request class is available in exactly the same way it would be on the Laravel request class.

Facades\Binput

This facade will dynamically pass static method calls to the 'binput' object in the ioc container which by default is the Binput class.

BinputServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in config/app.php. This class will setup ioc bindings.

License

Laravel Binput is licensed under The MIT License (MIT).