<!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 MongoDB\Driver\Exception\RuntimeException class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-driver-exception-logicexception.html">MongoDB\Driver\Exception\LogicException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-runtimeexception.haserrorlabel.html">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel</a></div>
<div class="up"><a href="mongodb.exceptions.html">MongoDB\Driver\Exception</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-driver-exception-runtimeexception" class="reference">
<h1 class="title">The MongoDB\Driver\Exception\RuntimeException class</h1>
<div class="partintro"><p class="verinfo">(mongodb >= 1.0.0)</p>
<div class="section" id="mongodb-driver-exception-runtimeexception.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Thrown when the driver encounters a runtime error (e.g. internal error from
<a href="https://github.com/mongodb/mongo-c-driver" class="link external">» libmongoc</a>).
</p>
</div>
<div class="section" id="mongodb-driver-exception-runtimeexception.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoDB\Driver\Exception\RuntimeException</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.runtimeexception.html" class="classname">RuntimeException</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.mongodb-driver-exception-exception.html" class="interfacename">MongoDB\Driver\Exception\Exception</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">bool</span>
<var class="varname"><a href="class.mongodb-driver-exception-runtimeexception.html#mongodb-driver-exception-runtimeexception.props.errorlabels">$<var class="varname">errorLabels</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">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongodb-driver-runtimeexception.haserrorlabel.html" class="methodname">hasErrorLabel</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$errorLabel</code></span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="exception.getmessage.html" class="methodname">Exception::getMessage</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">Throwable</span> <span class="methodname"><a href="exception.getprevious.html" class="methodname">Exception::getPrevious</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="exception.getcode.html" class="methodname">Exception::getCode</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="exception.getfile.html" class="methodname">Exception::getFile</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="exception.getline.html" class="methodname">Exception::getLine</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="exception.gettrace.html" class="methodname">Exception::getTrace</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="exception.gettraceasstring.html" class="methodname">Exception::getTraceAsString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="exception.tostring.html" class="methodname">Exception::__toString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">private</span> <span class="type">void</span> <span class="methodname"><a href="exception.clone.html" class="methodname">Exception::__clone</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="mongodb-driver-exception-runtimeexception.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="mongodb-driver-exception-runtimeexception.props.errorlabels"><var class="varname"><var class="varname">errorLabels</var></var></dt>
<dd>
<p class="para">
Contains an array of error labels to go with an exception. For example,
error labels can be used to detect whether a transaction can be retried
safely if the <em>TransientTransactionError</em> label is
present. The existence of a specific error label should be tested for
with the
<span class="methodname"><a href="mongodb-driver-runtimeexception.haserrorlabel.html" class="methodname">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel()</a></span>,
instead of interpreting this <em>errorLabels</em> property
manually.
</p>
</dd>
</dl>
</div>
<div class="section">
<h2 class="title">Changelog</h2>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.6.0</td>
<td>
<p class="para">
The
<span class="methodname"><a href="mongodb-driver-runtimeexception.haserrorlabel.html" class="methodname">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel()</a></span>
method and
<a href="class.mongodb-driver-exception-runtimeexception.html#mongodb-driver-exception-runtimeexception.props.errorlabels" class="link">MongoDB\Driver\Exception\RuntimeException::errorLabels</a>
property have been added.
</p>
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-runtimeexception.haserrorlabel.html">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel</a> — Returns whether an error label is associated with an exception</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-driver-exception-logicexception.html">MongoDB\Driver\Exception\LogicException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-runtimeexception.haserrorlabel.html">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel</a></div>
<div class="up"><a href="mongodb.exceptions.html">MongoDB\Driver\Exception</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
