Gumbo_Session_Basic



Session Class

Author(s): Michael Luster <mluster79@yahoo.com>
License:New BSD License
Copyright:Copyright (c) 2007, iBayou, Michael Luster
Link:http://sourceforge.net/projects/phpgumbo
Version:0.0.1

Implements interfaces:

Child classes:

Class Variables

string $_domain [line 42]
int $_lifetime =  0 [line 38]
string $_path [line 40]
bool $_secure =  false [line 44]

Class Methods

public string get ( string $key ) [line 270]

Returns the value of the Session variable

Parameter(s):

  • (string) $key
  • throws:  Gumbo_Exception
Overridden in child classes as:
Gumbo_Session_Encrypt::get()
Returns the value of the Session variable

Implementation of:
Gumbo_Interface_Session::get()

[ Top ]
public array getAll ( ) [line 292]

Returns the SESSION array

Implementation of:
Gumbo_Interface_Session::getAll()

[ Top ]
public string getDomain ( ) [line 316]

Returns the Session domain

Implementation of:
Gumbo_Interface_Session::getDomain()

[ Top ]
public string getId ( ) [line 252]

Returns the Session ID

Implementation of:
Gumbo_Interface_Session::getId()

[ Top ]
public int getLifetime ( ) [line 300]

Returns the Session lifetime

Implementation of:
Gumbo_Interface_Session::getLifetime()

[ Top ]
public string getName ( ) [line 260]

Returns the Session Name

Implementation of:
Gumbo_Interface_Session::getName()

[ Top ]
public string getPath ( ) [line 308]

Returns the Session path

Implementation of:
Gumbo_Interface_Session::getPath()

[ Top ]
public bool isSecure ( ) [line 324]

Returns if the Session is secure

Implementation of:
Gumbo_Interface_Session::isSecure()

[ Top ]
public void saveSettings ( int $lifetime, [string $path], [string $domain], [bool $secure] ) [line 139]

Sets the Session settings

Parameter(s):

  • (int) $lifetime
  • (string) $path
  • (string) $domain
  • (bool) $secure
Implementation of:
Gumbo_Interface_Session::saveSettings()

[ Top ]
public void set ( string $key, mix $val ) [line 155]

Sets a value inside the Session array

Parameter(s):

  • (string) $key
  • (mix) $val
  • throws:  Gumbo_Exception
Overridden in child classes as:
Gumbo_Session_Encrypt::set()
Sets a value inside the Session array

Implementation of:
Gumbo_Interface_Session::set()

[ Top ]
public void setDomain ( string $domain ) [line 212]

Sets the Session domain

Parameter(s):

  • (string) $domain
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::setDomain()

[ Top ]
public void setLifetime ( int $secs ) [line 174]

Sets the Session Lifetime

Parameter(s):

  • (int) $secs
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::setLifetime()

[ Top ]
public void setPath ( string $path ) [line 193]

Sets the Session path

Parameter(s):

  • (string) $path
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::setPath()

[ Top ]
public void setSecure ( bool $val ) [line 231]

Sets if the Session should be secure

Parameter(s):

  • (bool) $val
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::setSecure()

[ Top ]
public bool start ( ) [line 116]

Starts the Session

Implementation of:
Gumbo_Interface_Session::start()

[ Top ]
public void stop ( ) [line 124]

Stops the Session by removing all Session data

Implementation of:
Gumbo_Interface_Session::stop()

[ Top ]
public mix __get ( string $key ) [line 53]

Returns a SESSION value

Parameter(s):

  • (string) $key
Implementation of:
Gumbo_Interface_Session::__get()

[ Top ]
public bool __isset ( string $key ) [line 72]

Returns if a SESSION variable exists

Parameter(s):

  • (string) $key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::__isset()

[ Top ]
public void __set ( string $key, mix $val ) [line 62]

Sets the SESSION value

Parameter(s):

  • (string) $key
  • (mix) $val
Implementation of:
Gumbo_Interface_Session::__set()

[ Top ]
public void __unset ( string $key ) [line 92]

Unsets a SESSION variable

Parameter(s):

  • (string) $key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session::__unset()

[ Top ]