API Documentation

OpenId/Provider/User/Session.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_OpenId
subpackage
Zend_OpenId_Provider
version
$Id: Session.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_OpenId_Provider_User_Session

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_OpenId_Provider_User_Session
jump to top

Extends from
Zend_OpenId_Provider_User
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_OpenId
subpackage
Zend_OpenId_Provider
Properties
$_session
Methods
__construct
setLoggedInUser
getLoggedInUser
delLoggedInUser

Description

Class to get/store information about logged in user in Web Browser using PHP session

Properties

$_session
jump to class

Zend_Session_Namespace $_session = 'null'

Reference to an implementation of Zend_Session_Namespace object

Details

$_session
Zend_Session_Namespace
visibility
private
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( Zend_Session_Namespace $session = null ) :

Creates Zend_OpenId_Provider_User_Session object with given session namespace or creates new session namespace named "openid"

Arguments
$session
Zend_Session_Namespace
Details
visibility
public
final
false
static
false

delLoggedInUser
jump to class

delLoggedInUser( ) : bool

Performs logout. Clears information about logged in user.

Output
bool
Details
visibility
public
final
false
static
false

getLoggedInUser
jump to class

getLoggedInUser( ) : mixed

Returns identity URL of logged in user or false

Output
mixed
Details
visibility
public
final
false
static
false

setLoggedInUser
jump to class

setLoggedInUser( string $id ) : bool

Stores information about logged in user in session data

Arguments
$id
string
user identity URL
Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.