OpenId/Extension/Sreg.php

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
version: $Id: Sreg.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_OpenId_Extension_Sreg

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_Extension_Sreg
jump to top

Extends from: Zend_OpenId_Extension
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
Constants: NAMESPACE_1_1
Properties: $_props; $_policy_url; $_version
Methods: __construct; getProperties; getPolicyUrl; getVersion; getSregProperties; prepareRequest; parseRequest; prepareResponse; parseResponse; getTrustData; checkTrustData

Description

'Simple Refistration Extension' for Zend_OpenId

Constants

NAMESPACE_1_1
jump to class

 NAMESPACE_1_1 = 'http://openid.net/extensions/sreg/1.1'

SREG 1.1 namespace. All OpenID SREG 1.1 messages MUST contain variable openid.ns.sreg with its value.

Details

value: http://openid.net/extensions/sreg/1.1

Properties

$_policy_url
jump to class

$_policy_url = ''

Details

visibility: private
default
final: false
static: false

$_props
jump to class

$_props = ''

Details

visibility: private
default
final: false
static: false

$_version
jump to class

$_version = ''

Details

visibility: private
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $props
              =
              null, string $policy_url
              =
              null, float $version
              =
              1.0
          )
        
        :
        array

Creates SREG extension object

Arguments

$props: array
associative array of SREG variables
$policy_url: string
SREG policy URL
$version: float
SREG version

Output

array

Details

visibility: public
final: false
static: false

checkTrustData
jump to class

checkTrustData(
          array $data
          )
        
        :
        bool

Check if given $data contains necessury SREG properties to sutisfy OpenId request. On success sets SREG response properties from given $data and returns true, on failure returns false.

Arguments

$data: array
data from tusted servers database

Output

bool

Details

visibility: public
final: false
static: false

getPolicyUrl
jump to class

getPolicyUrl(
          
          )
        
        :
        string

Returns SREG policy URL

Output

string

Details

visibility: public
final: false
static: false

getProperties
jump to class

getProperties(
          
          )
        
        :
        array

Returns associative array of SREG variables

Output

array

Details

visibility: public
final: false
static: false

getSregProperties
jump to class

getSregProperties(
          
          )
        
        :
        array

Returns array of allowed SREG variable names.

Output

array

Details

visibility: public
final: false
static: true

getTrustData
jump to class

getTrustData(
          array $data
          )
        
        :
        bool

Addes SREG properties that are allowed to be send to consumer to the given $data argument.

Arguments

$data: array
&$data data to be stored in tusted servers database

Output

bool

Details

visibility: public
final: false
static: false

getVersion
jump to class

getVersion(
          
          )
        
        :
        float

Returns SREG protocol version

Output

float

Details

visibility: public
final: false
static: false

parseRequest
jump to class

parseRequest(
          array $params
          )
        
        :
        bool

Parses OpenId 'checkid_immediate' or 'checkid_setup' request, extracts SREG variables and sets ovject properties to corresponding values.

Arguments

$params: array
request's var/val pairs

Output

bool

Details

visibility: public
final: false
static: false

parseResponse
jump to class

parseResponse(
          array $params
          )
        
        :
        bool

Parses OpenId 'id_res' response and sets object's properties according to 'openid.sreg.*' variables in response

Arguments

$params: array
response's var/val pairs

Output

bool

Details

visibility: public
final: false
static: false

prepareRequest
jump to class

prepareRequest(
          array $params
          )
        
        :
        bool

Adds additional SREG data to OpenId 'checkid_immediate' or 'checkid_setup' request.

Arguments

$params: array
&$params request's var/val pairs

Output

bool

Details

visibility: public
final: false
static: false

prepareResponse
jump to class

prepareResponse(
          array $params
          )
        
        :
        bool

Adds additional SREG data to OpenId 'id_res' response.

Arguments

$params: array
&$params response's var/val pairs

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

OpenId/Extension/Sreg.php

Description

Zend_OpenId_Extension_Sregjump to top

Description

Constants

NAMESPACE_1_1jump to class

Details

Properties

$_policy_urljump to class

Details

$_propsjump to class

Details

$_versionjump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

checkTrustDatajump to class

Arguments

Output

Details

getPolicyUrljump to class

Output

Details

getPropertiesjump to class

Output

Details

getSregPropertiesjump to class

Output

Details

getTrustDatajump to class

Arguments

Output

Details

getVersionjump to class

Output

Details

parseRequestjump to class

Arguments

Output

Details

parseResponsejump to class

Arguments

Output

Details

prepareRequestjump to class

Arguments

Output

Details

prepareResponsejump to class

Arguments

Output

Details

Zend_OpenId_Extension_Sreg
jump to top

NAMESPACE_1_1
jump to class

$_policy_url
jump to class

$_props
jump to class

$_version
jump to class

__construct
jump to class

checkTrustData
jump to class

getPolicyUrl
jump to class

getProperties
jump to class

getSregProperties
jump to class

getTrustData
jump to class

getVersion
jump to class

parseRequest
jump to class

parseResponse
jump to class

prepareRequest
jump to class

prepareResponse
jump to class