<!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>Checks if an array is a database reference</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodbref.get.html">MongoDBRef::get</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongominkey.html">MongoMinKey</a></div> <div class="up"><a href="class.mongodbref.html">MongoDBRef</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodbref.isref" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDBRef::isRef</h1> <p class="verinfo">(PECL mongo >= 0.9.0)</p><p class="refpurpose"><span class="refname">MongoDBRef::isRef</span> — <span class="dc-title">Checks if an array is a database reference</span></p> </div> <div class="refsect1 description" id="refsect1-mongodbref.isref-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><strong>MongoDBRef::isRef</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">$ref</code></span> )</div> <p class="para rdfs-comment"> This method does not actually follow the reference, so it does not determine if it is broken or not. It merely checks that <em><code class="parameter">ref</code></em> is in valid database reference format (in that it is an object or array with $ref and $id fields). </p> </div> <div class="refsect1 parameters" id="refsect1-mongodbref.isref-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"> <em><code class="parameter">ref</code></em> </span> <dd> <p class="para"> Array or object to check. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodbref.isref-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><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodbref.get.html">MongoDBRef::get</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongominkey.html">MongoMinKey</a></div> <div class="up"><a href="class.mongodbref.html">MongoDBRef</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>