spiral
[ class tree: spiral ] [ index: spiral ] [ all elements ]

Class: SpiralSession

Source Location: /base/SpiralSession.php

Class Overview


セッションクラス


Methods



Class Details

[line 15]
セッションクラス

PHPの$_SESSIONをラップするクラスで、いくつかの機能を上書きしています。

インスタンスを作成する時は SpiralクラスのgetSession() をご利用ください。

  • セッション開始時、セッションIDが再利用されないように、セッションIDを再作成します。
  • セッションタイムアウト時、セッションを完全にクリアし、クッキーを無効化します。




[ Top ]


Class Methods


method containsKey [line 120]

boolean containsKey( [string $_key = null])

指定したパラメータがセッションに登録されていれば true を返します。

[ サンプル ]

  1.  <?php
  2.      $session $SPIRAL->getSession();
  3.      $boolean $session->containsKey($key);
  4.  ?>




Tags:

access:  public


Parameters:

string   $_key   キー

[ Top ]

method get [line 98]

mixed get( [string $_key = null])

指定したパラメータをセッションから取得します。

[ サンプル ]

  1.  <?php
  2.      $session $SPIRAL->getSession();
  3.      $value   $session->get($key);
  4.  ?>




Tags:

return:  
access:  public


Parameters:

string   $_key   キー

[ Top ]

method put [line 71]

mixed put( [string $_key = null], [mixed $_val = null])

指定したパラメータをセッションへ登録します。

[仕様]
・すでにキーが登録されている場合、変更前の値を返します。

[ サンプル ]

  1.  <?php
  2.      $session   $SPIRAL->getSession();
  3.      $old_value $session->put($key$value);
  4.  ?>




Tags:

return:  上書き前の値
access:  public


Parameters:

string   $_key   キー
mixed   $_val  

[ Top ]

method remove [line 40]

mixed remove( [string $_key = null])

指定したパラメータをセッションから削除します。

[ サンプル ]

  1.  <?php
  2.      $session   $SPIRAL->getSession();
  3.      $old_value $session->remove($key);
  4.  ?>




Tags:

return:  削除前の値
access:  public


Parameters:

string   $_key   キー

[ Top ]


Documentation generated on Fri, 08 Nov 2024 12:44:51 +0900 by phpDocumentor 1.4.4