<!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>Creates a database error</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb.execute.html">MongoDB::execute</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb.get.html">MongoDB::__get</a></div> <div class="up"><a href="class.mongodb.html">MongoDB</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb.forceerror" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB::forceError</h1> <p class="verinfo">(PECL mongo >=0.9.5)</p><p class="refpurpose"><span class="refname">MongoDB::forceError</span> — <span class="dc-title">Creates a database error</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb.forceerror-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>MongoDB::forceError</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> This method is not very useful for normal MongoDB use. It forces a database error to occur. This means that <span class="function"><a href="mongodb.lasterror.html" class="function">MongoDB::lastError()</a></span> will return a generic database error after running this command. </p> <p class="para"> This command is identical to running: <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">public function </span><span style="color: #0000BB">forceError</span><span style="color: #007700">() {<br /> return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">command</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'forceerror' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb.forceerror-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb.forceerror-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the database response. </p> </div> <div class="refsect1 changelog" id="refsect1-mongodb.forceerror-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>1.2.11</td> <td>Emits <strong><code>E_DEPRECATED</code></strong> when used.</td> </tr> </tbody> </table> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb.execute.html">MongoDB::execute</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb.get.html">MongoDB::__get</a></div> <div class="up"><a href="class.mongodb.html">MongoDB</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>