This repository was archived by the owner on Feb 1, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 327
/
Copy pathclass.mongoresultexception.html
129 lines (84 loc) · 4.52 KB
/
class.mongoresultexception.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!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>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />
</head>
<body class="docs"><div class="navbar navbar-fixed-top">
<div class="navbar-inner clearfix">
<ul class="nav" style="width: 100%">
<li style="float: left;"><a href="class.mongoexception.html">« MongoException</a></li>
<li style="float: right;"><a href="mongoresultexception.getdocument.html">MongoResultException::getDocument »</a></li>
</ul>
</div>
</div>
<div id="breadcrumbs" class="clearfix">
<ul class="breadcrumbs-container">
<li><a href="index.html">PHP Manual</a></li>
<li><a href="mongo.exceptions.html">Exceptions</a></li>
<li>The MongoResultException class</li>
</ul>
</div>
<div id="layout">
<div id="layout-content"><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=".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=".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=".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=".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="methodname"><a href="mongoresultexception.getdocument.html" class="methodname">getDocument</a></span>(): <span class="type">array</span></div>
}</div>
</div>
<div class="section" id="mongoresultexception.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="mongoresultexception.props.document"><var class="varname">document</var></dt>
<dd>
<p class="para">The raw result document as an array.</p>
</dd>
</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>
</div></div></body></html>