OpenId/Extension/Sreg.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_OpenId  
Version
$Id$  

\Zend_OpenId_Extension_Sreg

Package: Zend_OpenId
'Simple Refistration Extension' for Zend_OpenId
Parent(s)
\Zend_OpenId_Extension
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  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

>VPropertyprivate$_policy_url
Details
Type
n/a
>VPropertyprivate$_props
Details
Type
n/a
>VPropertyprivate$_version
Details
Type
n/a

Methods

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

Creates SREG extension object

Parameters
NameTypeDescription
$propsarray

associative array of SREG variables

$policy_urlstring

SREG policy URL

$versionfloat

SREG version

Returns
TypeDescription
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
NameTypeDescription
$dataarray

data from tusted servers database

Returns
TypeDescription
bool
methodpublicgetPolicyUrl() : string

Returns SREG policy URL

Returns
TypeDescription
string
methodpublicgetProperties() : array

Returns associative array of SREG variables

Returns
TypeDescription
array
methodpublicgetSregProperties() : array
static

Returns array of allowed SREG variable names.

Returns
TypeDescription
array
methodpublicgetTrustData( $data) : bool

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

Parameters
NameTypeDescription
$data
Returns
TypeDescription
bool
methodpublicgetVersion() : float

Returns SREG protocol version

Returns
TypeDescription
float
methodpublicparseRequest(array $params) : bool

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

Parameters
NameTypeDescription
$paramsarray

request's var/val pairs

Returns
TypeDescription
bool
methodpublicparseResponse(array $params) : bool

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

Parameters
NameTypeDescription
$paramsarray

response's var/val pairs

Returns
TypeDescription
bool
methodpublicprepareRequest( $params) : bool

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

Parameters
NameTypeDescription
$params
Returns
TypeDescription
bool
methodpublicprepareResponse( $params) : bool

Adds additional SREG data to OpenId 'id_res' response.

Parameters
NameTypeDescription
$params
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.2.0 .