<!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>Check if a value is a valid ObjectId</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongoid.gettimestamp.html">MongoId::getTimestamp</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongoid.set-state.html">MongoId::__set_state</a></div> <div class="up"><a href="class.mongoid.html">MongoId</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongoid.isvalid" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoId::isValid</h1> <p class="verinfo">(PECL mongo >= 1.5.0)</p><p class="refpurpose"><span class="refname">MongoId::isValid</span> — <span class="dc-title">Check if a value is a valid ObjectId</span></p> </div> <div id="mongoid.isvalid-soft-deprecation-notice" class="soft-deprecation-notice"> <blockquote class="sidebar"> <p class="para">This extension that defines this method is deprecated. Instead, the <a href="set.mongodb.html" class="link">MongoDB</a> extension should be used. There is no equivalent for this method in the new extension.</p> </blockquote> </div> <div class="refsect1 description" id="refsect1-mongoid.isvalid-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>MongoId::isValid</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">$value</code></span> )</div> <p class="para rdfs-comment"> This method may be used to check a variable before passing it as an argument to <span class="function"><a href="mongoid.construct.html" class="function">MongoId::__construct()</a></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-mongoid.isvalid-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">value</code> </dt> <dd> <p class="para"> The value to check for validity. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-mongoid.isvalid-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> if <code class="parameter">value</code> is a <a href="class.mongoid.html" class="classname">MongoId</a> instance or a string consisting of exactly 24 hexadecimal characters; otherwise, <strong><code>FALSE</code></strong> is returned. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongoid.gettimestamp.html">MongoId::getTimestamp</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongoid.set-state.html">MongoId::__set_state</a></div> <div class="up"><a href="class.mongoid.html">MongoId</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>