alone-doc

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
====== セッション変数 ======

セッション変数とはHTTPリクエストをまたがって値を保持することができる変数です。

通常ウェブアプリケーションは、ブラウザからのリクエストを受けてプログラムが動作するというルーチンを何度も繰り返します。この時、１回目のリクエストと２回目のリクエストは何の関連もなく、１回目のリクエスト時の変数の値は２回目のリクエスト時には消えています。
これでは困る場合が多いので、なんらかの方法でリクエストをまたいで状態を保存する手段が必要になります。
この１つの解決策がセッション変数です。


===== 使い方 =====

[[prog_cgi:入力フォームを使う|入力フォームを使う]] の項で作成したフォーム入力プログラムを、以下のように改造してみましょう。

[1.start]\\
　　↓\\
[2.入力フォーム表示／入力]\\
　　↓\\
[3.確認画面表示／YES,NO入力]\\
　　↓\\
[4.最終確定画面表示]\\

３までは、前項で作ったところです。３から４へは、入力された結果を引き継がなければなりません。ここにセッション変数を使います。

３までのプログラムを再掲します。


<code ruby main.rb>
require 'alone'

class FormController1 < AlController
  # constructor
  def initialize()
    @form = AlForm.new(
      AlText.new("text1"),
      AlInteger.new("integer1"),
      AlSubmit.new("submit1"),
    )
    @form.action = Alone::make_uri( action:"confirm" )
  end

  # デフォルトアクション
  def action_index()
    AlTemplate.run("./index.rhtml")
  end

  # 確認画面
  def action_confirm()
    if @form.validate()
      AlTemplate.run("./confirm.rhtml")
    else
      AlTemplate.run("./index.rhtml")
    end
  end
end
</code>

<code html index.rhtml>
<%= header_section %>
<%= body_section %>

<%= @form.get_messages_by_html() %>
<%= @form.make_tiny_form() %>

<%= footer_section %>
</code>


確認画面では、YES/NO入力のためのaタグを追加します。

<code html confirm.rhtml>
<%= header_section %>
<%= body_section %>

text1: <%=h @form[:text1] %> <br>
integer1: <%=h @form[:integer1] %> <br>
<br>
よろしいですか？<br>
<a href="<%=h make_uri(:action=>'cancel') %>">いいえ</a>
<a href="<%=h make_uri(:action=>'commit') %>">はい</a>  

<%= footer_section %>
</code>


テンプレートの追加部分を見てもらうとわかるとおり、YES(はい)の場合は "commit"、NO(いいえ)の場合は "cancel" アクションが呼び出されます。コントローラへもこの２つのアクションを追加します。また確認画面のアクションでは、現在の入力内容を次回へ引き継ぐ必要がありますので、その操作も追加します。

<code ruby main.rb>
require 'alone'

class FormController1 < AlController
  # constructor
  def initialize()
    @form = AlForm.new(
      AlText.new("text1"),
      AlInteger.new("integer1"),
      AlSubmit.new("submit1"),
    )
    @form.action = Alone::make_uri( action:"confirm" )
  end

  # デフォルトアクション
  def action_index()
    AlTemplate.run("./index.rhtml")
  end

  # 確認画面
  def action_confirm()
    if @form.validate()
      session[:text1] = @form[:text1]           # 追加
      session[:integer1] = @form[:integer1]     # 追加
      AlTemplate.run("./confirm.rhtml")
    else
      AlTemplate.run("./index.rhtml")
    end
  end

  # 最終確定画面（追加）
  def action_commit()
    @text1 = session[:text1]
    @integer1 = session[:integer1]
    AlTemplate.run("./commit.rhtml")
  end

  # キャンセル（追加）
  def action_cancel()
    @form[:text1] = session[:text1]
    @form[:integer1] = session[:integer1]
    AlTemplate.run("./index.rhtml")
  end
end
</code>

最終確定画面用テンプレート

<code html commit.rhtml>
<%= header_section %>
<%= body_section %>

text1: <%=h @text1 %> <br>
integer1: <%=h @integer1 %> <br>
<br>
以上の内容で確定しました。

<%= footer_section %>
</code>

これで必要な４つのファイル、main.rb, index.rhtml, confirm.rhtml, commit.rthml が揃いました。

実行すると以下のようになります。

{{:prog_cgi:sess_index.png?nolink|}}\\
　　↓\\
{{:prog_cgi:sess_confirm.png?nolink|}}\\
　　↓\\
{{:prog_cgi:sess_commit.png?nolink|}}\\

確認画面で「いいえ」を選択すると、最初の入力フォームに戻ります。その際、コントローラの action_cancel では、セッション変数から@formへ値を戻しているので、表示されるフォームには入力した値が最初から入っている状態になります。

ここで説明したセッション変数は、コントローラローカルセッション変数といい、個々のコントローラ内でのみ有効なセッション変数です。つまり異なるコントローラからはアクセスできませんので、他のコントローラと名前がぶつかることを心配する必要がありません。 

コントローラをまたいで値を受け渡すことができるグローバルセッション変数もあります。
詳しくは、[[alcgi:セッションマネージャ|AlSession セッションマネージャ]] の項を参照してください。



====== リクエストをまたぐ一時的なメッセージ ======

httpリクエストをまたぐ一時的なメッセージは意外とよく使うので、たとえばRailsではflashという専用の機能が実装されています。

Aloneでは、そのような難しい機能は実装せず、もっと簡単に考えています。

===== 方法 =====

あるアクションにおいて処理後にリダイレクトし、リダイレクト先のページで処理の結果を表示する例です。

<code ruby>
  def action_one()
    session[:flash_msg1] = "リダイレクト先で表示"
    Alone::redirect_to( make_uri( :action=>"two" ) )
  end
  
  def action_two()
    AlTemplate.run("./two.rhtml")
  end
</code>

テンプレートでflash_msg1を表示し、同時に消去します。

<code html>
  <p> <%=h session.delete(:flash_msg1) %> </p>
</code>