<!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>Fetch an SNMP object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="snmp.construct.html">SNMP::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="snmp.geterrno.html">SNMP::getErrno</a></div>
<div class="up"><a href="class.snmp.html">SNMP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="snmp.get" class="refentry">
<div class="refnamediv">
<h1 class="refname">SNMP::get</h1>
<p class="verinfo">(PHP 5 >= 5.4.0)</p><p class="refpurpose"><span class="refname">SNMP::get</span> — <span class="dc-title">Fetch an <acronym title="Simple Network Management Protocol">SNMP</acronym> object</span></p>
</div>
<div class="refsect1 description" id="refsect1-snmp.get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>SNMP::get</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$object_id</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$preserve_keys</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Fetch an <acronym title="Simple Network Management Protocol">SNMP</acronym> object specified in
<em><code class="parameter">object_id</code></em> using GET query.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-snmp.get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
If <em><code class="parameter">object_id</code></em> is a string, then <span class="methodname"><strong>SNMP::get()</strong></span>
will return <acronym title="Simple Network Management Protocol">SNMP</acronym> object as string. If
<em><code class="parameter">object_id</code></em> is a array, all requested <acronym title="Simple Network Management Protocol">SNMP</acronym>
objects will be returned as associative array of the <acronym title="Simple Network Management Protocol">SNMP</acronym> object ids and their
values.
</p>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object_id</code></em></span>
<dd>
<p class="para">
The <acronym title="Simple Network Management Protocol">SNMP</acronym> object (OID) or objects
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">preserve_keys</code></em></span>
<dd>
<p class="para">
When <em><code class="parameter">object_id</code></em> is a array and
<em><code class="parameter">preserve_keys</code></em> set to <strong><code>TRUE</code></strong> keys in results
will be taken exactly as in <em><code class="parameter">object_id</code></em>,
otherwise <var class="varname"><var class="varname">SNMP::oid_output_format</var></var> property is used to determinate
the form of keys.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-snmp.get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <acronym title="Simple Network Management Protocol">SNMP</acronym> objects requested as string or array
depending on <em><code class="parameter">object_id</code></em> type or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 errors" id="refsect1-snmp.get-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
This method does not throw any exceptions by default.
To enable throwing an SNMPException exception when some of library errors occur
the SNMP class parameter <em><code class="parameter">exceptions_enabled</code></em>
should be set to a corresponding value. See <a href="class.snmp.html#snmp.props.exceptions-enabled" class="link">
<em><code class="parameter">SNMP::$exceptions_enabled</code></em> explanation</a> for more details.
</p>
</div>
<div class="refsect1 examples" id="refsect1-snmp.get-examples">
<h3 class="title">Examples</h3>
<div class="example" id="snmp.get.example.singleoid">
<p><strong>Example #1 Single <acronym title="Simple Network Management Protocol">SNMP</acronym> object</strong></p>
<div class="example-contents"><p>
Single <acronym title="Simple Network Management Protocol">SNMP</acronym> object may be requested in two ways: as
string resulting string return value or as single-element array with
associative array as output.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_1</span><span style="color: #007700">, </span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"public"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$sysdescr </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"sysDescr.0"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$sysdescr</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$sysdescr </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"sysDescr.0"</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$sysdescr</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
STRING: Test server
Array
(
[SNMPv2-MIB::sysDescr.0] => STRING: Test server
)
</pre></div>
</div>
</div>
<div class="example" id="snmp.get.example.oidarray">
<p><strong>Example #2 Miltiple <acronym title="Simple Network Management Protocol">SNMP</acronym> objects</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
$session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public");<br /> $results = $session->get(array("sysDescr.0", "sysName.0"));<br /> print_r($results);<br /> $session->close();</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[SNMPv2-MIB::sysDescr.0] => STRING: Test server
[SNMPv2-MIB::sysName.0] => STRING: myhost.nodomain
)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-snmp.get-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="snmp.geterrno.html" class="methodname" rel="rdfs-seeAlso">SNMP::getErrno()</a> - Get last error code</span></li>
<li class="member"> <span class="methodname"><a href="snmp.geterror.html" class="methodname" rel="rdfs-seeAlso">SNMP::getError()</a> - Get last error message</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="snmp.construct.html">SNMP::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="snmp.geterrno.html">SNMP::getErrno</a></div>
<div class="up"><a href="class.snmp.html">SNMP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
