InfoCard/Xml/EncryptedKey.php

Show: PublicProtectedPrivateinherited
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
Zend_InfoCard_Xml  
Version
$Id: EncryptedKey.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_InfoCard_Xml_EncryptedKey

Package: Zend\InfoCard\Zend\InfoCard\Xml
An object representing an Xml EncryptedKEy block
Implements
\Zend_InfoCard_Xml_KeyInfo_Interface
Parent(s)
\Zend_InfoCard_Xml_Element < \SimpleXMLElement
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpublic__toString() : string
inherited

Convert the object to a string by displaying its XML content

Inherited from: \Zend_InfoCard_Xml_Element::__toString()
Returns
TypeDescription
stringan XML representation of the object
methodpublicasXML() : void
inherited

Return the data within the object as an XML document

Inherited from: \Zend_InfoCard_Xml_Element_Interface::asXML()\Zend_InfoCard_Xml_Element::asXML()
methodpublicconvertToDOM(\Zend_InfoCard_Xml_Element $e) : \DOMElement
staticinherited

Converts an XML Element object into a DOM object

Inherited from: \Zend_InfoCard_Xml_Element::convertToDOM()
Parameters
NameTypeDescription
$e\Zend_InfoCard_Xml_Element

The object to convert

Returns
TypeDescription
\DOMElementA DOMElement representation of the same object
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicconvertToObject(\DOMElement $e, string $classname) : \Zend_InfoCard_Xml_Element
staticinherited

Converts a DOMElement object into the specific class

Inherited from: \Zend_InfoCard_Xml_Element::convertToObject()
Parameters
NameTypeDescription
$e\DOMElement

The DOMElement object to convert

$classnamestring

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

Returns
TypeDescription
\Zend_InfoCard_Xml_Elementa Xml Element object from the DOM element
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicgetCipherValue() : string

Return the encrypted value of the block in base64 format

Returns
TypeDescription
stringThe Value of the CipherValue block in base64 format
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicgetDigestMethod() : string

Returns the Digest Method Algorithm URI used

Returns
TypeDescription
stringthe Digest Method Algorithm URI
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicgetEncryptionMethod() : string

Returns the Encyption Method Algorithm URI of the block

Returns
TypeDescription
stringthe Encryption method algorithm URI
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicgetInstance(string $xmlData) : \Zend_InfoCard_Xml_EncryptedKey
static

Return an instance of the object based on input XML Data

Parameters
NameTypeDescription
$xmlDatastring

The EncryptedKey XML Block

Returns
TypeDescription
\Zend_InfoCard_Xml_EncryptedKey
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
methodpublicgetKeyInfo() : \Zend_InfoCard_Xml_KeyInfo_Abstract

Returns the KeyInfo block object

Returns
TypeDescription
\Zend_InfoCard_Xml_KeyInfo_Abstract
Throws
ExceptionDescription
\Zend_InfoCard_Xml_Exception
Documentation was generated by phpDocumentor 2.0.0a12.