web/lib/Zend/InfoCard/Adapter/Interface.php
changeset 64 162c1de6545a
parent 19 1c2f13fd785c
child 68 ecaf28ffe26e
equal deleted inserted replaced
63:5b37998e522e 64:162c1de6545a
       
     1 <?php
       
     2 /**
       
     3  * Zend Framework
       
     4  *
       
     5  * LICENSE
       
     6  *
       
     7  * This source file is subject to the new BSD license that is bundled
       
     8  * with this package in the file LICENSE.txt.
       
     9  * It is also available through the world-wide-web at this URL:
       
    10  * http://framework.zend.com/license/new-bsd
       
    11  * If you did not receive a copy of the license and are unable to
       
    12  * obtain it through the world-wide-web, please send an email
       
    13  * to license@zend.com so we can send you a copy immediately.
       
    14  *
       
    15  * @category   Zend
       
    16  * @package    Zend_InfoCard
       
    17  * @subpackage Adapter
       
    18  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
       
    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
       
    20  * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
       
    21  */
       
    22 
       
    23 /**
       
    24  * The interface required by all Zend_InfoCard Adapter classes to implement. It represents
       
    25  * a series of callback methods used by the component during processing of an information card
       
    26  *
       
    27  * @category   Zend
       
    28  * @package    Zend_InfoCard
       
    29  * @subpackage Adapter
       
    30  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
       
    31  * @license    http://framework.zend.com/license/new-bsd     New BSD License
       
    32  */
       
    33 interface Zend_InfoCard_Adapter_Interface
       
    34 {
       
    35     /**
       
    36      * Store the assertion's claims in persistent storage
       
    37      *
       
    38      * @param string $assertionURI The assertion type URI
       
    39      * @param string $assertionID The specific assertion ID
       
    40      * @param array $conditions An array of claims to store associated with the assertion
       
    41      * @return bool True on success, false on failure
       
    42      */
       
    43     public function storeAssertion($assertionURI, $assertionID, $conditions);
       
    44 
       
    45     /**
       
    46      * Retrieve the claims of a given assertion from persistent storage
       
    47      *
       
    48      * @param string $assertionURI The assertion type URI
       
    49      * @param string $assertionID The assertion ID to retrieve
       
    50      * @return mixed False if the assertion ID was not found for that URI, or an array of
       
    51      *               conditions associated with that assertion if found in the same format
       
    52      *                  provided
       
    53      */
       
    54     public function retrieveAssertion($assertionURI, $assertionID);
       
    55 
       
    56     /**
       
    57      * Remove the claims of a given assertion from persistent storage
       
    58      *
       
    59      * @param string $asserionURI The assertion type URI
       
    60      * @param string $assertionID The assertion ID to remove
       
    61      * @return bool True on success, false on failure
       
    62      */
       
    63     public function removeAssertion($asserionURI, $assertionID);
       
    64 }