cerbero/command-validator

Validate Laravel console commands input.

2.5.0 2021-04-24 02:31 UTC

Requires

• php: ^7.0||^8.0
• illuminate/contracts: >=5.5
• illuminate/support: >=5.5
• symfony/console: >=3.3.7

Requires (Dev)

• orchestra/testbench: >=3.5
• phpunit/phpunit: >=6.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Andrea Marco Sartori

• validator
• console
• validation
• commands
• cerbero
• command-validator

README

Laravel package to validate input in Artisan console commands.

Install

Via Composer

$ composer require cerbero/command-validator

Usage

This package merely consists in the ValidatesInput trait that Artisan commands can use to define their own validation rules for arguments and options in the rules() method:

use Illuminate\Console\Command;
use Cerbero\CommandValidator\ValidatesInput;

class SampleCommand extends Command
{
    use ValidatesInput;

    protected function rules()
    {
        return [
            'year' => 'integer|digits:4|min:2000',
            'some_option' => 'string|max:2',
        ];
    }
}

The available rules are the same validation rules provided by Laravel. If you need custom validation, please have a look at how to define custom rules.

Sometimes you may need to show custom messages or attributes for some validation errors. You can achieve that by overriding the methods messages() and attributes():

protected function messages()
{
    return [
        'min' => 'The minimum allowed :attribute is :min'
    ];
}

protected function attributes()
{
    return [
        'year' => 'year of birth'
    ];
}

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Andrea Marco Sartori
• All Contributors

License

The MIT License (MIT). Please see License File for more information.