README

这是一个受我在一个Laravel项目中遇到的、需要对一个特定的模型或实体进行超过半打不同更新的需求启发的库。我本可以轻松地为每个请求创建不同的控制器方法和路由，但这会使我的web.php文件变得臃肿，我的控制器也是如此，我非常喜欢将我的路由文件保持得尽可能薄，并且让我的控制器看起来像我第一次运行artisan make:controller命令时一样，除了包含index, store, show, edit, update 和 destroy方法之外，不包含其他任何内容。因此，我决定寻找一种方法，可以从一个控制器方法处理不同但类似（可能需要更新相同的模型或将请求发送到相同的控制器）的表单请求，于是我想到了Laravel Form Processor。

注意：可能存在其他更直观的方法来实现相同的结果，但在当时，考虑到我在PHP和Laravel方面的技能水平，这对我来说是一个非常好的主意，这只是我的个人观点，所以请随意咨询专业人士。

这是一个适用于Laravel 5.x和Lumen 5.x的包

1. Laravel Form Processor

1.1. 设置

1.1.1. 在Lumen 5.x和Laravel 5.x上安装。

将Laravel Form Processor包添加到您的composer.json文件中。

composer require ac-developers/laravel-form-processor

自动发现：在Laravel Form Processor中支持Laravel 5.5及以上版本的自动发现。

1.1.2. 在Lumen和Laravel 5.4及以下版本上安装。

1.1.2.1. 服务提供者

在您的app配置中，将LaravelFormProcessorServiceProvider添加到提供者数组中。

'providers' => [
    AcDevelopers\LaravelFormProcessor\LaravelFormProcessorServiceProvider::class,
    ];

对于Lumen，将提供者添加到您的bootstrap/app.php文件中。

$app->register(AcDevelopers\LaravelFormProcessor\LaravelFormProcessorServiceProvider::class);

1.1.2.2. 门面（可选）

如果您想使用门面，请将其添加到您的app配置中的别名数组中。

'aliases' => [
    'LaravelFormProcessorFacade' => AcDevelopers\LaravelFormProcessor\LaravelFormProcessorFacade::class,
    ];

1.1.3. 发布配置文件。

要发布配置文件到config/laravel-form-processor.php，请运行

php artisan vendor:publish --provider="AcDevelopers\LaravelFormProcessor\LaravelFormProcessorServiceProvider"

1.1.4. 配置生成的流程的路径。

要更改保存生成的流程的路径，您需要在一个配置文件config/laravel-form-processor.php中配置它们的命名空间。


return [
    /*
    |--------------------------------------------------------------------------
    | Default namespaces for the classes
    |--------------------------------------------------------------------------
    */
    'namespaces' => [
        'process'   => 'App\Processes',
        'model'        => 'App\\',
    ],
];

然后您就可以开始了。

1.2. 使用

1.2.1. 创建表单处理类

假设您在Laravel应用程序中有一个名为Article的模型，并且您希望运行一个更新操作以将它的published字段从false更改为true，在配置您希望放置流程的目录之后，运行

php artisan generate:process PublishArticleProcess --model=Article

这将创建一个与模型（在本例中为Article）相关的表单处理类（当然指定模型是可选的）。如果流程目录路径保持不变，您的流程将存储在App\Processes目录中。请放心，如果该目录不存在，将会为您创建一个。

class PublishArticleProcess extends LaravelFormProcess implements LaravelFormProcessableInterface
{
    /**
     * PublishArticleProcess constructor.
     * @param \Illuminate\Http\Request $request
     * @param \App\Article $article
     */
    public function __construct(Request $request, Article $article)
    {
        $this->request = $request;
        $this->model = $article;
    }

    /**
     * @return \Illuminate\Http\Response
     */
    public function handle()
    {
        //
    }
}

在处理类生成后，所有更新Article published字段所需的逻辑都将放入handle方法中。

提示！您的进程应尽可能看起来和响应像它们所使用的控制器方法一样。例如，比较上面生成的进程构造函数与资源型ArticleController上的update方法。

class PublishArticleProcess extends LaravelFormProcess implements LaravelFormProcessableInterface
{
    protected $request;

    protected $article;

    /**
     * PublishArticleProcess constructor.
     * @param \Illuminate\Http\Request $request
     * @param \App\Article $article
     */
    public function __construct(Request $request, Article $article)
    {
        $this->request = $request;
        $this->article = $article;
    }

    /**
     * @return \Illuminate\Http\Response
     */
    public function handle()
    {
        // Perform validation using Laravel's ValidatesRequests trait
        $this->validate($this->request, ['published' => 'required']);

        // Update the model
        $result = $this->article->update($this->request->all());

        // Return to any desired location if update was successful. 
        if ($result) {
            return redirect()->route('articles.show', ['id' => $this->article->id])
                ->with('status', 'Article was updated successfully.');
        }

        // Return back if not.
        return back()->withErrors(['Unable to update this article.']);
    }
}

尽管这是一个简单的用例，但由于使用了Laravel的扩展抽象类LaravelFormProcess提供的AuthorizesRequests、DispatchesJobs、ValidatesRequests，这里可以执行许多操作，例如调度作业、触发事件、授权等。重要的是要注意，所有的Process handle方法必须只返回一个Response，而不是一个View。

1.2.2. 设置控制器以接收我们的处理过程。

当谈到在控制器中放置您的进程时，这仅取决于您的操作在CRUD分类中属于哪个类别。在我们的例子中，这将是在CRUD中的U，代表update。

现在，很多人可能会问：“除了update方法之外，为什么还需要在其他控制器方法中放置Processor？”

想象一下，您在view中有两个删除按钮，一个用于管理员，另一个用于超级用户。现在当管理员决定删除一篇文章时，作为超级用户的您希望对这个问题有最后的决定权。因此，在处理管理员的删除操作时，将执行软删除，随后通知超级用户管理员想要删除文章的意图。现在，当超级用户决定执行他们的决定时，他们现在可以执行一个将永久从数据库中删除文章的删除操作。

1.2.2.1. 使用LaravelFormProcessorInterface

现在，在您的ArticleController类中的update方法内，您可以这样注入LaravelFormProcessorInterface

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Article $article
     * @param LaravelFormProcessorInterface $laravelFormProcessorInterface
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Article $article, LaravelFormProcessorInterface $formProcessorInterface)
    {
        $process = $formProcessorInterface->retrieveProcessFromFormField($request->get('_prKey'))

        return $formProcessorInterface->run(new $process($request, $article));
    }

1.2.2.2. 使用LaravelFormProcessorFacade

如果您更习惯于像下面例子所示的面具（Facades），可以使用LaravelFormProcessorFacade。

/**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \App\Article $article
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, Article $article)
    {
        $process = LaravelFormProcessorFacade::retrieveProcessFromFormField($request->get('_prKey'))

        return LaravelFormProcessorFacade::run(new $process($request, $article));
    }

然后，在您希望处理的表单中，您将使用由包提供的@renderProcess指令来指向将要运行或处理表单请求的进程类。

<form action="route('articles.update', ['id' => article->id])" method="POST">
    @csrf
    @method('PATCH')}}

    @renderProcess(\App\Process\ArticlePublishProcess)
    
    <div class="d-block my-3">
        <div class="custom-control custom-radio">
            <input name="published" checked="" type="radio" value="true"><label>Publish</label>
        </div>
        <div class="custom-control custom-radio">
            <input name="published" type="radio" value="false"><label>Unpublish</label>
        </div>
    </div>
</form>

在LaravelFormProcessorFacade上可用的renderProcess方法将实现与@renderProcess指令相同的目标，因此您可以根据需要自由使用它们。

这样就完成了，除非您有代码问题，否则一切应该都能正常运行。

1.3. 安全漏洞

如果您在Laravel Form Processor中发现安全漏洞，请通过电子邮件发送给Anitche Chisom，邮箱地址是anitchec.dev@gmail.com。所有安全漏洞都将得到及时处理。

1.4. 许可证

Laravel Form Processor是开源软件，遵循MIT许可协议。

ac-developers / laravel-form-processor

维护者

详细信息