Class SimpleID\Protocols\XRDS\XRDSParser

A simple XRDS parser.

This parser uses the classic expat functions available in PHP to parse the XRDS Simple XML document.

The result is a XRDSServices object.

Located at core/Protocols/XRDS/XRDSParser.php

Methods


					
	public

__construct()

Creates an instance of the XRDS parser.

This constructor also initialises the underlying XML parser.


					
	public

close(): void

Frees memory associated with the underlying XML parser.

Note that only the memory associated with the underlying XML parser is freed. Memory associated with the class itself is not freed.


					
	public

load(string $xml): void

Loads an XRDS document.

Parameters

$xml

the XML document to load


					
	public

parse(): XRDSServices

Parses an XRDS document and returns the discovered services.

Returns

the discovered services


					
	protected

flatten_uris(array<array<string, mixed>> $array, bool $sort = true): array<array<string, mixed>>

Flattens the service array.

In an XRDS document, child elements of the service element often contains a list of URIs, with the priority specified in the priority attribute.

When the document is parsed in this class, the URI and the priority are first extracted into the #uri and the #priority keys respectively. This function takes this array, sorts the elements using the #priority keys (if $sort is true), then collapses the array using the value associated with the #uri key.

Parameters

`$array`	the service array, with URIs and priorities
`$sort`	whether to sort the service array using the #priority keys

Returns

the services array with URIs sorted by priority

Constants
`public`	`XRDS_NS = 'xri://$xrds'` The namespace identifier for an XRDS document. The namespace identifier for an XRDS document.	#
`public`	`XRD2_NS = 'xri://$xrd($v2.0)'` The namespace identifier for XRDS version 2. The namespace identifier for XRDS version 2.	#
`public`	`XRDS_SIMPLE_NS = 'http://xrds-simple.net/core/1.0'` The namespace identifier for XRDS Simple. The namespace identifier for XRDS Simple.	#
`public`	`XRDS_SIMPLE_TYPE = 'xri://$xrds*simple'` The type identifier for XRDS Simple. The type identifier for XRDS Simple.	#
`public`	`XRD_OPENID_NS = 'http://openid.net/xmlns/1.0'` The namespace identifier for OpenID services. The namespace identifier for OpenID services.	#

Namespaces

Classes

Class SimpleID\Protocols\XRDS\XRDSParser

Parameters

Returns

Parameters

Returns