pure.session
[ class tree: pure.session ] [ index: pure.session ] [ all elements ]
Packages:
com.arcadiangarden.ssx.calendar
com.arcadiangarden.ssx.logbook
com.arcadiangarden.ssx.struct
core
pure.db.datasource
pure.db.oci8
pure.db.util
pure.fw.brownie
pure.fw.filter.final
pure.fw.rss
pure.fw.taglib
pure.sendmail
pure.session
pure.util


Files:
SESSION.inc
SessionException.inc
SESSION_HANDLER.inc
SubSession.inc

Classes:
ESessionException
ESessionSecurityException
SESSION
SESSION_HANDLER
SubSession

Class: SubSession

Source Location: /package/pure/session/SubSession.inc

Class Overview

PURE_Class
   |
   --SubSession

サブセッションを管理するクラスです。

Methods

Class Details

[line 33]
サブセッションを管理するクラスです。

通常、SubSessionクラスのインスタンスは直接作成しないでください。 新しいサブセッションはSESSIONクラスのスタティックメソッドcreateSubSessionにより作成し、取得します。 現在のアクティブなサブセッションはgetSubSessionメソッドにより取得します。

Ag:PUREの標準セッション管理に関してはSESSIONクラスを参照してください。




[ Top ]

Class Methods

constructor __construct [line 53]

SubSession __construct( string $subSessionId)

標準のコンストラクタです。



Tags:

access:  public


Parameters:

string   $subSessionId   サブセッションID

[ Top ]

method checkSubSession [line 70]

void checkSubSession( )

サブセッションが正常か否かを確認します。

サブセッションが正常ではない場合、ESessionSecurityException例外を発生します。 正常な場合は何もせずに終了します。




Tags:

throws:  ESessionSecurityException 不正なサブセッション
access:  protected


[ Top ]

method close [line 87]

void close( )

サブセッションを閉じます。

フォームから情報を受信した後などにサブセッションが必要なくなったら可及的速やかに閉じるべきです。 これはセッション管理に費やされるサーバ側リソースの節約と共に、多重投稿やクラック目的の連続投稿を防ぐことにも繋がります。

なお、closeメソッドを呼び出した後のSubSessionクラスの各メソッドへのアクセスでは全てESessionSecurityException例外が返されるようになることに注意してください。




Tags:

throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


[ Top ]

method createTmpFile [line 246]

FileInfo createTmpFile( [string $filename = ""], [string $logicalName = ""], [string $contentType = ""], [mixed $tag = null])

サブセッションに一時ファイルを作成します。

作成された一時ファイルの情報はFileInfoクラスで返却されます。 サブセッションに保存される一時ファイルには、ファイルシステムに対して安全な英数字のみで構成されるファイル名が付加されます。 実際のファイル名に関しては論理ファイル名として管理されることに注意してください。 これはアップロードされたファイルをサブセッションの一時ファイルに確保する場合などに便利です。

createTmpFileメソッドは$filename引数に物理的なファイルが渡された場合、そのファイルをサブセッションのワークディレクトリにコピーします。 これは既存のファイルをサブセッションの一時ファイルとして登録する際に便利です。




Tags:

return:  作成した一時ファイルの情報
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


Parameters:

string   $filename   一時ファイルに保存したいファイルの物理ファイル名
string   $logicalName   論理ファイル名
string   $contentType   ファイル型
mixed   $tag   任意タグ

[ Top ]

method get [line 169]

mixed get( string $key, [mixed $def = false])

サブセッションのパラメータを取得します。

パラメータが存在しない場合、$def引数の値を返します。




Tags:

return:  パラメータ値
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


Parameters:

string   $key   パラメータ名
mixed   $def   パラメータが見付からない場合の返却値

[ Top ]

method getAccessTime [line 151]

int getAccessTime( )

サブセッションが最後にアクセスされた日時を取得します。

日時はUNIXエポックからの経過秒数で表されます。




Tags:

return:  サブセッションが最後のアクセスされた日時
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


[ Top ]

method getCreateTime [line 135]

int getCreateTime( )

サブセッションが生成された日時を取得します。

日時はUNIXエポックからの経過秒数で表されます。




Tags:

return:  サブセッションが生成された日時
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


[ Top ]

method getId [line 102]

string getId( )

サブセッションIDを取得します。



Tags:

return:  サブセッションID
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


[ Top ]

method getIdForm [line 203]

string getIdForm( [bool $xhtml = false])

サブセッションIDを保持するtype属性がhiddenのINPUTタグを生成して、その文字列を返します。



Tags:

return:  INPUTタグの文字列
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


Parameters:

bool   $xhtml   XHTMLで出力したい場合にはtrueを指定

[ Top ]

method getTmpFile [line 297]

FileInfo getTmpFile( int $index)

指定のインデックスの一時ファイル情報を生成して返します。



Tags:

return:  一時ファイルの情報
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
throws:  EIlligalParameterException インデックスが不正
access:  public


Parameters:

int   $index   一時ファイルのインデックス

[ Top ]

method getTmpFileCount [line 281]

int getTmpFileCount( )

サブセッションに保存されている一時ファイルの個数を取得します。



Tags:

return:  一時ファイルの個数
throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


[ Top ]

method getTmpFileSeq [line 223]

int getTmpFileSeq( )

一時ファイル管理用のシーケンスNOを取得します。



Tags:

return:  一時ファイル管理用のシーケンスNO
access:  protected


[ Top ]

method getWorkdir [line 119]

string getWorkdir( )

サブセッションに割り当てられたワークディレクトリのパスを取得します。

サブセッションに割り当てられたワークディレクトリは、サブセッションで一意に識別される専用の領域です。 サブセッションに一時ファイルを作成する場合、このワークディレクトリに作成し、セッション変数へバイナリを格納することは避けるようにして下さい。 なお、SubSessionクラスには一時ファイルを作成するためのメソッドが用意されていますので、通常はそちらを利用します。




Tags:

return:  サブセッションに割り当てられたワークディレクトリのパス
access:  public


[ Top ]

method removeTmpFile [line 326]

void removeTmpFile( int $index)

指定のインデックスの一時ファイルを削除します。



Tags:

throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
throws:  EIlligalParameterException インデックスが不正
access:  public


Parameters:

int   $index   一時ファイルのインデックス

[ Top ]

method set [line 188]

void set( string $key, mixed $value)

サブセッションにパラメータを設定します。



Tags:

throws:  ESessionSecurityException 既に閉じられているサブセッションにアクセスしようとした
access:  public


Parameters:

string   $key   パラメータ名
mixed   $value   パラメータ値

[ Top ]

Documentation generated on Sun, 06 Jan 2008 01:33:31 +0900 by phpDocumentor 1.3.2