Ground Sunlight

Windowsで作る - PHPプログラミングの開発環境

ユーザ用ツール

サイト用ツール

トレース:
apricot:usage:ja:controller

差分

このページの2つのバージョン間の差分を表示します。

この比較画面にリンクする

両方とも前のリビジョン 前のリビジョン
次のリビジョン 		前のリビジョン
apricot:usage:ja:controller [2020/08/26 20:28]
y2sunlight [トランザクション] 		apricot:usage:ja:controller [2020/09/03 13:46] (現在)
y2sunlight [Apricot コントローラ]
行 1: 行 1:
-> 編集中 
- 
----- 
- 
 ====== Apricot コントローラ ====== ====== Apricot コントローラ ======
  --- //[[http://www.y2sunlight.com|y2sunlight]] 2020-07-29//  --- //[[http://www.y2sunlight.com|y2sunlight]] 2020-07-29//
行 21: 行 17:
   * [[apricot:usage:ja:validation|Apricot バリデーション]]   * [[apricot:usage:ja:validation|Apricot バリデーション]]
   * [[apricot:usage:ja:provider|Apricot サービスプロバイダー]]   * [[apricot:usage:ja:provider|Apricot サービスプロバイダー]]
 +  * [[apricot:usage:ja:authentication|Apricot ユーザ認証]]
   * [[apricot:usage:ja:utility|Apricot ユーティリティ]]   * [[apricot:usage:ja:utility|Apricot ユーティリティ]]
  
行 360: 行 357:
 ===== トランザクション ===== ===== トランザクション =====
  
-Apricotでは、コントローラのアクションをラップする形でトランザクションをアクションに適用できます。Apricotは、トランザクションの適用されたアクションを呼び出す前にトランザクションを開始し、アクションが正常に終了するとそのトランザクションをコミットします。アクションが例外をスローした場合、Apricotは、それをキャッチしてエラーログを出力して、アクションの代わりに前画面に戻るリダイレクトレスポンスをクライアントに返します。これらの処理は全てApricotのフレームワーク内で行われるのでアクションのコーディングを最小限にすることができます。+Apricotでは、コントローラのアクションをラップする形で、アクションにトランザクションを適用することができます。Apricotは、トランザクションの適用されたアクションを呼び出す前にトランザクションを開始し、アクションが正常に終了するとそのトランザクションをコミットします。アクションが ''ApplicationException'' 例外をスローした場合、Apricotは、それをキャッチしてエラーログを出力して、アクションの代わりに前画面に戻るリダイレクトレスポンスをクライアントに返します。これらの処理は全てApricotのフレームワーク内で行われるのでアクションのコーディングを最小限にすることができます。
  
 \\ \\
  
 ==== トランザクションの適用 ==== ==== トランザクションの適用 ====
 +
 +アクションにトランザクションを適用するには、以下のように、コンストラクターの中で、コントローラの ''transactional()'' メソッドを使用します。
  
 <code php> <code php>
 class FooController extends Controller class FooController extends Controller
 { {
-    public function __construct()+    public function __construct(User $user)
     {     {
-        // インターセプターの登録 +        // トランザクションの適用 
-        $this->intercept('action', function(Controller $controller, int $id) +        $this->transactional('insert','update','delete'); 
-        { +        ...
-            $inputs = Input::all(); +
-            // バリデーション処理 +
-        });+
     }     }
-    ...+    ....
 } }
 </code> </code>
  
- +この例では、insert、updateそしてdeteleの各アクションにトランザクションを適用しています。このように、''transactional()'' メソッドの引数にアクション名を並べるだけで、トランザクションをアクションに適用することができます。
- +
-ユーザ登録画面にトランザクションの機能を追加します。トランザクションを作るか否かはアクション毎に設定できるようにします。また、トランザクション機能を追加することによりアクションでスローされる ApplicationException をキャッチして(エラー画面に遷移することなく)入力画面でエラーメッセージを表示できるようになります。アクションでスローされるApplicationException には以下のものがあります。 +
- +
-  * 楽観的ロック例外(OptimissticLockException) +
-  * 対象レコードが存在しない(レコード更新時および削除時) +
-  * その他のアクションで発生する''Exception'' \\ ( パースエラーなどの ''Error'' は対象外です ) +
- +
-通常、トランザクションは更新系の処理で設定するするので、参照系で発生した全ての例外は集約エラーハンドラで処理されエラー画面が表示されます。この状況を避けたい場合は、次の何れかの選択になるでしょう。 +
- +
-  * 参照系アクションもトランザクションを設定する +
-  * アクション内のcatchブロックでエラーメッセージ付きの入力画面をレンダリングする+
  
 \\ \\
  
-==== 使用例：ユーザコントローラ ====+==== トランザクションの処理 ====
  
-アクションのトランザクション処理を有効にしたい場合は、コントローラのコンストラクタの中でControllerクラスのtransactional()メソッドを使って、以下のようにします。 +以下は、ユーザコントローラの update アクションの例です。
- +
-  * **transactional( 'action1', ... );** +
- +
-{{fa>folder-open-o}} ** /apricot/app/Controllers ** +
-<code php UserController.php> +
-<?php +
-namespace App\Controllers; +
- +
-use App\Exceptions\ApplicationException; +
-use App\Foundation\Controller; +
-use App\Models\User; +
-use Core\Input;+
  
 +<code php>
 /** /**
- * ユーザコントローラ+ * Updates a user record. 
 + * 
 + * @param int $id 
 + * @return \Apricot\Foundation\Response
  */  */
-class UserController extends Controller+public function update(int $id)
 { {
-    ...+    $inputs = Input::all();
  
-    /** +    try
-     * ユーザコントローラの生成 +
-     */ +
-    public function __construct()+
     {     {
-        // モデル +        $this->user->update($id, $inputs); 
-        $this->user = new User(); +    } 
- +    catch(ApplicationException $e) 
-        // トランザクションアクション登録 +    { 
-        $this->transactional('insert','update','delete');+        throw $e; 
 +    } 
 +    catch(\Exception $e) 
 +    { 
 +        throw new ApplicationException(__('messages.error.db.update'));
     }     }
  
-    ...+    // Redirects to the user edit page. 
 +    return redirect(route("user/{$id}/edit"));
 } }
 </code> </code>
  
-  * transactional()を使って３つのアクション( ''insert()'', ''update()'', ''delete()'' )のトランザクション処理が有効になるように設定しています。+この例では、ユーザモデル( <nowiki>$this->user</nowiki> ) の update() メソッドで、ユーザデータを変更しています。updateアクションにはコントローラの transactional() メソッドによってトランザクションが適用されているので、データベースのトランザクションはフレームワークが自動で開始してくれます。 
 + 
 +アクションがしなければならないことは、モデルの例外を捕捉して、ApplicationException をスローすることだけです。フレームワークは ApplicationException またはそれを親に持つ例外のみを捕捉します。それ以外の例外は、集約エラーハンドラーによって補足されシステムエラーになります。即ち、フレームワークは、ApplicationException のみ前画面に戻すリダイレクトレスポンスを生成します。 
 + 
 +モデルは次の場合に ApplicationException をスローします： 
 + 
 +  * 楽観的ロック例外が発生した場合( ''OptimissticLockException'' ) 
 +  * 対象レコードが存在しない場合(レコード更新時および削除時) 
 + 
 +アクションでは、これ以外の例外が発生した場合は、パースエラーなどの ''Error'' を除き、''ApplicationException'' を生成してそれをスローすべきです。 
 + 
 +=== クエリーの例外処理 === 
 + 
 +通常、トランザクションは更新系の処理で設定するするので、クエリーで発生した全ての例外は集約エラーハンドラで処理されエラー画面が表示されます。この状況を避けたい場合は、次の何れかの選択になるでしょう。 
 + 
 +  * クエリーのアクションにもトランザクションを設定する 
 +  * アクション内のcatchブロックでエラーメッセージ付きの入力ページをレンダリングする
  
 \\ \\
  
apricot/usage/ja/controller.1598441318.txt.gz · 最終更新: 2020/08/26 20:28 by y2sunlight

ページ用ツール

特に明示されていない限り、本Wikiの内容は次のライセンスに従います： CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki