PHP 클래스 Horde_Session, horde

저자: Michael Slusarz ([email protected])
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$maxStore integer Maximum size of the pruneable data store.
$sessionHandler Horde_SessionHandler The session handler object.

보호된 프로퍼티들

프로퍼티 타입 설명
$_active boolean Indicates that the session is active (read/write).
$_cleansession boolean Indicate that a new session ID has been generated for this page load.
$_data array Pointer to the session data.
$_readonly boolean Indicates that session data is read-only.
$_relogin integer On re-login, indicate whether we were previously authenticated.

공개 메소드들

메소드 설명
__construct ( ) Constructor.
__get ( $name )
__set ( $name, $value )
checkNonce ( string $nonce ) Checks the validity of the session nonce.
checkToken ( string $token ) Checks the validity of the session token.
clean ( ) : boolean Destroys any existing session on login and make sure to use a new session ID, to avoid session fixation issues. Should be called before checking a login.
close ( ) Close the current session.
destroy ( ) Destroy session data.
exists ( string $app, string $name ) : boolean Does the session variable exist?
get ( string $app, string $name, integer $mask ) : mixed Get the value of a session variable.
getNonce ( ) : string Returns a single-use, session nonce.
getToken ( ) : string Returns the session token.
isActive ( ) : boolean Is the current session active (read/write)?
purge ( $id )
regenerate ( ) Regenerate the session ID.
remove ( string $app, string $name = null ) Remove session key(s).
retrieve ( $id )
set ( string $app, string $name, mixed $value, integer $mask ) Sets the value of a session variable.
setup ( boolean $start = true, string $cache_limiter = null, string $session_id = null ) Sets a custom session handler up, if there is one.
start ( ) Starts the session.
store ( $data, $prune = true, $id = null )

비공개 메소드들

메소드 설명
_getKey ( string $app, string $name ) : string Generates the unique storage key.
_start ( ) Tasks to perform when starting a session.
_subkeys ( string $app, string $name ) : array Return the list of subkeys for a master key.

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( )

__get() 공개 메소드

public __get ( $name )

__set() 공개 메소드

public __set ( $name, $value )

checkNonce() 공개 메소드

Checks the validity of the session nonce.
부터: 2.11.0
public checkNonce ( string $nonce )
$nonce string Nonce to check.

checkToken() 공개 메소드

Checks the validity of the session token.
public checkToken ( string $token )
$token string Token to check.

clean() 공개 메소드

Destroys any existing session on login and make sure to use a new session ID, to avoid session fixation issues. Should be called before checking a login.
public clean ( ) : boolean
리턴 boolean True if the session was cleaned.

close() 공개 메소드

Close the current session.
public close ( )

destroy() 공개 메소드

Destroy session data.
public destroy ( )

exists() 공개 메소드

Does the session variable exist?
public exists ( string $app, string $name ) : boolean
$app string Application name.
$name string Session variable name.
리턴 boolean True if session variable exists.

get() 공개 메소드

Get the value of a session variable.
public get ( string $app, string $name, integer $mask ) : mixed
$app string Application name.
$name string Session variable name.
$mask integer One of: - Horde_Session::TYPE_ARRAY - Return an array value. - Horde_Session::TYPE_OBJECT - Return an object value.
리턴 mixed The value or null if the value doesn't exist.

getNonce() 공개 메소드

Returns a single-use, session nonce.
부터: 2.11.0
public getNonce ( ) : string
리턴 string Session nonce.

getToken() 공개 메소드

Returns the session token.
public getToken ( ) : string
리턴 string Session token.

isActive() 공개 메소드

Is the current session active (read/write)?
public isActive ( ) : boolean
리턴 boolean True if the current session is active.

purge() 공개 메소드

사용 중단: Use Horde_Core_Cache_SessionObjects instead.
public purge ( $id )

regenerate() 공개 메소드

Regenerate the session ID.
부터: 2.5.0
public regenerate ( )

remove() 공개 메소드

Remove session key(s).
public remove ( string $app, string $name = null )
$app string Application name.
$name string Session variable name.

retrieve() 공개 메소드

사용 중단: Use Horde_Core_Cache_SessionObjects instead.
public retrieve ( $id )

set() 공개 메소드

Sets the value of a session variable.
public set ( string $app, string $name, mixed $value, integer $mask )
$app string Application name.
$name string Session variable name.
$value mixed Session variable value.
$mask integer One of: - Horde_Session::TYPE_ARRAY: Force save as an array value. - Horde_Session::TYPE_OBJECT: Force save as an object value. - Horde_Session::ENCRYPT: Encrypt the value. (since 2.7.0)

setup() 공개 메소드

Sets a custom session handler up, if there is one.
public setup ( boolean $start = true, string $cache_limiter = null, string $session_id = null )
$start boolean Initiate the session?
$cache_limiter string Override for the session cache limiter value.
$session_id string The session ID to use.

start() 공개 메소드

Starts the session.
public start ( )

store() 공개 메소드

사용 중단: Use Horde_Core_Cache_SessionObjects instead.
public store ( $data, $prune = true, $id = null )

프로퍼티 상세

$_active 보호되어 있는 프로퍼티

Indicates that the session is active (read/write).
protected bool $_active
리턴 boolean

$_cleansession 보호되어 있는 프로퍼티

Indicate that a new session ID has been generated for this page load.
protected bool $_cleansession
리턴 boolean

$_data 보호되어 있는 프로퍼티

Pointer to the session data.
protected array $_data
리턴 array

$_readonly 보호되어 있는 프로퍼티

Indicates that session data is read-only.
protected bool $_readonly
리턴 boolean

$_relogin 보호되어 있는 프로퍼티

On re-login, indicate whether we were previously authenticated.
protected int $_relogin
리턴 integer

$maxStore 공개적으로 프로퍼티

Maximum size of the pruneable data store.
public int $maxStore
리턴 integer

$sessionHandler 공개적으로 프로퍼티

The session handler object.
public Horde_SessionHandler $sessionHandler
리턴 Horde_SessionHandler