Source

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

Full commit
<!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>RiakUtils (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="../riakutils/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakutils/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="../riakutils/riakutils.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">RiakUtils.RiakUtils</div>
<div class="location">/riak.php at line 1307</div>

<h1>Class RiakUtils</h1>

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

<hr>

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

<div class="comment" id="overview_description"><p>Utility functions used by Riak library.</p></div>

<hr>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#buildRestPath()">buildRestPath</a>(mixed client, mixed bucket, mixed key, mixed spec, mixed params)</p><p class="description">Given a RiakClient, RiakBucket, Key, LinkSpec, and Params,
construct and return a URL.</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#get_value()">get_value</a>(mixed key, mixed array, mixed defaultValue)</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#httpRequest()">httpRequest</a>(mixed method, mixed url, mixed request_headers)</p><p class="description">Given a Method, URL, Headers, and Body, perform and HTTP request,
and return an array of arity 2 containing an associative array of
response headers and the response body.</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#parseHttpHeaders()">parseHttpHeaders</a>(mixed headers)</p><p class="description">Parse an HTTP Header string into an asssociative array of
response headers.</p></td>
</tr>
</table>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/riak.php at line 1321</div>
<h3 id="buildRestPath()">buildRestPath</h3>
<code class="signature">public static  void <strong>buildRestPath</strong>(mixed client, mixed bucket, mixed key, mixed spec, mixed params)</code>
<div class="details">
<p>Given a RiakClient, RiakBucket, Key, LinkSpec, and Params,
construct and return a URL.</p></div>

<hr>

<div class="location">/riak.php at line 1309</div>
<h3 id="get_value()">get_value</h3>
<code class="signature">public static  void <strong>get_value</strong>(mixed key, mixed array, mixed defaultValue)</code>
<div class="details">
</div>

<hr>

<div class="location">/riak.php at line 1362</div>
<h3 id="httpRequest()">httpRequest</h3>
<code class="signature">public static  void <strong>httpRequest</strong>(mixed method, mixed url, mixed request_headers)</code>
<div class="details">
<p>Given a Method, URL, Headers, and Body, perform and HTTP request,
and return an array of arity 2 containing an associative array of
response headers and the response body.</p></div>

<hr>

<div class="location">/riak.php at line 1417</div>
<h3 id="parseHttpHeaders()">parseHttpHeaders</h3>
<code class="signature">public static  void <strong>parseHttpHeaders</strong>(mixed headers)</code>
<div class="details">
<p>Parse an HTTP Header string into an asssociative array of
response headers.</p></div>

<hr>

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riakutils/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakutils/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="../riakutils/riakutils.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>