PHP Class SAML2\XML\saml\NameIDType

Inheritance: extends BaseIDType
Show file Open project: simplesamlphp/saml2 Class Usage Examples

Public Properties

Property Type Description
$Format string | null When a Format value other than one specified in Section 8.3 is used, the content of an element of this type is to be interpreted according to the definition of that format as provided outside of this specification. If not otherwise indicated by the definition of the format, issues of anonymity, pseudonymity, and the persistence of the identifier with respect to the asserting and relying parties are implementation-specific.
$SPProvidedID string | null A name identifier established by a service provider or affiliation of providers for the entity, if different from the primary name identifier given in the content of the element. This attribute provides a means of integrating the use of SAML with existing identifiers already in use by a service provider. For example, an existing identifier can be "attached" to the entity using the Name Identifier Management protocol defined in Section 3.6.
$value string | null The NameIDType complex type is used when an element serves to represent an entity by a string-valued name.

Public Methods

Method Description
__construct ( DOMElement $xml = null ) Initialize a saml:NameIDType, either from scratch or from an existing \DOMElement.
toXML ( DOMElement $parent = null ) : DOMElement Convert this NameIDType to XML.

Method Details

__construct() public method

Initialize a saml:NameIDType, either from scratch or from an existing \DOMElement.
public __construct ( DOMElement $xml = null )
$xml DOMElement The XML element we should load, if any.

toXML() public method

Convert this NameIDType to XML.
public toXML ( DOMElement $parent = null ) : DOMElement
$parent DOMElement
return DOMElement The XML element after adding the data corresponding to this NameIDType.

Property Details

$Format public property

When a Format value other than one specified in Section 8.3 is used, the content of an element of this type is to be interpreted according to the definition of that format as provided outside of this specification. If not otherwise indicated by the definition of the format, issues of anonymity, pseudonymity, and the persistence of the identifier with respect to the asserting and relying parties are implementation-specific.
public string|null $Format
return string | null

$SPProvidedID public property

A name identifier established by a service provider or affiliation of providers for the entity, if different from the primary name identifier given in the content of the element. This attribute provides a means of integrating the use of SAML with existing identifiers already in use by a service provider. For example, an existing identifier can be "attached" to the entity using the Name Identifier Management protocol defined in Section 3.6.
public string|null $SPProvidedID
return string | null

$value public property

The NameIDType complex type is used when an element serves to represent an entity by a string-valued name.
public string|null $value
return string | null