Source

riak-0.9.2 / client_lib / php / docs / riaklink / riaklink.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">

<title>RiakLink (Riak PHP Client API)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riaklink/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riaklink/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../riaklink/riaklink.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">RiakLink.RiakLink</div>
<div class="location">/riak.php at line 454</div>

<h1>Class RiakLink</h1>

<pre class="tree"><strong>RiakLink</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>RiakLink</strong></p>

<div class="comment" id="overview_description"><p>The RiakLink object represents a link from one Riak object to
another.</p></div>

<hr>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#RiakLink()">RiakLink</a>(string bucket, string key, string tag)</p><p class="description">Construct a RiakLink object.</p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> <a href="../riakobject/riakobject.html">RiakObject</a></td>
<td class="description"><p class="name"><a href="#get()">get</a>(integer r)</p><p class="description">Retrieve the RiakObject to which this link points.</p></td>
</tr>
<tr>
<td class="type"> <a href="../riakobject/riakobject.html">RiakObject</a></td>
<td class="description"><p class="name"><a href="#getBinary()">getBinary</a>(integer r)</p><p class="description">Retrieve the RiakObject to which this link points, as a binary.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getBucket()">getBucket</a>()</p><p class="description">Get the bucket name of this link.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getKey()">getKey</a>()</p><p class="description">Get the key of this link.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getTag()">getTag</a>()</p><p class="description">Get the tag of this link.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isEqual()">isEqual</a>(<a href="../riaklink/riaklink.html">RiakLink</a> link)</p><p class="description">Return true if the links are equal.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setBucket()">setBucket</a>(string name)</p><p class="description">Set the bucket name of this link.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setKey()">setKey</a>(string key)</p><p class="description">Set the key of this link.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setTag()">setTag</a>(string tag)</p><p class="description">Set the tag of this link.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#toLinkHeader()">toLinkHeader</a>(mixed client)</p><p class="description">Convert this RiakLink object to a link header string. </p></td>
</tr>
</table>

<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/riak.php at line 461</div>
<h3 id="RiakLink()">RiakLink</h3>
<code class="signature">public <strong>RiakLink</strong>(string bucket, string key, string tag)</code>
<div class="details">
<p>Construct a RiakLink object.</p><dl>
<dt>Parameters:</dt>
<dd>bucket - - The bucket name.</dd>
<dd>key - - The key.</dd>
<dd>tag - - The tag.</dd>
</dl>
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/riak.php at line 473</div>
<h3 id="get()">get</h3>
<code class="signature">public  <a href="../riakobject/riakobject.html">RiakObject</a> <strong>get</strong>(integer r)</code>
<div class="details">
<p>Retrieve the RiakObject to which this link points.</p><dl>
<dt>Parameters:</dt>
<dd>r - - The R-value to use.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 482</div>
<h3 id="getBinary()">getBinary</h3>
<code class="signature">public  <a href="../riakobject/riakobject.html">RiakObject</a> <strong>getBinary</strong>(integer r)</code>
<div class="details">
<p>Retrieve the RiakObject to which this link points, as a binary.</p><dl>
<dt>Parameters:</dt>
<dd>r - - The R-value to use.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 490</div>
<h3 id="getBucket()">getBucket</h3>
<code class="signature">public  string <strong>getBucket</strong>()</code>
<div class="details">
<p>Get the bucket name of this link.</p></div>

<hr>

<div class="location">/riak.php at line 508</div>
<h3 id="getKey()">getKey</h3>
<code class="signature">public  string <strong>getKey</strong>()</code>
<div class="details">
<p>Get the key of this link.</p></div>

<hr>

<div class="location">/riak.php at line 526</div>
<h3 id="getTag()">getTag</h3>
<code class="signature">public  string <strong>getTag</strong>()</code>
<div class="details">
<p>Get the tag of this link.</p></div>

<hr>

<div class="location">/riak.php at line 560</div>
<h3 id="isEqual()">isEqual</h3>
<code class="signature">public  boolean <strong>isEqual</strong>(<a href="../riaklink/riaklink.html">RiakLink</a> link)</code>
<div class="details">
<p>Return true if the links are equal.</p><dl>
<dt>Parameters:</dt>
<dd>link - - A RiakLink object.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 499</div>
<h3 id="setBucket()">setBucket</h3>
<code class="signature">public  $this <strong>setBucket</strong>(string name)</code>
<div class="details">
<p>Set the bucket name of this link.</p><dl>
<dt>Parameters:</dt>
<dd>name - - The bucket name.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 517</div>
<h3 id="setKey()">setKey</h3>
<code class="signature">public  $this <strong>setKey</strong>(string key)</code>
<div class="details">
<p>Set the key of this link.</p><dl>
<dt>Parameters:</dt>
<dd>key - - The key.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 538</div>
<h3 id="setTag()">setTag</h3>
<code class="signature">public  $this <strong>setTag</strong>(string tag)</code>
<div class="details">
<p>Set the tag of this link.</p><dl>
<dt>Parameters:</dt>
<dd>tag - - The tag.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 546</div>
<h3 id="toLinkHeader()">toLinkHeader</h3>
<code class="signature">public  void <strong>toLinkHeader</strong>(mixed client)</code>
<div class="details">
<p>Convert this RiakLink object to a link header string. Used internally.</p></div>

<hr>

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riaklink/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riaklink/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../riaklink/riaklink.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>