magic-core
[ class tree: magic-core ] [ index: magic-core ] [ all elements ]

Class: HttpSession

Source Location: /core/helper/http/HttpSession.php

Class Overview


永続的なセッションとクッキーを管理するクラスです.


Author(s):

  • T.Okumura

Version:

  • 1.0.0

Methods



Class Details

[line 20]
永続的なセッションとクッキーを管理するクラスです.

$_SESSION$_COOKIEを操作するための機能を提供します。
一時的なセッションを利用するには、HttpFlashクラスを使用してください。




Tags:

author:  T.Okumura
version:  1.0.0
see:  HttpFlash
final:  


[ Top ]


Class Methods


constructor __construct [line 33]

HttpSession __construct( string $sessionName)

コンストラクタ.

クッキーが利用可能かどうかを判定するために、デフォルトのクッキーを発行します。




Tags:

access:  public


Parameters:

string   $sessionName   セッション名

[ Top ]

method clear [line 183]

void clear( )

セッションを終了します.

このファンクションが呼び出された後は、再度セッションをスタートさせるまで、 セッションは利用できません。




Tags:

access:  public


[ Top ]

method get [line 64]

mixed get( string $key)

セッションから値を取得します.



Tags:

return:  取得できた場合はその値、できなければFALSE
access:  public


Parameters:

string   $key   取得する値のキー

[ Top ]

method getAll [line 75]

array getAll( )

すべてのセッションを取得します.

返されるのはセッションのコピーです。
これによって返された配列に変更を加えても、元の$_SESSIONの内容は変更されない事に注意してください。




Tags:

return:  コピーされたセッションの配列
access:  public


[ Top ]

method getCookieValue [line 88]

mixed getCookieValue( string $key, [int $index = NULL])

クッキーから値を取得します.

クッキーの値がカンマで区切られていれば、配列に分割されます。




Tags:

return:  値がなければFALSE、インデックスが指定されていればその値、それ以外は値の配列
access:  public


Parameters:

string   $key   取得する値のキー
int   $index   [optional] 取得する値が複数の場合、0から始まるインデックス番号(オプション)

[ Top ]

method getId [line 106]

string getId( )

カレントのセッションIDを取得します.



Tags:

return:  セッションID
access:  public


[ Top ]

method getName [line 99]

string getName( )

カレントのセッション名を取得します.



Tags:

return:  セッション名
access:  public


[ Top ]

method isStarted [line 42]

bool isStarted( )

セッションが開始されているかどうかを取得します.



Tags:

return:  開始されている場合はTRUE
access:  public


[ Top ]

method remove [line 161]

void remove( string $key)

セッションから値を削除します.



Tags:

access:  public


Parameters:

string   $key   削除する値のキー

[ Top ]

method replace [line 173]

void replace( $list)

セッションを置換します.

セッションの内容がすべて置き換わる事に注意してください。




Tags:

access:  public


Parameters:

array   $list   置換する配列

[ Top ]

method set [line 117]

void set( string $key, mixed $value)

セッションに値を設定します.

同じキーがあれば、値が上書きされます。




Tags:

access:  public


Parameters:

string   $key   設定する値のキー
mixed   $value   設定する値

[ Top ]

method setAll [line 127]

void setAll( $list)

渡された配列をセッションにマージして設定します.

同じキーがあれば、値が上書きされます。




Tags:

access:  public


Parameters:

array   $list   セッションに設定する値の配列

[ Top ]

method setCookieValue [line 139]

void setCookieValue( string $key, mixed $value, int $expire)

クッキーに値を設定します.

同じクッキーがあれば、置き換えられます。




Tags:

access:  public


Parameters:

string   $key   設定する値のキー
mixed   $value   設定する値、または設定する値の配列
int   $expire   クッキーの存続時間(秒)

[ Top ]

method setId [line 147]

void setId( string $sessionId)

セッションIDを設定します.



Tags:

access:  public


Parameters:

string   $sessionId   セッションID

[ Top ]

method setName [line 154]

void setName( string $sessionName)

セッション名を設定します.



Tags:

access:  public


Parameters:

string   $sessionName   セッション名

[ Top ]

method start [line 52]

bool start( )

セッションを開始します.

既に開始されている場合は何もしません。




Tags:

return:  既に開始されているか、正常に開始した場合はTRUE
access:  public


[ Top ]


Documentation generated on Fri, 16 Dec 2011 11:13:51 +0100 by phpDocumentor 1.4.3