OpenId/Extension/Sreg.php
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_OpenId_Extension_Sreg
- 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
Properties
Methods


__construct(array $props = null, string $policy_url = null, float $version = 1.0) : array
Creates SREG extension object
Name | Type | Description |
---|---|---|
$props | array | associative array of SREG variables |
$policy_url | string | SREG policy URL |
$version | float | SREG version |
Type | Description |
---|---|
array |


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.
Name | Type | Description |
---|---|---|
$data | array | data from tusted servers database |
Type | Description |
---|---|
bool |


forAll(mixed $extensions, string $func, mixed $params) : bool
Calls given function with given argument for all extensions
Inherited from: \Zend_OpenId_Extension::forAll()Name | Type | Description |
---|---|---|
$extensions | mixed | list of extensions or one extension |
$func | string | function to be called |
$params | mixed | &$params argument to pass to given funcion |
Type | Description |
---|---|
bool |


getSregProperties() : array
Returns array of allowed SREG variable names.
Type | Description |
---|---|
array |


getTrustData(array $data) : bool
Addes SREG properties that are allowed to be send to consumer to the given $data argument.
Name | Type | Description |
---|---|---|
$data | array | &$data data to be stored in tusted servers database |
Type | Description |
---|---|
bool |


parseRequest(array $params) : bool
Parses OpenId 'checkid_immediate' or 'checkid_setup' request, extracts SREG variables and sets ovject properties to corresponding values.
This method parses nothing but inherited class may override this method to do somthing.
Name | Type | Description |
---|---|---|
$params | array | request's var/val pairs |
Type | Description |
---|---|
bool |


parseResponse(array $params) : bool
Parses OpenId 'id_res' response and sets object's properties according to 'openid.sreg.*' variables in response
This method parses nothing but inherited class may override this method to do somthing.
Name | Type | Description |
---|---|---|
$params | array | response's var/val pairs |
Type | Description |
---|---|
bool |


prepareRequest(array $params) : bool
Adds additional SREG data to OpenId 'checkid_immediate' or 'checkid_setup' request.
This method addes nothing but inherited class may add additional data into request.
Name | Type | Description |
---|---|---|
$params | array | &$params request's var/val pairs |
Type | Description |
---|---|
bool |