— y2sunlight 2020-05-15

Apricot に戻る

関連記事

• Apricot プロジェクトの作成
• Apricot 公開フォルダ
• Apricot コア
• Apricot アプリ

  • Apricot アプリ作成の準備
  • Apricot ホーム画面
  • Apricot エラー画面
  • Apricot データベースとモデル
  • Apricot ユーザ一覧画面
  • Apricot ユーザ登録画面
  • Apricot バリデーション
  • Apricot トランザクション
• Apricot 拡張

ユーザ登録画面にトランザクションの機能を追加します。トランザクションを作るか否かはアクション毎に設定できるようにします。また、トランザクション機能を追加することによりアクションでスローされる ApplicationException をキャッチして(エラー画面に遷移することなく)入力画面でエラーメッセージを表示できるようになります。アクションでスローされるApplicationException には以下のものがあります。

• 楽観的ロック例外(OptimissticLockException)
• 対象レコードが存在しない(レコード更新時および削除時)
• その他のアクションで発生するException
  ( パースエラーなどの Error は対象外です )

通常、トランザクションは更新系の処理で設定するするので、参照系で発生した全ての例外は集約エラーハンドラで処理されエラー画面が表示されます。この状況を避けたい場合は、次の何れかの選択になるでしょう。

• 参照系アクションもトランザクションを設定する
• アクション内のcatchブロックでエラーメッセージ付きの入力画面をレンダリングする

TODO

/apricot/app/Foundation

Controller.php

<?php
namespace App\Foundation;
 
use App\Exceptions\ApplicationException;
use Core\Foundation\BaseController;
use Core\Foundation\ErrorBag;
use ORM;
 
/**
 * コントローラ
 */
class Controller extends BaseController
{
    /**
     * Transactional Actions
     * @var array
     */
    protected $transactionalActions = [];
 
    /**
     * Register transactional action on the controller.
     * @param  array|string $actionName
     */
    protected function transactional($actionName)
    {
        $actions = is_array($actionName) ? $actionName : func_get_args();
        $this->transactionalActions = array_merge($this->transactionalActions , $actions);
    }
 
    /**
     * {@inheritDoc}
     * @see \Core\Foundation\BaseController::callAction()
     */
    protected function callAction($actionName, $params)
    {
        if (!in_array($actionName, $this->transactionalActions))
        {
            // Non transactional action
            return parent::callAction($actionName, $params);
        }
 
        // Transactional action
        if (!ORM::getDb()->beginTransaction())
        {
            // Redirect
            $errorBag = new ErrorBag(__('messages.error.db.access'));
            return redirect(back())->withInputs()->withErrors($errorBag);
        }
 
        try
        {
            $response = parent::callAction($actionName, $params);
            ORM::getDb()->commit();
            return $response;
        }
        catch(ApplicationException $e)
        {
            ORM::getDb()->rollBack();
            \Core\Log::exception('error',$e);
            \Core\Debug::error($e);
 
            // Redirect
            $errorBag = new ErrorBag($e->getUserMessage());
            return redirect(back())->withInputs()->withErrors($errorBag);
        }
    }
}

• TODO
• 記号なしリスト

アクションにトランザクションを設定したい場合は、コントローラのコンストラクタ内で以下のように行います。

TODO:

/apricot/app/Controllers

UserController.php

<?php
namespace App\Controllers;
 
use App\Exceptions\ApplicationException;
use App\Foundation\Controller;
use App\Models\User;
use Core\Input;
 
/**
 * ユーザコントローラ
 */
class UserController extends Controller
{
    ...
 
    /**
     * ユーザコントローラの生成
     */
    public function __construct()
    {
        // モデル
        $this->user = new User();
 
        // トランザクションアクション登録
        $this->transactional('insert','update','delete');
    }
 
    ...
}

• TODO
• 記号なしリスト