API Documentation

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

\Zend_InfoCard_Xml_SecurityTokenReference

Represents a SecurityTokenReference XML block

Extends from
\Zend_InfoCard_Xml_Element
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  

Constants

Constant  ENCODING_BASE64BIN = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary'

Base64 Binary Encoding URI

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
methodprotected_getKeyIdentifier( ) : \Zend_InfoCard_Xml_Element

Return the Key Identifier XML Object

Returns
Type Description
\Zend_InfoCard_Xml_Element
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
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:
methodpublicgetDocNamespaces( ) : void

Inherited from:
methodpublicgetInstance( string $xmlData ) : \Zend_InfoCard_Xml_SecurityTokenReference
static

Return an instance of the object based on the input XML

Parameters
Name Type Description
$xmlData string The SecurityTokenReference XML Block
Returns
Type Description
\Zend_InfoCard_Xml_SecurityTokenReference
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetKeyReference( bool $decode = true ) : string

Get the key reference data used to identify the public key

Parameters
Name Type Description
$decode bool if true, will return a decoded version of the key
Returns
Type Description
string the key reference thumbprint, either in binary or encoded form
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetKeyThumbprintEncodingType( ) : string

Return the thumbprint encoding type used as a URI

Returns
Type Description
string the URI of the thumbprint encoding used
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetKeyThumbprintType( ) : string

Return the Key URI identifying the thumbprint type used

Returns
Type Description
string The thumbprint type URI
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.