Laravel + Zend Form

Laravel使ってるとフォームのhtml書いてる時が一番面倒。
LaravelCollectiveを分離した辺りでLaravel側としてはここを便利にする気はなくなってるのかな。
https://github.com/LaravelCollective/html
Laravel側はAPIだけでフォームはJSがメインになる想定なのか、結局はhtmlで書くのが一番早いという想定なのか。

どういう想定でも面倒なものは面倒なのでもう少しなんとかできないかとZend Formでフォームのclass化を試してみたらそこそこ上手く行った。
これも複雑なことしようとすると結局手間は変わらないので簡単なフォームが主な対象。

https://docs.zendframework.com/zend-form/

使い方

https://github.com/kawax/laravel-zend-form

難しいことはないので軽く。

composer require revolution/laravel-zend-form

最近はさすがにPHP7.0とLaravel5.5以降のみ対応。Laravel使っててPHP7が使えないとかありえんでしょ。
LTSの5.5にはしばらく対応。

artisanコマンドを用意してるのでmake:formで生成。

php artisan make:form SampleForm

ファイルの置き場所はapp/Http/Forms/SampleForm.php

https://github.com/kawax/laravel-zend-form-project/blob/master/app/Http/Forms/SampleForm.php

Form classはZend Formのドキュメントをよく見て中身を組み立てる。
https://docs.zendframework.com/zend-form/quick-start/

使う時はコントローラーで

use App\Http\Forms\SampleForm;

    public function __invoke()
    {
        $form = new SampleForm;

        return view('form')->with(compact('form'));
    }

DIでもいいけど

use App\Http\Forms\SampleForm;

    public function __invoke(SampleForm $form)
    {
        return view('form')->with(compact('form'));
    }

ビューではこれだけで済むのが理想。

{{ $form->render() }}

ZendFormの生成するhtmlでいいならこれでいいけど実際はそう簡単じゃない。
一応CustomElement作るとかForm class側でがんばってやれないことはないけどそこまでの手間をかけるかどうか。

表示を細かく制御したいなら各項目ごとに表示。これをやるなら普通に作っても同じ気がする。

@php
    $form->prepare();
@endphp

{!! $form->form()->openTag($form) !!}

{{ csrf_field() }}

<div class="form-group row">
    <label for="name" class="col-sm-3 col-form-label">{!! $form->get('name')->getLabel() !!}</label>
    <div class="col-sm-9">
        {!! $form->formInput($form->get('name')) !!}
    </div>
</div>

<div class="form-group row">
    <label for="email" class="col-sm-3 col-form-label">{!! $form->get('email')->getLabel() !!}</label>
    <div class="col-sm-9">
        {!! $form->formInput($form->get('email')) !!}
    </div>
</div>

<div class="form-group row">
    <div class="col-sm-9 offset-sm-3">
        {!! $form->formSubmit($form->get('send')) !!}
    </div>
</div>

{!! $form->form()->closeTag($form) !!}

簡単なフォームにだけ使うとか、formCollectionで一部の項目にだけ使うとか、どう使うかはその場の判断。

詳細

パッケージの中身。今回はこれしかないけど。
https://github.com/kawax/laravel-zend-form/blob/master/src/Form.php

Renderer部分が一番分からなかった。LaravelもだけどView関連を他で使おうとすると大変。

    /**
     * @return PhpRenderer
     */
    protected function getRenderer(): PhpRenderer
    {
        if (is_null($this->renderer)) {
            $this->renderer = new PhpRenderer;
            $configProvider = new ConfigProvider;
            $pluginManager = new HelperPluginManager(new ServiceManager, $configProvider()['view_helpers']);
            $this->renderer->setHelperPluginManager($pluginManager);
        }
        return $this->renderer;
    }

これを自力で解決するのは時間かかっただろうけどこの記事を見つけたのですぐ終わった。
https://igotaprinter.com/blog/zf3-forms-standalone-plus-mustache-templates.html

{{ }}でエスケープされないのはIlluminate\Support\HtmlStringだから。
有効なのはrender()だけなので他は{!! !!}を使う必要がある。

     /**
     * @return HtmlString
     */
    public function render(): HtmlString
    {
        return new HtmlString($this->getRenderer()->form($this));
    }

Laravelのe()ヘルパーがこうなってるから。いつからかページネーションが{{ }}でよくなったのもこの仕組み。Laravel内部にはまだまだ知らない機能が多いけど依存が少なくて便利に使えるものなら自作のclassでも使っていく。

function e($value, $doubleEncode = true)
{
    if ($value instanceof Htmlable) {
        return $value->toHtml();
    }
    return htmlspecialchars($value, ENT_QUOTES, 'UTF-8', $doubleEncode);
}

ViewHelperはマジックメソッドで。

public function __call($method, $arguments)
{
    $renderer = $this->getRenderer();
    if (is_callable([$renderer, $method])) {
        return call_user_func_array([$renderer, $method], $arguments);
    }
    throw new \BadMethodCallException(sprintf('Method [%s] does not exist.', $method));
}

途中で見つけたこれはHelperを自分で一つ一つ作ってるけどさすがにそんなことはしたくない。
https://github.com/spotonlive/sl-laravel-zf2-form
FacadeでのHelperもやめた。
Formオブジェクトから直接呼び出せば十分。

Zendでのこれを

echo $this->formInput($form->get('name'));

こう書けるのでZendの情報を参考にできる。

{!! $form->formInput($form->get('name')) !!}

ViewHelperも大分ややこしい。
formから
https://github.com/zendframework/zend-form/blob/master/src/View/Helper/AbstractHelper.php
i18nに行って
https://github.com/zendframework/zend-i18n/blob/master/src/View/Helper/AbstractTranslatorHelper.php
viewまで
https://github.com/zendframework/zend-view/blob/master/src/Helper/AbstractHelper.php

Form使うだけでもあちこちに依存している。
composer.jsonではrequireで指定してないので追加でインストールが必要。

久しぶりにZend見たけど設計の思想からしてよく分からない。
いやまぁLaravelが特殊なだけでZendくらいが普通ではあるけど。

バリデーション

Laravel側の機能使えばいいので完全に無視。

実戦

早速投入してみたけど{{ $form->render() }}で済むならビューもコントローラーも綺麗さっぱりですっきり。

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Http\Forms\SettingForm;
use App\Http\Requests\Setting\UpdateRequest;

class SettingController extends Controller
{
    /**
     * @param SettingForm $form
     *
     * @return \Illuminate\Http\Response
     */
    public function edit(SettingForm $form)
    {
        return view('setting.edit')->with(compact('form'));
    }

    /**
     * @param UpdateRequest $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(UpdateRequest $request)
    {
        $request->user()->fill($request->only([
            'chatwork_room',
            'chatwork_token',
        ]))->save();

        return back();
    }
}

後はViewHelperを作れば好きなように表示できるかもしれないけど
こんなhtmlを組み立てる複雑なHelperを自分で作ったら後からのメンテが面倒そう。
https://gist.github.com/fabiopaiva/4820db170e62ffea66a6

View Helper

よく使いそうなBootstrap4とUIkit3のHorizontal用ViewHelperは作った。後から面倒にならないようになるべくシンプルに。
https://github.com/kawax/laravel-zend-form/tree/master/src/View/Helper

ユーザー側での拡張もできる。

プロジェクト内でViewHelperを作る
php artisan vendor:publishでconfig/zend-form.phpを公開
https://github.com/kawax/laravel-zend-form/blob/master/src/config/zend-form.php などを参考にconfigを追加

サービスプロバイダーでZendFormのViewHelperとマージしてるので他のViewHelperと同じように使える。
https://github.com/kawax/laravel-zend-form/blob/master/src/Providers/ZendFormServiceProvider.php

同じなので{!! !!}を使う。

 {!! $form->bootstrap4horizon($form) !!}

ViewHelperではエスケープしてない。help-textでhtmlを使えるようにするため。
基本的にはForm classで設定した項目を表示するだけなので問題ない想定。
ユーザーからの入力はZendFormを通すのでエスケープされる。

render()でViewHelperを指定してもいいようにした。最終的にはこれが一番良さそう。

 {{ $form->render('bootstrap4horizon') }}

プロジェクト内でViewHelperを統一したいならconfigで設定してもいいし。

 {{ $form->render(config('zend-form.helper')) }}

結局サービスコンテナとcall_user_func_arrayだけになってしまった。
https://github.com/kawax/laravel-zend-form/blob/master/src/Form.php

Symfony

にもFormコンポーネントがあった。Laravelならこっちでもいいかもしれないけどどうも使い方が分かりにくい…。
https://symfony.com/doc/current/components/form.html

June 3, 2018

Laravel + Zend Form

使い方

詳細

バリデーション

実戦

View Helper

Symfony