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

Class: HTTP_SessionServer_Storage

Source Location: /HTTP_SessionServer-0.5.0/SessionServer/Storage.php

Class Overview


Session storage base class


Author(s):

Methods


Child classes:

HTTP_SessionServer_Storage_DB
Session storage for filesystem database.
HTTP_SessionServer_Storage_Filesystem
Session storage for filesystem
HTTP_SessionServer_Storage_MDB2
Session storage for filesystem database.

Inherited Variables

Inherited Methods


Class Details

[line 51]
Session storage base class


[ Top ]


Method Detail

HTTP_SessionServer_Storage (Constructor)   [line 91]

HTTP_SessionServer_Storage HTTP_SessionServer_Storage( [array $options = array()])

constructor
  • Access: public

Parameters:

array   $options     

[ Top ]

close   [line 128]

boolean close( )

close the session
  • Access: public

Overridden in child classes as:

HTTP_SessionServer_Storage_DB::close()
close the session
HTTP_SessionServer_Storage_Filesystem::close()
close the session
HTTP_SessionServer_Storage_MDB2::close()
close the session

[ Top ]

commit   [line 142]

boolean commit( )

commit the session
  • Access: public

Overridden in child classes as:

HTTP_SessionServer_Storage_DB::commit()
commit the session
HTTP_SessionServer_Storage_Filesystem::commit()
commit the session
HTTP_SessionServer_Storage_MDB2::commit()
commit the session

[ Top ]

destroy   [line 217]

boolean destroy( )

destroy the current session
  • Access: public

Overridden in child classes as:

HTTP_SessionServer_Storage_DB::destroy()
destroy the current session
HTTP_SessionServer_Storage_Filesystem::destroy()
destroy the current session
HTTP_SessionServer_Storage_MDB2::destroy()
destroy the current session

[ Top ]

exists   [line 187]

boolean exists( string $key)

check, whether a key exists
  • Access: public

Parameters:

string   $key     key

[ Top ]

generateNewId   [line 102]

string generateNewId( )

generate a new session id
  • Access: public

[ Top ]

get   [line 155]

mixed get( string $key)

get a value from the session
  • Return: value for the given key
  • Access: public

Parameters:

string   $key     key

[ Top ]

getAll   [line 254]

array getAll( )

get all values in the session
  • Access: public

[ Top ]

getKeys   [line 280]

array getKeys( )

get all session keys
  • Access: public

[ Top ]

isOpen   [line 291]

array isOpen( )

check, whether the session is open
  • Access: public

[ Top ]

open   [line 115]

boolean open( string $sid, [integer $mode = HTTP_SESSIONSERVER_STORAGE_MODE_READWRITE])

open an existing session
  • Access: public

Overridden in child classes as:

HTTP_SessionServer_Storage_DB::open()
Opens an existing session or creates a new one.
HTTP_SessionServer_Storage_Filesystem::open()
open an existing session
HTTP_SessionServer_Storage_MDB2::open()
Opens an existing session or creates a new one.

Parameters:

string   $sid     session id
integer   $mode     mode

[ Top ]

put   [line 171]

boolean put( string $key, mixed $value)

store a value in the session
  • Access: public

Parameters:

string   $key     key
mixed   $value     value

[ Top ]

regenerateId   [line 234]

string regenerateId( )

chage the session id
  • Access: public

[ Top ]

remove   [line 199]

boolean remove( string $key)

remove a value from the session
  • Access: public

Parameters:

string   $key     key

[ Top ]

setAll   [line 265]

void setAll( array $data)

set all values in the session
  • Access: public

Parameters:

array   $data     

[ Top ]


Documentation generated on Tue, 07 Feb 2006 14:03:10 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.