API Documentation

Zend/OpenId/Provider/User/Session.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_OpenId  
Subpackage
Zend_OpenId_Provider  
Version
$Id: Session.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_OpenId_Provider_User_Session

Package: Zend\OpenId\Zend\OpenId\Provider

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

Parent(s)
\Zend_OpenId_Provider_User
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivate\Zend_Session_Namespace  $_session= 'null'

Reference to an implementation of Zend_Session_Namespace object

Default valuenullDetails
Type
\Zend_Session_Namespace

Methods

methodpublic__construct( \Zend_Session_Namespace $session = null ) : void

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

Parameters
Name Type Description
$session \Zend_Session_Namespace
methodpublicdelLoggedInUser( ) : bool

Performs logout. Clears information about logged in user.

Returns
Type Description
bool
methodpublicgetLoggedInUser( ) : mixed

Returns identity URL of logged in user or false

Returns
Type Description
mixed
methodpublicsetLoggedInUser( string $id ) : bool

Stores information about logged in user in session data

Parameters
Name Type Description
$id string

user identity URL

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.