Element index for package Services_Yadis
[ a ]
[ c ]
[ d ]
[ e ]
[ g ]
[ h ]
[ i ]
[ k ]
[ m ]
[ n ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ x ]
[ y ]
[ _ ]
_
- $_namespace
- in file Service.php, variable Services_Yadis_Service::$_namespace
Holds the Service node parsed from a Yadis XRDS document as a SimpleXMLElement object.
- $_serviceNode
- in file Service.php, variable Services_Yadis_Service::$_serviceNode
Holds the Service node parsed from a Yadis XRDS document as a SimpleXMLElement object.
- __construct
- in file Yadis.php, method Services_Yadis::__construct()
Class Constructor
- __construct
- in file Service.php, method Services_Yadis_Service::__construct()
Class constructor; initialise the object with a Service node from the XRDS document, and the current Services_Yadis_Xrds_Namespace object to provide the current namespaces for using XPath queries.
- __construct
- in file Xri.php, method Services_Yadis_Xri::__construct()
Constructor; protected since this class is a singleton.
- $_currentKey
- in file Xrds.php, variable Services_Yadis_Xrds::$_currentKey
Current key/pointer for the Iterator
- $_namespace
- in file Xrds.php, variable Services_Yadis_Xrds::$_namespace
Instance of Services_Yadis_Xrds_Namespace for managing namespaces associated with an XRDS document.
- $_services
- in file Service.php, variable Services_Yadis_Xrds_Service::$_services
The Yadis Services resultset
- $_valid
- in file Service.php, variable Services_Yadis_Xrds_Service::$_valid
Flag holding whether or not the array endpoint has been reached.
- $_xrdNode
- in file Service.php, variable Services_Yadis_Xrds_Service::$_xrdNode
Holds the last XRD node of the XRD document as required by Yadis 1.0.
- $_xrdNodes
- in file Xrds.php, variable Services_Yadis_Xrds::$_xrdNodes
Contains the valid xrd:XRD nodes parsed from the XRD document.
- _addService
- in file Service.php, method Services_Yadis_Xrds_Service::_addService()
Add a service to the Service list indexed by priority. Assumes a missing or invalid priority should be shuffled to the bottom of the priority order.
- _getValidXrdNodes
- in file Xrds.php, method Services_Yadis_Xrds::_getValidXrdNodes()
Returns an array of all xrd elements located in the XRD document.
- __construct
- in file Xrds.php, method Services_Yadis_Xrds::__construct()
Constructor; parses and validates an XRD document. All access to the data held in the XML is left to a concrete subclass specific to expected XRD format and data types.
- __construct
- in file Service.php, method Services_Yadis_Xrds_Service::__construct()
Constructor; Accepts an XRD document for parsing.
top
top
top
d
- discover
- in file Yadis.php, method Services_Yadis::discover()
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.
top
top
g
- get
- in file Yadis.php, method Services_Yadis::get()
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.
- get
- in file Xri.php, method Services_Yadis_Xri::get()
Required to request the root i-name (XRI) XRD which will provide an error message that the i-name does not exist, or else return a valid XRD document containing the i-name's Canonical ID.
- getCanonicalId
- in file Xri.php, method Services_Yadis_Xri::getCanonicalId()
Gets the Canonical ID
- getDomObject
- in file Service.php, method Services_Yadis_Service::getDomObject()
Return the current XRDS Service node as a DOMDocument object.
- getElements
- in file Service.php, method Services_Yadis_Service::getElements()
Retrieve Elements of the current Service node by their name, and return
- getHttpRequest
- in file Yadis.php, method Services_Yadis::getHttpRequest()
Gets the HTTP_Request2 object
- getHttpRequestOptions
- in file Yadis.php, method Services_Yadis::getHttpRequestOptions()
Get options to be passed to the PEAR HTTP_Request2 constructor
- getHttpRequestOptions
- in file Xri.php, method Services_Yadis_Xri::getHttpRequestOptions()
Get options to be passed to the PEAR HTTP_Request2 constructor
- getHTTPResponse
- in file Yadis.php, method Services_Yadis::getHTTPResponse()
Return the final HTTP response
- getHTTPResponse
- in file Xri.php, method Services_Yadis_Xri::getHTTPResponse()
Returns the most recent HTTP_Request2_Response object.
- getInstance
- in file Xri.php, method Services_Yadis_Xri::getInstance()
Return a singleton instance of this class.
- getLocalIDs
- in file Service.php, method Services_Yadis_Service::getLocalIDs()
Return an array of Service Type LocalID strings.
- getNamespace
- in file Namespace.php, method Services_Yadis_Xrds_Namespace::getNamespace()
Return the value of a specific namespace, or FALSE if not found.
- getNamespace
- in file Yadis.php, method Services_Yadis::getNamespace()
Return the value of a specific namespace.
- getNamespaceObject
- in file Service.php, method Services_Yadis_Service::getNamespaceObject()
Return the current Services_Yadis_Xrds_Namespace object.
- getNamespaces
- in file Service.php, method Services_Yadis_Service::getNamespaces()
Return an array of the current XRDS namespaces for working with any XPath queries on the Service node.
- getNamespaces
- in file Yadis.php, method Services_Yadis::getNamespaces()
Returns an array of all currently set namespaces.
- getNamespaces
- in file Namespace.php, method Services_Yadis_Xrds_Namespace::getNamespaces()
Returns an array of all currently set namespaces.
- getPriority
- in file Service.php, method Services_Yadis_Service::getPriority()
Returns the Priority integer of this Service node.
- getProxy
- in file Xri.php, method Services_Yadis_Xri::getProxy()
Return the URI of the current proxy.
- getResponseType
- in file Yadis.php, method Services_Yadis::getResponseType()
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.
- getSimpleXmlObject
- in file Service.php, method Services_Yadis_Service::getSimpleXmlObject()
Return the current XRDS Service node as a SimpleXMLElement object.
- getTypes
- in file Service.php, method Services_Yadis_Service::getTypes()
Return an array of Service Type URI strings. This method will NOT validate the resulting URIs.
- getUris
- in file Service.php, method Services_Yadis_Service::getUris()
Return an array of Service Type URI strings. This method will NOT validate the resulting URIs. URI values in the array will have key values matching their priority, and be ordered based on their priority values - highest (i.e. lowest integer) priority first.
- getXri
- in file Xri.php, method Services_Yadis_Xri::getXri()
Return the original XRI string.
- getYadisId
- in file Yadis.php, method Services_Yadis::getYadisId()
Returns the original Yadis ID string set for this class.
- getYadisUrl
- in file Yadis.php, method Services_Yadis::getYadisUrl()
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.
- getNamespace
- in file Xrds.php, method Services_Yadis_Xrds::getNamespace()
Return the value of a specific namespace.
- getNamespaces
- in file Xrds.php, method Services_Yadis_Xrds::getNamespaces()
Returns an array of all currently set namespaces.
top
top
i
- $instance
- in file Xri.php, variable Services_Yadis_Xri::$instance
Hold an instance of this object per the Singleton Pattern.
- isMetaHttpEquiv
- in file Yadis.php, method Services_Yadis::isMetaHttpEquiv()
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.
- isXrdsContentType
- in file Yadis.php, method Services_Yadis::isXrdsContentType()
Checks whether the Response contains the XRDS resource. It should, per the specifications always be served as application/xrds+xml
- isXrdsLocationHeader
- in file Yadis.php, method Services_Yadis::isXrdsLocationHeader()
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.
top
top
m
- $metaHttpEquivUrl
- in file Yadis.php, variable Services_Yadis::$metaHttpEquivUrl
A URL parsed from a HTML document's <meta> element inserted in accordance with the Yadis Specification and which points to a Yadis XRD document.
top
top
p
- $proxy
- in file Xri.php, variable Services_Yadis_Xri::$proxy
Default proxy to append XRI identifier to when forming a valid URI.
- parseXrds
- in file Yadis.php, method Services_Yadis::parseXrds()
Creates a new Services_Yadis_Xrds object which uses SimpleXML to parse the XML into a list of Iterable Services_Yadis_Service objects.
top
top
s
- Services_Yadis
- in file Yadis.php, class Services_Yadis
Services_Yadis class
- Service.php
- procedural page Service.php
- Services_Yadis_Exception
- in file Exception.php, class Services_Yadis_Exception
Services_Yadis_Exception
- Services_Yadis_Service
- in file Service.php, class Services_Yadis_Service
The Services_Yadis_Service class represents a service parsed from the XRD node of a Yadis 1.0 XRDS document.
- Services_Yadis_Xrds_Namespace
- in file Namespace.php, class Services_Yadis_Xrds_Namespace
The Services_Yadis_Xrds_Namespace class is a container for namespaces which need to be registered to an XML parser in order to correctly consume an XRDS document using the parser's XPath functionality.
- Services_Yadis_Xri
- in file Xri.php, class Services_Yadis_Xri
Provides methods for translating an XRI into a URI.
- setHttpRequest
- in file Yadis.php, method Services_Yadis::setHttpRequest()
Setter for custom HTTP_Request2 type object
- setHttpRequestOptions
- in file Yadis.php, method Services_Yadis::setHttpRequestOptions()
Set options to be passed to the PEAR HTTP_Request2 constructor
- setHttpRequestOptions
- in file Xri.php, method Services_Yadis_Xri::setHttpRequestOptions()
Set options to be passed to the PEAR HTTP_Request2 constructor
- setNamespace
- in file Xri.php, method Services_Yadis_Xri::setNamespace()
Set a Namespace object which contains all relevant namespaces for XPath queries on this Yadis resource.
- setProxy
- in file Xri.php, method Services_Yadis_Xri::setProxy()
Set an XRI proxy URI. A default of "http://xri.net/" is available.
- setXri
- in file Xri.php, method Services_Yadis_Xri::setXri()
Set an XRI to be translated to a URI.
- setYadisId
- in file Yadis.php, method Services_Yadis::setYadisId()
A Yadis ID is usually an URL, but can also include an IRI, or XRI i-name.
- setYadisUrl
- in file Yadis.php, method Services_Yadis::setYadisUrl()
Attempts to create a valid URI based on the value of the parameter which would typically be the Yadis ID.
- Service.php
- procedural page Service.php
- Services_Yadis_Xrds
- in file Xrds.php, class Services_Yadis_Xrds
The Services_Yadis_Xrds class is a wrapper for elements of an XRD document which is parsed using SimpleXML, and contains methods for retrieving data about the document. The concrete aspects of retrieving specific data elements is left to a concrete subclass.
- Services_Yadis_Xrds_Service
- in file Service.php, class Services_Yadis_Xrds_Service
The Services_Yadis_Xrds_Service class is a wrapper for Service elements of an XRD document which is parsed using SimpleXML, and contains methods for retrieving data about each Service, including Type, Url and other arbitrary data added in a separate namespace, e.g. openid:Delegate for OpenID 1.1.
- SERVICE_LOWEST_PRIORITY
- in file Service.php, class constant Services_Yadis_Xrds_Service::SERVICE_LOWEST_PRIORITY
Establish a lowest priority integer; we'll take the upper 2^31 integer limit.
- sortByPriority
- in file Xrds.php, method Services_Yadis_Xrds::sortByPriority()
Order an array of elements by priority. This assumes an array form of:
top
t
- test.php
- procedural page test.php
- toCanonicalId
- in file Xri.php, method Services_Yadis_Xri::toCanonicalId()
Based on an XRI, will request the XRD document located at the proxy prefixed URI and parse in search of the XRI Canonical Id. This is a flexible requirement. OpenID 2.0 requires the use of the Canonical ID instead of the raw i-name. 2idi.com, on the other hand, does not.
- toUri
- in file Xri.php, method Services_Yadis_Xri::toUri()
Attempts to convert an XRI into a URI. In simple terms this involves removing the "xri://" prefix and appending the remainder to the URI of an XRI proxy such as "http://xri.net/".
top
top
v
- $validHtmlContentTypes
- in file Yadis.php, variable Services_Yadis::$validHtmlContentTypes
Array of valid HTML Content-Types. Required since Yadis states agents must parse a document if received as the first response and with an MIME type indicating HTML or XHTML. Listed in order of priority, with HTML taking priority over XHTML.
- validateURI
- in file Yadis.php, method Services_Yadis::validateURI()
Wrapper for Validate::uri() to avoid non-static strict warnings
- valid
- in file Service.php, method Services_Yadis_Xrds_Service::valid()
Implement Iterator::valid()
top
top
y
- $yadisId
- in file Yadis.php, variable Services_Yadis::$yadisId
The current Yadis ID; this is the raw form initially submitted prior to any transformation/validation as an URL. This *may* allow IRI support in the future given IRIs map to URIs and adoption of the IRI standard and are entering common use internationally.
- $yadisUrl
- in file Yadis.php, variable Services_Yadis::$yadisUrl
The current Yadis URL; this is a URL either validated or transformed from the initial Yadis ID. This URL is used to make the initial HTTP GET request during Service Discovery.
- Yadis.php
- procedural page Yadis.php
top
Documentation generated on Mon, 11 Mar 2019 15:57:14 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|