将参数传递给 Laravel Artisan 命令的 handle() 函数

如何在 Laravel Artisan 命令中将参数传递给 handle() 函数？

该解决方案使用 PHP 和 Laravel 来定义参数并将其传递给 处理（） 自定义 Artisan 命令中的函数。

class UpdatePlacesImages extends Command {
    /
     * The name and signature of the console command.
     * @var string
     */
    protected $signature = 'app:update-places-images {type}'; // Accepts 'places' or 'lounges'
    /
     * The console command description.
     * @var string
     */
    protected $description = 'Update places or lounges images from Places API';
    /
     * Execute the console command.
     */
    public function handle() {
        $type = $this->argument('type'); // Fetch the parameter
        if ($type === 'places') {
            $this->updatePlacesImages();
        } elseif ($type === 'lounges') {
            $this->updateLoungesImages();
        } else {
            $this->error('Invalid type. Use "places" or "lounges".');
        }
    }
}
// Example execution: php artisan app:update-places-images places

另一种方法：使用选项以获得更大的灵活性

此方法修改 Laravel 命令以使用选项而不是参数来传递参数。

class UpdatePlacesImages extends Command {
    /
     * The name and signature of the console command.
     * @var string
     */
    protected $signature = 'app:update-places-images {--type=}'; // Uses an option
    /
     * The console command description.
     * @var string
     */
    protected $description = 'Update places or lounges images from Places API';
    /
     * Execute the console command.
     */
    public function handle() {
        $type = $this->option('type'); // Fetch the option
        switch ($type) {
            case 'places':
                $this->updatePlacesImages();
                break;
            case 'lounges':
                $this->updateLoungesImages();
                break;
            default:
                $this->error('Invalid type. Use --type=places or --type=lounges.');
        }
    }
}
// Example execution: php artisan app:update-places-images --type=places

使用单元测试测试解决方案

此示例使用 PHPUnit 来验证 Artisan 命令在各种场景中的行为是否符合预期。

class UpdatePlacesImagesTest extends TestCase {
    public function testPlacesArgument() {
        $this->artisan('app:update-places-images places')
             ->expectsOutput('Updating places images...')
             ->assertExitCode(0);
    }
    public function testLoungesArgument() {
        $this->artisan('app:update-places-images lounges')
             ->expectsOutput('Updating lounges images...')
             ->assertExitCode(0);
    }
    public function testInvalidArgument() {
        $this->artisan('app:update-places-images invalid')
             ->expectsOutput('Invalid type. Use "places" or "lounges".')
             ->assertExitCode(1);
    }
}

关于将参数传递给 Laravel Artisan 命令的常见问题

1. 如何将参数传递给 Laravel Artisan 命令？
2. 使用 $signature 属性来定义参数或选项并使用获取它们的值 $this->argument() 或者 $this->option()。
3. 我可以为 Artisan 命令中的参数设置默认值吗？
4. 是的，您可以在中设置默认值 $signature。例如： {type=places} 将“地点”设置为默认值。
5. 如何验证传递给 Artisan 命令的输入？
6. 里面的 handle 方法，您可以编写验证逻辑以确保仅允许诸如“地点”或“休息室”之类的预期值。
7. 我可以使 Artisan 命令交互吗？
8. 是的，Laravel 提供了类似的方法 $this->ask 用于用户输入和 $this->confirm 供用户在执行过程中确认。
9. 如果将无效参数传递给命令会发生什么？
10. 通过适当的验证 handle 方法，您可以使用显示错误消息 $this->error 并阻止进一步执行。

Laravel Artisan 命令的要点

Laravel Artisan 命令是简化复杂任务（例如管理）的宝贵工具。 数据库更新。动态传递参数可确保您的命令灵活并且可以有效地处理特定需求。这对于可扩展的开发至关重要。 🎯

通过了解如何使用诸如 $this->$this->参数()、选项和验证，您可以设计强大且用户友好的命令。本指南通过实际示例帮助您充分利用 Laravel 的专业级应用程序潜力。 🚀