riak-0.9.2 / client_lib / php / docs / riakclient / riakclient.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>RiakClient (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="../riakclient/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakclient/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="../riakclient/riakclient.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">RiakClient.RiakClient</div>
<div class="location">/riak.php at line 39</div>

<h1>Class RiakClient</h1>

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

<hr>

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

<div class="comment" id="overview_description"><p>The RiakClient object holds information necessary to connect to
Riak. The Riak API uses HTTP, so there is no persistent
connection, and the RiakClient object is extremely lightweight.</p></div>

<hr>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#RiakClient()">RiakClient</a>(string host, int port, string prefix, string mapred_prefix)</p><p class="description">Construct a new RiakClient object.</p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> <a href="../riakmapreduce/riakmapreduce.html">RiakMapReduce</a></td>
<td class="description"><p class="name"><a href="#add()">add</a>(mixed params)</p><p class="description">Start assembling a Map/Reduce operation.</p></td>
</tr>
<tr>
<td class="type"> <a href="../riakbucket/riakbucket.html">RiakBucket</a></td>
<td class="description"><p class="name"><a href="#bucket()">bucket</a>(mixed name)</p><p class="description">Get the bucket by the specified name. </p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getClientID()">getClientID</a>()</p><p class="description">Get the clientID for this RiakClient.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#getDW()">getDW</a>()</p><p class="description">Get the DW-value for this ClientOBject. </p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#getR()">getR</a>()</p><p class="description">Get the R-value setting for this RiakClient. </p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#getW()">getW</a>()</p><p class="description">Get the W-value setting for this RiakClient. </p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isAlive()">isAlive</a>()</p><p class="description">Check if the Riak server for this RiakClient is alive.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#link()">link</a>(mixed params)</p><p class="description">Start assembling a Map/Reduce operation.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#map()">map</a>(mixed params)</p><p class="description">Start assembling a Map/Reduce operation.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#reduce()">reduce</a>(mixed params)</p><p class="description">Start assembling a Map/Reduce operation.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setClientID()">setClientID</a>(mixed clientid, string clientID)</p><p class="description">Set the clientID for this RiakClient. </p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setDW()">setDW</a>(integer dw)</p><p class="description">Set the DW-value for this RiakClient. </p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setR()">setR</a>(integer r)</p><p class="description">Set the R-value for this RiakClient. </p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#setW()">setW</a>(integer w)</p><p class="description">Set the W-value for this RiakClient. </p></td>
</tr>
</table>

<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/riak.php at line 47</div>
<h3 id="RiakClient()">RiakClient</h3>
<code class="signature">public <strong>RiakClient</strong>(string host, int port, string prefix, string mapred_prefix)</code>
<div class="details">
<p>Construct a new RiakClient object.</p><dl>
<dt>Parameters:</dt>
<dd>host - - Hostname or IP address (default '127.0.0.1')</dd>
<dd>port - - Port number (default 8098)</dd>
<dd>prefix - - Interface prefix (default "riak")</dd>
<dd>mapred_prefix - - MapReduce prefix (default "mapred")</dd>
</dl>
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/riak.php at line 163</div>
<h3 id="add()">add</h3>
<code class="signature">public  <a href="../riakmapreduce/riakmapreduce.html">RiakMapReduce</a> <strong>add</strong>(mixed params)</code>
<div class="details">
<p>Start assembling a Map/Reduce operation.</p><dl>
<dt>See Also:</dt>
<dd>RiakMapReduce::add()</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 141</div>
<h3 id="bucket()">bucket</h3>
<code class="signature">public  <a href="../riakbucket/riakbucket.html">RiakBucket</a> <strong>bucket</strong>(mixed name)</code>
<div class="details">
<p>Get the bucket by the specified name. Since buckets always exist,
this will always return a RiakBucket.</p></div>

<hr>

<div class="location">/riak.php at line 121</div>
<h3 id="getClientID()">getClientID</h3>
<code class="signature">public  string <strong>getClientID</strong>()</code>
<div class="details">
<p>Get the clientID for this RiakClient.</p></div>

<hr>

<div class="location">/riak.php at line 102</div>
<h3 id="getDW()">getDW</h3>
<code class="signature">public  integer <strong>getDW</strong>()</code>
<div class="details">
<p>Get the DW-value for this ClientOBject. (default 2)</p></div>

<hr>

<div class="location">/riak.php at line 62</div>
<h3 id="getR()">getR</h3>
<code class="signature">public  integer <strong>getR</strong>()</code>
<div class="details">
<p>Get the R-value setting for this RiakClient. (default 2)</p></div>

<hr>

<div class="location">/riak.php at line 83</div>
<h3 id="getW()">getW</h3>
<code class="signature">public  integer <strong>getW</strong>()</code>
<div class="details">
<p>Get the W-value setting for this RiakClient. (default 2)</p></div>

<hr>

<div class="location">/riak.php at line 149</div>
<h3 id="isAlive()">isAlive</h3>
<code class="signature">public  boolean <strong>isAlive</strong>()</code>
<div class="details">
<p>Check if the Riak server for this RiakClient is alive.</p></div>

<hr>

<div class="location">/riak.php at line 173</div>
<h3 id="link()">link</h3>
<code class="signature">public  void <strong>link</strong>(mixed params)</code>
<div class="details">
<p>Start assembling a Map/Reduce operation.</p><dl>
<dt>See Also:</dt>
<dd>RiakMapReduce::link()</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 183</div>
<h3 id="map()">map</h3>
<code class="signature">public  void <strong>map</strong>(mixed params)</code>
<div class="details">
<p>Start assembling a Map/Reduce operation.</p><dl>
<dt>See Also:</dt>
<dd>RiakMapReduce::map()</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 193</div>
<h3 id="reduce()">reduce</h3>
<code class="signature">public  void <strong>reduce</strong>(mixed params)</code>
<div class="details">
<p>Start assembling a Map/Reduce operation.</p><dl>
<dt>See Also:</dt>
<dd>RiakMapReduce::reduce()</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 131</div>
<h3 id="setClientID()">setClientID</h3>
<code class="signature">public  $this <strong>setClientID</strong>(mixed clientid, string clientID)</code>
<div class="details">
<p>Set the clientID for this RiakClient. Should not be called
unless you know what you are doing.</p><dl>
<dt>Parameters:</dt>
<dd>clientID - - The new clientID.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 112</div>
<h3 id="setDW()">setDW</h3>
<code class="signature">public  $this <strong>setDW</strong>(integer dw)</code>
<div class="details">
<p>Set the DW-value for this RiakClient. See setR(...) for a
description of how these values are used.</p><dl>
<dt>Parameters:</dt>
<dd>dw - - The DW value.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 74</div>
<h3 id="setR()">setR</h3>
<code class="signature">public  $this <strong>setR</strong>(integer r)</code>
<div class="details">
<p>Set the R-value for this RiakClient. This value will be used
for any calls to get(...) or getBinary(...) where where 1) no
R-value is specified in the method call and 2) no R-value has
been set in the RiakBucket.</p><dl>
<dt>Parameters:</dt>
<dd>r - - The R value.</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 93</div>
<h3 id="setW()">setW</h3>
<code class="signature">public  $this <strong>setW</strong>(integer w)</code>
<div class="details">
<p>Set the W-value for this RiakClient. See setR(...) for a
description of how these values are used.</p><dl>
<dt>Parameters:</dt>
<dd>w - - The W value.</dd>
</dl>
</div>

<hr>

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riakclient/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakclient/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="../riakclient/riakclient.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>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.