API Documentation

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

\Zend_InfoCard_Xml_Assertion_Saml

A Xml Assertion Document in SAML Token format

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

Constants

Constant  CONDITION_AUDIENCE = 'AudienceRestrictionCondition'

Audience Restriction Condition

Constant  CONFIRMATION_BEARER = 'urn:oasis:names:tc:SAML:1.0:cm:bearer'

The URI for a 'bearer' confirmation

Constant  CONDITION_TIME_ADJ = '3600'

The amount of time in seconds to buffer when checking conditions to ensure that differences between client/server clocks don't interfer too much

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_getServerName( ) : void

methodprotected_getServerPort( ) : void

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:
methodpublicgetAssertionID( ) : string

Get the Assertion ID of the assertion

Returns
Type Description
string The Assertion ID
methodpublicgetAssertionURI( ) : string

Get the Assertion URI for this type of Assertion

Returns
Type Description
string the Assertion URI
methodpublicgetAttributes( ) : array

Return an array of attributes (claims) contained within the assertion

Returns
Type Description
array An array of attributes / claims within the assertion
methodpublicgetConditions( ) : array

Return an array of conditions which the assertions are predicated on

Returns
Type Description
array an array of conditions
Throws
Exception Description
\Zend_InfoCard_Xml_Exception
methodpublicgetConfirmationMethod( ) : string

Return the Confirmation Method URI used in the Assertion

Returns
Type Description
string The confirmation method URI
methodpublicgetDocNamespaces( ) : void

Inherited from:
methodpublicgetIssuedTimestamp( ) : integer

Get the Timestamp of when the assertion was issued

Returns
Type Description
integer a UNIX timestamp representing when the assertion was issued
methodpublicgetIssuer( ) : string

Get the Issuer URI of the assertion

Returns
Type Description
string the URI of the assertion Issuer
methodpublicgetMajorVersion( ) : integer

Get the Major Version of the SAML Assertion

Returns
Type Description
integer The major version number
methodpublicgetMinorVersion( ) : integer

The Minor Version of the SAML Assertion

Returns
Type Description
integer The minor version number
methodpublicgetName( ) : void

Inherited from:
methodpublicgetNamespaces( ) : void

Inherited from:
methodpublicregisterXPathNamespace( ) : void

Inherited from:
methodpublicsaveXML( ) : void

Inherited from:
methodpublicvalidateConditions( array $conditions ) : mixed

Validate the conditions array returned from the getConditions() call

Parameters
Name Type Description
$conditions array

An array of condtions for the assertion taken from getConditions()

Returns
Type Description
mixed Boolean true on success, an array of condition, error message on failure
methodpublicxpath( ) : void

Inherited from:
Documentation was generated by DocBlox 0.13.3.