API Documentation

Zend/OpenId/Extension/Sreg.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  
Version
$Id: Sreg.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_OpenId_Extension_Sreg

Package: Zend\OpenId

'Simple Refistration Extension' for Zend_OpenId

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

Constants

Constant  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.

Properties

Propertyprivate  $_policy_url= ''
Details
Type
Propertyprivate  $_props= ''
Details
Type
Propertyprivate  $_version= ''
Details
Type

Methods

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

Creates SREG extension object

Parameters
Name Type Description
$props array

associative array of SREG variables

$policy_url string

SREG policy URL

$version float

SREG version

Returns
Type Description
array
methodpubliccheckTrustData( 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.

Parameters
Name Type Description
$data array

data from tusted servers database

Returns
Type Description
bool
methodpublicgetPolicyUrl( ) : string

Returns SREG policy URL

Returns
Type Description
string
methodpublicgetProperties( ) : array

Returns associative array of SREG variables

Returns
Type Description
array
methodpublicgetSregProperties( ) : array
static

Returns array of allowed SREG variable names.

Returns
Type Description
array
methodpublicgetTrustData( array $data ) : bool

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

Parameters
Name Type Description
$data array

&$data data to be stored in tusted servers database

Returns
Type Description
bool
methodpublicgetVersion( ) : float

Returns SREG protocol version

Returns
Type Description
float
methodpublicparseRequest( array $params ) : bool

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

Parameters
Name Type Description
$params array

request's var/val pairs

Returns
Type Description
bool
methodpublicparseResponse( array $params ) : bool

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

Parameters
Name Type Description
$params array

response's var/val pairs

Returns
Type Description
bool
methodpublicprepareRequest( array $params ) : bool

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

Parameters
Name Type Description
$params array

&$params request's var/val pairs

Returns
Type Description
bool
methodpublicprepareResponse( array $params ) : bool

Adds additional SREG data to OpenId 'id_res' response.

Parameters
Name Type Description
$params array

&$params response's var/val pairs

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.