API Documentation

InfoCard/Adapter/Interface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_InfoCard
subpackage
Adapter
version
$Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_InfoCard_Adapter_Interface

Description

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.

Zend_InfoCard_Adapter_Interface

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_InfoCard
subpackage
Adapter
Methods
storeAssertion
retrieveAssertion
removeAssertion

Description

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

Methods

removeAssertion

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

Remove the claims of a given assertion from persistent storage

Arguments
$asserionURI
string
The assertion type URI
$assertionID
string
The assertion ID to remove
Output
bool
True on success, false on failure
Details
visibility
public
final
false
static
false

retrieveAssertion

retrieveAssertion( string $assertionURI, string $assertionID ) : mixed

Retrieve the claims of a given assertion from persistent storage

Arguments
$assertionURI
string
The assertion type URI
$assertionID
string
The assertion ID to retrieve
Output
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
Details
visibility
public
final
false
static
false

storeAssertion

storeAssertion( string $assertionURI, string $assertionID, array $conditions ) : bool

Store the assertion's claims in persistent storage

Arguments
$assertionURI
string
The assertion type URI
$assertionID
string
The specific assertion ID
$conditions
array
An array of claims to store associated with the assertion
Output
bool
True on success, false on failure
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.