<!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>The MongoResultException class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongoexception.html">MongoException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoresultexception.getdocument.html">MongoResultException::getDocument</a></div>
<div class="up"><a href="mongo.exceptions.html">Exceptions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongoresultexception" class="reference">
<h1 class="title">The MongoResultException class</h1>
<div class="partintro"><p class="verinfo">(PECL mongo >=1.3.0)</p>
<div class="section" id="mongoresultexception.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The MongoResultException is thrown by several command helpers (such as
<span class="methodname"><a href="mongocollection.findandmodify.html" class="methodname">MongoCollection::findAndModify()</a></span>) in the event of
failure. The original result document is available through
<span class="methodname"><a href="mongoresultexception.getdocument.html" class="methodname">MongoResultException::getDocument()</a></span>.
</p>
</div>
<div class="section" id="mongoresultexception.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoResultException</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.mongoexception.html" class="classname">MongoException</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.mongoresultexception.html#mongoresultexception.props.document">$<var class="varname">document</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited properties */</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">string</span>
<var class="varname"><a href="class.exception.html#exception.props.message">$<var class="varname">message</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">int</span>
<var class="varname"><a href="class.exception.html#exception.props.code">$<var class="varname">code</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">string</span>
<var class="varname"><a href="class.exception.html#exception.props.file">$<var class="varname">file</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">int</span>
<var class="varname"><a href="class.exception.html#exception.props.line">$<var class="varname">line</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongoresultexception.getdocument.html" class="methodname">getDocument</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="mongoresultexception.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="mongoresultexception.props.document">
<span class="term"><var class="varname"><var class="varname">document</var></var></span>
<dd>
<p class="para">The raw result document as an array.</p>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongoresultexception.getdocument.html">MongoResultException::getDocument</a> — Retrieve the full result document</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongoexception.html">MongoException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoresultexception.getdocument.html">MongoResultException::getDocument</a></div>
<div class="up"><a href="mongo.exceptions.html">Exceptions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
