API Documentation

InfoCard/Adapter/Interface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_InfoCard  
subpackage
Adapter  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_InfoCard_Adapter_Interface

The interface required by all Zend_InfoCard Adapter classes to implement. It represents a series of callback methods used by the component during processing of an information card

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_InfoCard  
subpackage
Adapter  

Methods

methodpublicremoveAssertion( string $asserionURI, string $assertionID ) : bool

Remove the claims of a given assertion from persistent storage

Parameters
Name Type Description
$asserionURI string The assertion type URI
$assertionID string The assertion ID to remove
Returns
Type Description
bool True on success, false on failure
methodpublicretrieveAssertion( string $assertionURI, string $assertionID ) : mixed

Retrieve the claims of a given assertion from persistent storage

Parameters
Name Type Description
$assertionURI string The assertion type URI
$assertionID string The assertion ID to retrieve
Returns
Type Description
mixed False if the assertion ID was not found for that URI, or an array of conditions associated with that assertion if found in the same format provided
methodpublicstoreAssertion( string $assertionURI, string $assertionID, array $conditions ) : bool

Store the assertion's claims in persistent storage

Parameters
Name Type Description
$assertionURI string The assertion type URI
$assertionID string The specific assertion ID
$conditions array An array of claims to store associated with the assertion
Returns
Type Description
bool True on success, false on failure
Documentation was generated by DocBlox 0.13.3.