API Documentation

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

\Zend_OpenId_Extension

Package: Zend\OpenId

Abstract extension class for Zend_OpenId

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

Methods

methodpubliccheckTrustData( array $data ) : bool

Method to check if data from trusted servers database is enough to sutisfy request.

Parameters
Name Type Description
$data array

data from tusted servers database

Returns
Type Description
bool
methodpublicforAll( mixed $extensions, string $func, mixed $params ) : bool
static

Calls given function with given argument for all extensions

Parameters
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

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

Method to prepare data to store it in trusted servers database.

Parameters
Name Type Description
$data array

&$data data to be stored in tusted servers database

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

Method to parse OpenId 'checkid_immediate' or 'checkid_setup' request and initialize object with passed data. This method parses nothing but inherited class may override this method to do somthing.

Parameters
Name Type Description
$params array

request's var/val pairs

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

Method to parse OpenId 'id_res' response and initialize object with passed data. This method parses nothing but inherited class may override this method to do somthing.

Parameters
Name Type Description
$params array

response's var/val pairs

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

Method to add additional data to OpenId 'checkid_immediate' or 'checkid_setup' request. This method addes nothing but inherited class may add additional data into request.

Parameters
Name Type Description
$params array

&$params request's var/val pairs

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

Method to add additional data to OpenId 'id_res' response. This method addes nothing but inherited class may add additional data into 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.