Services_Yadis
[ class tree: Services_Yadis ] [ index: Services_Yadis ] [ all elements ]

Class: Services_Yadis_Service

Source Location: /Services_Yadis-0.5.2/Services/Yadis/Service.php

Class Overview


The Services_Yadis_Service class represents a service parsed from the XRD node of a Yadis 1.0 XRDS document.


Author(s):

  • Pádraic Brady (http://blog.astrumfutura.com)

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 53]
The Services_Yadis_Service class represents a service parsed from the XRD node of a Yadis 1.0 XRDS document.
  • Author: Pádraic Brady (http://blog.astrumfutura.com)
  • License: New BSD License


[ Top ]


Class Variables

$_namespace =  null

[line 70]

Holds the Service node parsed from a Yadis XRDS document as a SimpleXMLElement object.
  • Access: protected

Type:   SimpleXMLElement


[ Top ]

$_serviceNode =  null

[line 62]

Holds the Service node parsed from a Yadis XRDS document as a SimpleXMLElement object.
  • Access: protected

Type:   SimpleXMLElement


[ Top ]



Method Detail

__construct (Constructor)   [line 80]

Services_Yadis_Service __construct( $serviceNode, Services_Yadis_Xrds_Namespace $namespace)

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.
  • Access: public

Parameters:

SimpleXMLElement   $serviceNode     
Services_Yadis_Xrds_Namespace   $namespace     

[ Top ]

getDomObject   [line 154]

DOMDocument getDomObject( )

Return the current XRDS Service node as a DOMDocument object.

This is just a simple transfer by loading the XML output from the SimpleXMLElement object into a new DOMDocument instance.

  • Access: public

[ Top ]

getElements   [line 190]

array|boolean getElements( string $name)

Retrieve Elements of the current Service node by their name, and return

as a SimpleXMLElement object. The Elements should be direct children of the Service node. This method basically just passes the $element string as an XPath query so it's open to other uses despite the assumed use case.

  • Access: public

Parameters:

string   $name     

[ Top ]

getLocalIDs   [line 116]

array|boolean getLocalIDs( )

Return an array of Service Type LocalID strings.
  • Access: public

[ Top ]

getNamespaceObject   [line 164]

Services_Yadis_Xrds_Namespace getNamespaceObject( )

Return the current Services_Yadis_Xrds_Namespace object.
  • Access: public

[ Top ]

getNamespaces   [line 175]

array getNamespaces( )

Return an array of the current XRDS namespaces for working with any XPath queries on the Service node.
  • Access: public

[ Top ]

getPriority   [line 126]

integer|boolean getPriority( )

Returns the Priority integer of this Service node.
  • Access: public

[ Top ]

getSimpleXmlObject   [line 142]

SimpleXMLElement getSimpleXmlObject( )

Return the current XRDS Service node as a SimpleXMLElement object.
  • Access: public

[ Top ]

getTypes   [line 93]

array getTypes( )

Return an array of Service Type URI strings. This method will NOT validate the resulting URIs.
  • Access: public

[ Top ]

getUris   [line 106]

array|boolean 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.
  • Access: public

[ Top ]


Documentation generated on Mon, 19 May 2014 08:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.