Source

riak-0.9.2 / client_lib / php / docs / index-all.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>Index (Riak PHP Client API)</title>

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

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

<div class="small_links">
<a href="index.html" target="_top">Frames</a>
<a href="index-all.html" target="_top">No frames</a>
</div>
<a href="#letterA">A</a>
<a href="#letterB">B</a>
<a href="#letterC">C</a>
<a href="#letterD">D</a>
<a href="#letterE">E</a>
<a href="#letterG">G</a>
<a href="#letterH">H</a>
<a href="#letterI">I</a>
<a href="#letterL">L</a>
<a href="#letterM">M</a>
<a href="#letterN">N</a>
<a href="#letterP">P</a>
<a href="#letterR">R</a>
<a href="#letterS">S</a>
<a href="#letterT">T</a>
<a href="#letterW">W</a>
<hr>

<h1 id="letterA">A</h1>
<dl>
<dt><a href="riakobject/riakobject.html#add()">add()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#add()">add()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add inputs to a map/reduce operation. </dd>
<dt><a href="riakclient/riakclient.html#add()">add()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakobject/riakobject.html#addLink()">addLink()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Add a link to a RiakObject.</dd>
</dl>
<h1 id="letterB">B</h1>
<dl>
<dt><a href="riakclient/riakclient.html#bucket()">bucket()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the bucket by the specified name. </dd>
<dt><a href="riakutils/riakutils.html#buildRestPath()">buildRestPath()</a> - Method in class <a href="riakutils/riakutils.html">RiakUtils.RiakUtils</a></dt>
<dd>Given a RiakClient, RiakBucket, Key, LinkSpec, and Params,
construct and return a URL.</dd>
</dl>
<h1 id="letterC">C</h1>
<dl>
<dt><a href="riakstringio/riakstringio.html#contents()">contents()</a> - Method in class <a href="riakstringio/riakstringio.html">RiakStringIO.RiakStringIO</a></dt>
</dl>
<h1 id="letterD">D</h1>
<dl>
<dt><a href="riakobject/riakobject.html#delete()">delete()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Delete this object from Riak.</dd>
</dl>
<h1 id="letterE">E</h1>
<dl>
<dt><a href="riakobject/riakobject.html#exists()">exists()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Return true if the object exists, false otherwise. </dd>
</dl>
<h1 id="letterG">G</h1>
<dl>
<dt><a href="riaklink/riaklink.html#get()">get()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Retrieve the RiakObject to which this link points.</dd>
<dt><a href="riakbucket/riakbucket.html#get()">get()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve a JSON-encoded object from Riak.</dd>
<dt><a href="riakutils/riakutils.html#get_value()">get_value()</a> - Method in class <a href="riakutils/riakutils.html">RiakUtils.RiakUtils</a></dt>
<dt><a href="riakbucket/riakbucket.html#getAllowMultiples()">getAllowMultiples()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve the 'allow multiples' setting.</dd>
<dt><a href="riaklink/riaklink.html#getBinary()">getBinary()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Retrieve the RiakObject to which this link points, as a binary.</dd>
<dt><a href="riakbucket/riakbucket.html#getBinary()">getBinary()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve a binary/string object from Riak.</dd>
<dt><a href="riaklink/riaklink.html#getBucket()">getBucket()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the bucket name of this link.</dd>
<dt><a href="riakobject/riakobject.html#getBucket()">getBucket()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the bucket of this object.</dd>
<dt><a href="riakclient/riakclient.html#getClientID()">getClientID()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the clientID for this RiakClient.</dd>
<dt><a href="riakobject/riakobject.html#getContentType()">getContentType()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the content type of this object. </dd>
<dt><a href="riakobject/riakobject.html#getData()">getData()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the data stored in this object. </dd>
<dt><a href="riakbucket/riakbucket.html#getDW()">getDW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the DW-value for this bucket, if it is set, otherwise return
the DW-value for the client.</dd>
<dt><a href="riakclient/riakclient.html#getDW()">getDW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the DW-value for this ClientOBject. </dd>
<dt><a href="riakobject/riakobject.html#getKey()">getKey()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the key of this object.</dd>
<dt><a href="riaklink/riaklink.html#getKey()">getKey()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the key of this link.</dd>
<dt><a href="riakobject/riakobject.html#getLinks()">getLinks()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Return an array of RiakLink objects.</dd>
<dt><a href="riakbucket/riakbucket.html#getName()">getName()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the bucket name.</dd>
<dt><a href="riakbucket/riakbucket.html#getNVal()">getNVal()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve the N-value for this bucket.</dd>
<dt><a href="riakbucket/riakbucket.html#getProperties()">getProperties()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve an associative array of all bucket properties.</dd>
<dt><a href="riakbucket/riakbucket.html#getProperty()">getProperty()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve a bucket property.</dd>
<dt><a href="riakclient/riakclient.html#getR()">getR()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the R-value setting for this RiakClient. </dd>
<dt><a href="riakbucket/riakbucket.html#getR()">getR()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the R-value for this bucket, if it is set, otherwise return
the R-value for the client.</dd>
<dt><a href="riakobject/riakobject.html#getSibling()">getSibling()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Retrieve a sibling by sibling number.</dd>
<dt><a href="riakobject/riakobject.html#getSiblingCount()">getSiblingCount()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the number of siblings that this object contains.</dd>
<dt><a href="riakobject/riakobject.html#getSiblings()">getSiblings()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Retrieve an array of siblings.</dd>
<dt><a href="riaklink/riaklink.html#getTag()">getTag()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the tag of this link.</dd>
<dt><a href="riakbucket/riakbucket.html#getW()">getW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the W-value for this bucket, if it is set, otherwise return
the W-value for the client.</dd>
<dt><a href="riakclient/riakclient.html#getW()">getW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the W-value setting for this RiakClient. </dd>
</dl>
<h1 id="letterH">H</h1>
<dl>
<dt><a href="riakobject/riakobject.html#hasSiblings()">hasSiblings()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Return true if this object has siblings.</dd>
<dt><a href="riakutils/riakutils.html#httpRequest()">httpRequest()</a> - Method in class <a href="riakutils/riakutils.html">RiakUtils.RiakUtils</a></dt>
<dd>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.</dd>
</dl>
<h1 id="letterI">I</h1>
<dl>
<dt><a href="riakclient/riakclient.html#isAlive()">isAlive()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Check if the Riak server for this RiakClient is alive.</dd>
<dt><a href="riaklink/riaklink.html#isEqual()">isEqual()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Return true if the links are equal.</dd>
</dl>
<h1 id="letterL">L</h1>
<dl>
<dt><a href="riakclient/riakclient.html#link()">link()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#link()">link()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add a link phase to the map/reduce operation.</dd>
<dt><a href="riakobject/riakobject.html#link()">link()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
</dl>
<h1 id="letterM">M</h1>
<dl>
<dt><a href="riakobject/riakobject.html#map()">map()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakclient/riakclient.html#map()">map()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#map()">map()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add a map phase to the map/reduce operation.</dd>
</dl>
<h1 id="letterN">N</h1>
<dl>
<dt><a href="riakbucket/riakbucket.html#newBinary()">newBinary()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Create a new Riak object that will be stored as plain text/binary.</dd>
<dt><a href="riakbucket/riakbucket.html#newObject()">newObject()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Create a new Riak object that will be stored as JSON.</dd>
</dl>
<h1 id="letterP">P</h1>
<dl>
<dt><a href="riakutils/riakutils.html#parseHttpHeaders()">parseHttpHeaders()</a> - Method in class <a href="riakutils/riakutils.html">RiakUtils.RiakUtils</a></dt>
<dd>Parse an HTTP Header string into an asssociative array of
response headers.</dd>
<dt><a href="riakobject/riakobject.html#populate()">populate()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Given the output of RiakUtils::httpRequest and a list of
statuses, populate the object. </dd>
</dl>
<h1 id="letterR">R</h1>
<dl>
<dt><a href="riakobject/riakobject.html#reduce()">reduce()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#reduce()">reduce()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add a reduce phase to the map/reduce operation.</dd>
<dt><a href="riakclient/riakclient.html#reduce()">reduce()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakobject/riakobject.html#reload()">reload()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Reload the object from Riak. </dd>
<dt><a href="riakobject/riakobject.html#removeLink()">removeLink()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Remove a link to a RiakObject.</dd>
<dt><a href="riakbucket/riakbucket.html">RiakBucket()</a> - Class in package <a href="riakbucket/package-summary.html">RiakBucket</a></dt>
<dd>The RiakBucket object allows you to access and change information
about a Riak bucket, and provides methods to create or retrieve
objects within the bucket.</dd>
<dt><a href="riakclient/riakclient.html">RiakClient()</a> - Class in package <a href="riakclient/package-summary.html">RiakClient</a></dt>
<dd>The RiakClient object holds information necessary to connect to
Riak. </dd>
<dt><a href="riaklink/riaklink.html">RiakLink()</a> - Class in package <a href="riaklink/package-summary.html">RiakLink</a></dt>
<dd>The RiakLink object represents a link from one Riak object to
another.</dd>
<dt><a href="riaklinkphase/riaklinkphase.html">RiakLinkPhase()</a> - Class in package <a href="riaklinkphase/package-summary.html">RiakLinkPhase</a></dt>
<dd>The RiakLinkPhase object holds information about a Link phase in a
map/reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html">RiakMapReduce()</a> - Class in package <a href="riakmapreduce/package-summary.html">RiakMapReduce</a></dt>
<dd>The RiakMapReduce object allows you to build up and run a
map/reduce operation on Riak.</dd>
<dt><a href="riakmapreducephase/riakmapreducephase.html">RiakMapReducePhase()</a> - Class in package <a href="riakmapreducephase/package-summary.html">RiakMapReducePhase</a></dt>
<dd>The RiakMapReducePhase holds information about a Map phase or
Reduce phase in a RiakMapReduce operation.</dd>
<dt><a href="riakobject/riakobject.html">RiakObject()</a> - Class in package <a href="riakobject/package-summary.html">RiakObject</a></dt>
<dd>The RiakObject holds meta information about a Riak object, plus the
object's data.</dd>
<dt><a href="riakstringio/riakstringio.html">RiakStringIO()</a> - Class in package <a href="riakstringio/package-summary.html">RiakStringIO</a></dt>
<dd>Private class used to accumulate a CURL response.</dd>
<dt><a href="riakutils/riakutils.html">RiakUtils()</a> - Class in package <a href="riakutils/package-summary.html">RiakUtils</a></dt>
<dd>Utility functions used by Riak library.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#run()">run()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Run the map/reduce operation. </dd>
</dl>
<h1 id="letterS">S</h1>
<dl>
<dt><a href="riakbucket/riakbucket.html#setAllowMultiples()">setAllowMultiples()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>If set to true, then writes with conflicting data will be stored
and returned to the client. </dd>
<dt><a href="riaklink/riaklink.html#setBucket()">setBucket()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the bucket name of this link.</dd>
<dt><a href="riakclient/riakclient.html#setClientID()">setClientID()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Set the clientID for this RiakClient. </dd>
<dt><a href="riakobject/riakobject.html#setContentType()">setContentType()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Set the content type of this object.</dd>
<dt><a href="riakobject/riakobject.html#setData()">setData()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Set the data stored in this object. </dd>
<dt><a href="riakbucket/riakbucket.html#setDW()">setDW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the DW-value for this bucket. </dd>
<dt><a href="riakclient/riakclient.html#setDW()">setDW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Set the DW-value for this RiakClient. </dd>
<dt><a href="riaklink/riaklink.html#setKey()">setKey()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the key of this link.</dd>
<dt><a href="riakbucket/riakbucket.html#setNVal()">setNVal()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the N-value for this bucket, which is the number of replicas
that will be written of each object in the bucket. </dd>
<dt><a href="riakbucket/riakbucket.html#setProperties()">setProperties()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set multiple bucket properties in one call. </dd>
<dt><a href="riakbucket/riakbucket.html#setProperty()">setProperty()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set a bucket property. </dd>
<dt><a href="riakbucket/riakbucket.html#setR()">setR()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the R-value for this bucket. </dd>
<dt><a href="riakclient/riakclient.html#setR()">setR()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Set the R-value for this RiakClient. </dd>
<dt><a href="riaklink/riaklink.html#setTag()">setTag()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the tag of this link.</dd>
<dt><a href="riakclient/riakclient.html#setW()">setW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Set the W-value for this RiakClient. </dd>
<dt><a href="riakbucket/riakbucket.html#setW()">setW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the W-value for this bucket. </dd>
<dt><a href="riakobject/riakobject.html#status()">status()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the HTTP status from the last operation on this object.</dd>
<dt><a href="riakobject/riakobject.html#store()">store()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Store the object in Riak. </dd>
</dl>
<h1 id="letterT">T</h1>
<dl>
<dt><a href="riaklinkphase/riaklinkphase.html#to_array()">to_array()</a> - Method in class <a href="riaklinkphase/riaklinkphase.html">RiakLinkPhase.RiakLinkPhase</a></dt>
<dd>Convert the RiakLinkPhase to an associative array. </dd>
<dt><a href="riakmapreducephase/riakmapreducephase.html#to_array()">to_array()</a> - Method in class <a href="riakmapreducephase/riakmapreducephase.html">RiakMapReducePhase.RiakMapReducePhase</a></dt>
<dd>Convert the RiakMapReducePhase to an associative array. </dd>
<dt><a href="riaklink/riaklink.html#toLinkHeader()">toLinkHeader()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Convert this RiakLink object to a link header string. </dd>
</dl>
<h1 id="letterW">W</h1>
<dl>
<dt><a href="riakstringio/riakstringio.html#write()">write()</a> - Method in class <a href="riakstringio/riakstringio.html">RiakStringIO.RiakStringIO</a></dt>
</dl>
<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li><li>Class</li><li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="active">Index</li>
</ul>
</div>

<div class="small_links">
<a href="index.html" target="_top">Frames</a>
<a href="index-all.html" target="_top">No frames</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>