Class: Services_Yadis
Source Location: /Services_Yadis-0.5.2/Services/Yadis.php
Services_Yadis class
Author(s):
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
__construct (Constructor) [line 209]
void __construct(
[string
$yadisId = null], [array
$namespaces = array()])
|
|
Class Constructor Allows settings of the initial Yadis ID (an OpenID URL for example) and an optional list of additional namespaces. For example, OpenID uses a namespace such as: xmlns:openid="http://openid.net/xmlns/1.0" Namespaces are assigned to a Services_Yadis_Xrds_Namespace container object to be passed more easily to other objects being
Parameters:
addNamespace [line 359]
Add a single namespace to be utilised by the XML parser when it receives a valid XRD document.
Parameters:
addNamespaces [line 344]
Add a list (array) of additional namespaces to be utilised by the XML parser when it receives a valid XRD document.
Parameters:
discover [line 396]
Performs Service Discovery, i.e. the requesting and parsing of a valid Yadis (XRD) document into a list of Services and Service Data. The return value will be an instance of Services_Yadis_Xrds which will implement SeekableIterator. Returns FALSE on failure.
get [line 534]
HTTP_Request2 get(
string
$url)
|
|
Use the HTTP_Request2 to issue an HTTP GET request carrying the "Accept" header value of "application/xrds+xml". This can allow servers to quickly respond with a valid XRD document rather than forcing the client to follow the X-XRDS-Location bread crumb trail.
Parameters:
getHttpRequest [line 494]
HTTP_Request2 getHttpRequest(
)
|
|
Gets the HTTP_Request2 object
getHttpRequestOptions [line 236]
array getHttpRequestOptions(
)
|
|
Get options to be passed to the PEAR HTTP_Request2 constructor
getHTTPResponse [line 469]
HTTP_Request2_Response getHTTPResponse(
)
|
|
Return the final HTTP response
getNamespace [line 372]
string|null getNamespace(
string
$namespace)
|
|
Return the value of a specific namespace.
Parameters:
getNamespaces [line 382]
Returns an array of all currently set namespaces.
getResponseType [line 512]
integer getResponseType(
HTTP_Request2_Response
$response, HTTP_Request2_Response
$request)
|
|
Run any instance of HTTP_Request2_Response through a set of filters to determine the Yadis Response type which in turns determines how the response should be reacted to or dealt with.
Parameters:
getYadisId [line 265]
Returns the original Yadis ID string set for this class.
getYadisUrl [line 326]
Returns the Yadis URL. This will usually be identical to the Yadis ID, unless the Yadis ID (in the future) was one of IRI, XRI or i-name which required transformation to a valid URI.
isMetaHttpEquiv [line 608]
boolean isMetaHttpEquiv(
HTTP_Request2_Response
$response)
|
|
Assuming this user is hosting a third party sourced identity under an alias personal URL, we'll need to check if the website's HTML body has a http-equiv meta element with a content attribute pointing to where we can fetch the XRD document.
Parameters:
isXrdsContentType [line 586]
boolean isXrdsContentType(
HTTP_Request2_Response
$response)
|
|
Checks whether the Response contains the XRDS resource. It should, per the specifications always be served as application/xrds+xml
Parameters:
isXrdsLocationHeader [line 559]
boolean isXrdsLocationHeader(
HTTP_Request2_Response
$response)
|
|
Checks whether the Response contains headers which detail where we can find the XRDS resource for this user. If exists, the value is set to the private $xrdsLocationHeaderUrl property.
Parameters:
parseXrds [line 666]
Creates a new Services_Yadis_Xrds object which uses SimpleXML to parse the XML into a list of Iterable Services_Yadis_Service objects.
Parameters:
setHttpRequest [line 484]
void setHttpRequest(
HTTP_Request2
$request)
|
|
Setter for custom HTTP_Request2 type object
Parameters:
setHttpRequestOptions [line 225]
Set options to be passed to the PEAR HTTP_Request2 constructor
Parameters:
setYadisId [line 254]
void setYadisId(
string
$yadisId)
|
|
A Yadis ID is usually an URL, but can also include an IRI, or XRI i-name. The initial version will support URLs as standard before examining options for supporting alternatives (IRI,XRI,i-name) since they require additional validation and conversion steps (e.g. Punycode for IRI) before use. Note: The current Validate classes currently do not have complete IDNA validation support for Internationalised Domain Names. To be addressed.
Parameters:
setYadisUrl [line 285]
Attempts to create a valid URI based on the value of the parameter which would typically be the Yadis ID. Note: This currently only supports XRI transformations.
Parameters:
validateURI [line 679]
bool validateURI(
string
$uri)
|
|
Wrapper for Validate::uri() to avoid non-static strict warnings
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:57:15 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|