larapack / command-verification
Makes Artisan Commands prompt the console if it should continue.
Installs: 14
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:package
This package is auto-updated.
Last update: 2024-12-06 09:52:48 UTC
README
Makes Artisan Commands prompt the console if it should continue.
Installing
Install using composer composer require larapack/command-verification 1.*
.
Usage
First add the trait Verifiable
to your Artisan Command.
<?php
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Larapack/CommandVerification/Verifiable;
class ExampleCommand extends Command
{
use Verifiable;
// ...
}
In order to make the user verify that he wants to run this command you will have to set your fire
-method to run the verify
-method and set the verify
-attribute.
protected $verify = 'This command will destroy your entire site!';
public function fire()
{
return $this->verify();
}
If the user accept it will call the verified
-method, so ensure you define that.
public function verified()
{
$this->info('We have destroyed your entire site. Thanks for using our command.');
}
It will look like this:
Customizing
When calling the verify
-method you can add the following parameters: $this->verify($message, Closure $callback)
public function fire()
{
return $this->verify('A custom verify message', function() {
$this->info('We have destroyed your entire site. Thanks for using our command.');
});
}
This way you can overwrite the default verify message and the callback.