<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Update the RRD database file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rrdupdater.construct.html">RRDUpdater::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.sam.html">SAM</a></div>
<div class="up"><a href="class.rrdupdater.html">RRDUpdater</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="rrdupdater.update" class="refentry">
<div class="refnamediv">
<h1 class="refname">RRDUpdater::update</h1>
<p class="verinfo">(PECL rrd >= 0.9.0)</p><p class="refpurpose"><span class="refname">RRDUpdater::update</span> — <span class="dc-title">Update the RRD database file</span></p>
</div>
<div class="refsect1 description" id="refsect1-rrdupdater.update-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>RRDUpdater::update</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$values</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$time</code>
<span class="initializer"> = time()</span>
</span>
] )</div>
<p class="para rdfs-comment">
Updates the RRD file defined via <span class="methodname"><a href="rrdupdater.construct.html" class="methodname">RRDUpdater::__construct()</a></span>.
The file is updated with a specific values.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rrdupdater.update-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">values</code></dt>
<dd>
<p class="para">
Data for update. Key is data source name.
</p>
</dd>
<dt>
<code class="parameter">time</code></dt>
<dd>
<p class="para">
Time value for updating the RRD with a particulat data. Default value
is current time.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rrdupdater.update-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-rrdupdater.update-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws a <a href="class.exception.html" class="classname">Exception</a> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-rrdupdater.update-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5638">
<p><strong>Example #1 <span class="methodname"><strong>RRDUpdater::update()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$updator </span><span style="color: #007700">= new </span><span style="color: #0000BB">RRDUpdater</span><span style="color: #007700">(</span><span style="color: #DD0000">"speed.rrd"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//updates the data source "speed" with value "12411"<br />//for time defined by timestamp "920807700"<br /></span><span style="color: #0000BB">$updator</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"speed" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"12411"</span><span style="color: #007700">), </span><span style="color: #DD0000">"920807700"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rrdupdater.construct.html">RRDUpdater::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.sam.html">SAM</a></div>
<div class="up"><a href="class.rrdupdater.html">RRDUpdater</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
