API Documentation

InfoCard/Xml/EncryptedKey.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
Zend_InfoCard_Xml  
version
$Id: EncryptedKey.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_InfoCard_Xml_EncryptedKey

An object representing an Xml EncryptedKEy block

Extends from
\Zend_InfoCard_Xml_Element
Implements
\Zend_InfoCard_Xml_KeyInfo_Interface
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_InfoCard  
subpackage
Zend_InfoCard_Xml  

Methods

methodpublic__construct( ) : void
final

Inherited from:
methodpublic__toString( ) : string

Convert the object to a string by displaying its XML content

Inherited from: \Zend_InfoCard_Xml_Element::__toString()
Returns
Type Description
string an XML representation of the object
methodpublicaddAttribute( ) : void

Inherited from:
methodpublicaddChild( ) : void

Inherited from:
methodpublicasXML( ) : void

Return the data within the object as an XML document

Inherited from: \Zend_InfoCard_Xml_Element_Interface::asXML()
methodpublicattributes( ) : void

Inherited from:
methodpublicchildren( ) : void

Inherited from:
methodpublicconvertToDOM( \Zend_InfoCard_Xml_Element $e ) : \DOMElement
static

Converts an XML Element object into a DOM object

Inherited from: \Zend_InfoCard_Xml_Element::convertToDOM()
Parameters
Name Type Description
$e \Zend_InfoCard_Xml_Element The object to convert
Returns
Type Description
\DOMElement A DOMElement representation of the same object
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicconvertToObject( \DOMElement $e, string $classname ) : \Zend_InfoCard_Xml_Element
static

Converts a DOMElement object into the specific class

Inherited from: \Zend_InfoCard_Xml_Element::convertToObject()
Parameters
Name Type Description
$e \DOMElement The DOMElement object to convert
$classname string

The name of the class to convert it to (must inhert from Zend_InfoCard_Xml_Element)

Returns
Type Description
\Zend_InfoCard_Xml_Element a Xml Element object from the DOM element
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpubliccount( ) : void

Inherited from:
methodpublicgetCipherValue( ) : string

Return the encrypted value of the block in base64 format

Returns
Type Description
string The Value of the CipherValue block in base64 format
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetDigestMethod( ) : string

Returns the Digest Method Algorithm URI used

Returns
Type Description
string the Digest Method Algorithm URI
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetDocNamespaces( ) : void

Inherited from:
methodpublicgetEncryptionMethod( ) : string

Returns the Encyption Method Algorithm URI of the block

Returns
Type Description
string the Encryption method algorithm URI
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetInstance( string $xmlData ) : \Zend_InfoCard_Xml_EncryptedKey
static

Return an instance of the object based on input XML Data

Parameters
Name Type Description
$xmlData string The EncryptedKey XML Block
Returns
Type Description
\Zend_InfoCard_Xml_EncryptedKey
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetKeyInfo( ) : \Zend_InfoCard_Xml_KeyInfo_Abstract

Returns the KeyInfo block object

Returns
Type Description
\Zend_InfoCard_Xml_KeyInfo_Abstract
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetName( ) : void

Inherited from:
methodpublicgetNamespaces( ) : void

Inherited from:
methodpublicregisterXPathNamespace( ) : void

Inherited from:
methodpublicsaveXML( ) : void

Inherited from:
methodpublicxpath( ) : void

Inherited from:
Documentation was generated by DocBlox 0.13.3.