rhymix/modules/member/php-openid-1.2.3/doc/Yadis/Services_Yadis_Service.html
2008-12-19 11:00:19 +00:00

225 lines
No EOL
8.1 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Services_Yadis_Service</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Services_Yadis_Service</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class represents a &lt;Service&gt; element in an XRDS document.</p>
<p class="description"><p>Objects of this type are returned by Services_Yadis_XRDS::services() and Services_Yadis_Yadis::services(). Each object corresponds directly to a &lt;Service&gt; element in the XRDS and supplies a getElements($name) method which you should use to inspect the element's contents. See <a href="../Yadis/Services_Yadis_Yadis.html">Services_Yadis_Yadis</a> for more information on the role this class plays in Yadis discovery.</p></p>
<p class="notes">
Located in <a class="field" href="_Services---Yadis---XRDS.php.html">/Services/Yadis/XRDS.php</a> (line <span class="field">73</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Services_Yadis_Service</span>
<a href="#Services_Yadis_Service" title="details" class="method-name">Services_Yadis_Service</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getElements" title="details" class="method-name">getElements</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#getPriority" title="details" class="method-name">getPriority</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getTypes" title="details" class="method-name">getTypes</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getURIs" title="details" class="method-name">getURIs</a>
()
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodServices_Yadis_Service" id="Services_Yadis_Service"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor Services_Yadis_Service</span> (line <span class="line-number">78</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates an empty service object.</p>
<div class="method-signature">
<span class="method-result">Services_Yadis_Service</span>
<span class="method-name">
Services_Yadis_Service
</span>
()
</div>
</div>
<a name="methodgetElements" id="getElements"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getElements</span> (line <span class="line-number">178</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used to get XML elements from this object's &lt;Service&gt; element.</p>
<p class="description"><p>This is what you should use to get all custom information out of this element. This is used by service filter functions to determine whether a service element contains specific tags, etc. NOTE: this only considers elements which are direct children of the &lt;Service&gt; element for this object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> An array of elements with the specified name which are direct children of the &lt;Service&gt; element. The nodes returned by this function can be passed to $this-&gt;parser methods (see <a href="../Yadis/Services_Yadis_XMLParser.html">Services_Yadis_XMLParser</a>).</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getElements
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the element to look for</span> </li>
</ul>
</div>
<a name="methodgetPriority" id="getPriority"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getPriority</span> (line <span class="line-number">152</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the &quot;priority&quot; attribute value of this &lt;Service&gt; element, if the attribute is present. Returns null if not.</p>
<ul class="tags">
<li><span class="field">return:</span> Null or integer, depending on whether this Service element has a 'priority' attribute.</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
getPriority
</span>
()
</div>
</div>
<a name="methodgetTypes" id="getTypes"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getTypes</span> (line <span class="line-number">90</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the URIs in the &quot;Type&quot; elements, if any, of this Service element.</p>
<ul class="tags">
<li><span class="field">return:</span> An array of Type URI strings.</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getTypes
</span>
()
</div>
</div>
<a name="methodgetURIs" id="getURIs"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getURIs</span> (line <span class="line-number">108</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the URIs in the &quot;URI&quot; elements, if any, of this Service element. The URIs are returned sorted in priority order.</p>
<ul class="tags">
<li><span class="field">return:</span> An array of URI strings.</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getURIs
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 10 Sep 2007 13:29:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>