/usr/share/doc/php-mockery/html/reference/mockery/exceptions.html is in php-mockery-doc 0.9.4-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Mockery Exceptions — Mockery Docs 0.9 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="top" title="Mockery Docs 0.9 documentation" href="../../index.html"/>
<link rel="up" title="Mockery" href="index.html"/>
<link rel="next" title="Reserved Method Names" href="reserved_method_names.html"/>
<link rel="prev" title="Mockery Global Configuration" href="configuration.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> Mockery Docs
</a>
<div class="version">
0.9
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting Started</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../startup_methods.html">Quick Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../expectations.html">Expectation Declarations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../argument_validation.html">Argument Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../partial_mocks.html">Creating Partial Mocks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../public_properties.html">Mocking Public Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../public_static_properties.html">Mocking Public Static Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../pass_by_reference_behaviours.html">Preserving Pass-By-Reference Method Parameter Behaviour</a></li>
<li class="toctree-l2"><a class="reference internal" href="../demeter_chains.html">Mocking Demeter Chains And Fluent Interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object_recording.html">Mock Object Recording</a></li>
<li class="toctree-l2"><a class="reference internal" href="../final_methods_classes.html">Dealing with Final Classes/Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../magic_methods.html">PHP Magic Methods</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Mockery</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="configuration.html">Mockery Global Configuration</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="">Mockery Exceptions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mockeryexceptioninvalidcountexception">MockeryExceptionInvalidCountException</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mockeryexceptioninvalidorderexception">MockeryExceptionInvalidOrderException</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mockeryexceptionnomatchingexpectationexception">MockeryExceptionNoMatchingExpectationException</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reserved_method_names.html">Reserved Method Names</a></li>
<li class="toctree-l3"><a class="reference internal" href="gotchas.html">Gotchas!</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#mockery-reference">Mockery Reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../cookbook/index.html">Cookbook</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Mockery Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Reference</a> »</li>
<li><a href="index.html">Mockery</a> »</li>
<li>Mockery Exceptions</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/reference/mockery/exceptions.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="mockery-exceptions">
<span id="index-0"></span><h1>Mockery Exceptions<a class="headerlink" href="#mockery-exceptions" title="Permalink to this headline">¶</a></h1>
<p>Mockery throws three types of exceptions when it cannot verify a mock object.</p>
<ol class="arabic simple">
<li><code class="docutils literal"><span class="pre">\Mockery\Exception\InvalidCountException</span></code></li>
<li><code class="docutils literal"><span class="pre">\Mockery\Exception\InvalidOrderException</span></code></li>
<li><code class="docutils literal"><span class="pre">\Mockery\Exception\NoMatchingExpectationException</span></code></li>
</ol>
<p>You can capture any of these exceptions in a try...catch block to query them
for specific information which is also passed along in the exception message
but is provided separately from getters should they be useful when logging or
reformatting output.</p>
<div class="section" id="mockeryexceptioninvalidcountexception">
<h2>MockeryExceptionInvalidCountException<a class="headerlink" href="#mockeryexceptioninvalidcountexception" title="Permalink to this headline">¶</a></h2>
<p>The exception class is used when a method is called too many (or too few)
times and offers the following methods:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">getMock()</span></code> - return actual mock object</li>
<li><code class="docutils literal"><span class="pre">getMockName()</span></code> - return the name of the mock object</li>
<li><code class="docutils literal"><span class="pre">getMethodName()</span></code> - return the name of the method the failing expectation
is attached to</li>
<li><code class="docutils literal"><span class="pre">getExpectedCount()</span></code> - return expected calls</li>
<li><code class="docutils literal"><span class="pre">getExpectedCountComparative()</span></code> - returns a string, e.g. <code class="docutils literal"><span class="pre"><=</span></code> used to
compare to actual count</li>
<li><code class="docutils literal"><span class="pre">getActualCount()</span></code> - return actual calls made with given argument
constraints</li>
</ul>
</div>
<div class="section" id="mockeryexceptioninvalidorderexception">
<h2>MockeryExceptionInvalidOrderException<a class="headerlink" href="#mockeryexceptioninvalidorderexception" title="Permalink to this headline">¶</a></h2>
<p>The exception class is used when a method is called outside the expected order
set using the <code class="docutils literal"><span class="pre">ordered()</span></code> and <code class="docutils literal"><span class="pre">globally()</span></code> expectation modifiers. It
offers the following methods:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">getMock()</span></code> - return actual mock object</li>
<li><code class="docutils literal"><span class="pre">getMockName()</span></code> - return the name of the mock object</li>
<li><code class="docutils literal"><span class="pre">getMethodName()</span></code> - return the name of the method the failing expectation
is attached to</li>
<li><code class="docutils literal"><span class="pre">getExpectedOrder()</span></code> - returns an integer represented the expected index
for which this call was expected</li>
<li><code class="docutils literal"><span class="pre">getActualOrder()</span></code> - return the actual index at which this method call
occurred.</li>
</ul>
</div>
<div class="section" id="mockeryexceptionnomatchingexpectationexception">
<h2>MockeryExceptionNoMatchingExpectationException<a class="headerlink" href="#mockeryexceptionnomatchingexpectationexception" title="Permalink to this headline">¶</a></h2>
<p>The exception class is used when a method call does not match any known
expectation. All expectations are uniquely identified in a mock object by the
method name and the list of expected arguments. You can disable this exception
and opt for returning NULL from all unexpected method calls by using the
earlier mentioned shouldIgnoreMissing() behaviour modifier. This exception
class offers the following methods:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">getMock()</span></code> - return actual mock object</li>
<li><code class="docutils literal"><span class="pre">getMockName()</span></code> - return the name of the mock object</li>
<li><code class="docutils literal"><span class="pre">getMethodName()</span></code> - return the name of the method the failing expectation
is attached to</li>
<li><code class="docutils literal"><span class="pre">getActualArguments()</span></code> - return actual arguments used to search for a
matching expectation</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="reserved_method_names.html" class="btn btn-neutral float-right" title="Reserved Method Names" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="configuration.html" class="btn btn-neutral" title="Mockery Global Configuration" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, Pádraic Brady, Dave Marshall, Wouter, Graham Campbell.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.9',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|