API Documentation

Zend/InfoCard/Adapter/Interface.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_InfoCard  
    Subpackage
    Adapter  
    Version
    $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_InfoCard_Adapter_Interface

    Package: Zend\InfoCard\Adapter

    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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    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.15.1.