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

Class: HTTP_SessionServer_Client

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

Class Overview

PEAR
   |
   --HTTP_SessionServer_Client

Example client for the SessionServer


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 65]
Example client for the SessionServer


[ Top ]


Method Detail

HTTP_SessionServer_Client (Constructor)   [line 82]

HTTP_SessionServer_Client HTTP_SessionServer_Client( string $host, int $port)

constructor
  • Access: public

Parameters:

string   $host     host of the session server
int   $port     port of the session server

[ Top ]

_HTTP_SessionServer_Client (Destructor)   [line 95]

void _HTTP_SessionServer_Client( )

destructor

Disconnects the socket

  • Access: public

[ Top ]

close   [line 190]

void close( )

close an existing session
  • Access: public

[ Top ]

commit   [line 200]

void commit( )

commit the session (change mode to readonly)
  • Access: public

[ Top ]

create   [line 106]

string create( )

creates a new session
  • Return: new session id
  • Access: public

[ Top ]

destroy   [line 210]

void destroy( )

destroy an existing session
  • Access: public

[ Top ]

exists   [line 153]

string exists( string $key)

check, whether a value exists
  • Return: value
  • Access: public

Parameters:

string   $key     key

[ Top ]

get   [line 129]

string get( string $key)

get a session value
  • Return: value
  • Access: public

Parameters:

string   $key     key

[ Top ]

getAll   [line 232]

array getAll( )

get all session data as an array
  • Access: public

[ Top ]

getKeys   [line 175]

void getKeys( )

get all keys in the session
  • Access: public

[ Top ]

open   [line 117]

void open( string $sid, [mixed $mode = HTTP_SESSIONSERVER_CLIENT_MODE_READWRITE])

open an existing session
  • Access: public

Parameters:

string   $sid     session id

[ Top ]

put   [line 141]

void put( string $key, string $value)

store a session value
  • Access: public

Parameters:

string   $key     key
string   $value     value

[ Top ]

putAll   [line 247]

void putAll( array $data)

store all session data
  • Access: public

Parameters:

array   $data     

[ Top ]

regenerateId   [line 221]

string regenerateId( )

generate a new session id while keeping the session data
  • Return: new session id
  • Access: public

[ Top ]

remove   [line 165]

string remove( string $key)

remove a session value
  • Return: value
  • Access: public

Parameters:

string   $key     key

[ Top ]

_sendCommand   [line 261]

string _sendCommand( string $cmd, mixed 1)

utility function to send a command to the server
  • Return: return value of the command
  • Access: public

Parameters:

mixed   1     parameters (as many as the command requires)
string   $cmd     command

[ Top ]


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