SilverStripe\RealMe\Model\FederatedIdentity
Class RealMeFederatedIdentity
Contains data to describe an identity, verified by RealMe. Provides simpler access to identity information, rather
than having to parse XML via or similar.
All public methods return individual elements from the federated identity.
Standard usage:
Injector::inst()->get('RealMeService')->enforceLogin(); // Enforce login and ensure auth data exists
$identity = Injector::inst()->get('RealMeService')->getAuthData()->getIdentity();
Notes:
- We can't store the original DOMDocument as it's not possible to properly serialize and unserialize this such that
it can be stored in session. Therefore, during object instantiation, we parse the XML, and store individual details
directly against properties.
- See this object's constructor for the XML / DOMDocument object expected to be passed during instantiation.
Synopsis
- // constants
- const SOURCE_XML = 'urn:nzl:govt:ict:stds:authn:safeb64:attribute:igovt:IVS:Assertion:Identity';
- const SOURCE_JSON = 'urn:nzl:govt:ict:stds:authn:safeb64:attribute:igovt:IVS:Assertion:JSON:Identity';
- // members
- private $nameId;
- public $FirstName;
- public $MiddleName;
- public $LastName;
- public $Gender;
- public DOMNodeList $BirthInfoQuality;
- public $BirthYear;
- public $BirthMonth;
- public $BirthDay;
- public $BirthPlaceQuality;
- public $BirthPlaceCountry;
- public $BirthPlaceLocality;
- // methods
- public void __construct()
- public static void createFromXML()
- public void isValid()
- public void getDateOfBirth()
- private static string|null getNamedItemNodeValue()
- private static string|null getNodeValue()
- public static void createFromJSON()
Hierarchy
Extends
- SilverStripe\View\ViewableData
Constants
Name | Value |
---|---|
SOURCE_XML | 'urn:nzl:govt:ict:stds:authn:safeb64:attribute:igovt:IVS:Assertion:Identity' |
SOURCE_JSON | 'urn:nzl:govt:ict:stds:authn:safeb64:attribute:igovt:IVS:Assertion:JSON:Identity' |
Members
private
- $nameId — string
public
- $BirthDay — string
- $BirthInfoQuality — SilverStripe\RealMe\Model\DOMNodeList
- $BirthMonth — string
- $BirthPlaceCountry — string
- $BirthPlaceLocality — string
- $BirthPlaceQuality — string
- $BirthYear — string
- $FirstName — string
- $Gender — string
- $LastName — string
- $MiddleName — string
Methods
private
public
- __construct()
- createFromJSON() — create a FederatedIdentity from a JSON string.
- createFromXML() — Constructor that sets the expected federated identity details based on a provided DOMDocument. The expected XML structure for the DOMDocument is the following:
- getDateOfBirth()
- isValid()