/usr/share/doc/php-mockery/html/reference/mockery/configuration.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 | <!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 Global Configuration — 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="Mockery Exceptions" href="exceptions.html"/>
<link rel="prev" title="Mockery" href="index.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 current"><a class="current reference internal" href="">Mockery Global Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="exceptions.html">Mockery Exceptions</a></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 Global Configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/reference/mockery/configuration.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-global-configuration">
<span id="index-0"></span><h1>Mockery Global Configuration<a class="headerlink" href="#mockery-global-configuration" title="Permalink to this headline">¶</a></h1>
<p>To allow for a degree of fine-tuning, Mockery utilises a singleton
configuration object to store a small subset of core behaviours. The three
currently present include:</p>
<ul class="simple">
<li>Option to allow/disallow the mocking of methods which do not actually exist</li>
<li>Option to allow/disallow the existence of expectations which are never
fulfilled (i.e. unused)</li>
<li>Setter/Getter for added a parameter map for internal PHP class methods
(<code class="docutils literal"><span class="pre">Reflection</span></code> cannot detect these automatically)</li>
</ul>
<p>By default, the first two behaviours are enabled. Of course, there are
situations where this can lead to unintended consequences. The mocking of
non-existent methods may allow mocks based on real classes/objects to fall out
of sync with the actual implementations, especially when some degree of
integration testing (testing of object wiring) is not being performed.
Allowing unfulfilled expectations means unnecessary mock expectations go
unnoticed, cluttering up test code, and potentially confusing test readers.</p>
<p>You may allow or disallow these behaviours (whether for whole test suites or
just select tests) by using one or both of the following two calls:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">\Mockery::getConfiguration()->allowMockingNonExistentMethods(bool);</span>
<span class="x">\Mockery::getConfiguration()->allowMockingMethodsUnnecessarily(bool);</span>
</pre></div>
</div>
<p>Passing a true allows the behaviour, false disallows it. Both take effect
immediately until switched back. In both cases, if either behaviour is
detected when not allowed, it will result in an Exception being thrown at that
point. Note that disallowing these behaviours should be carefully considered
since they necessarily remove at least some of Mockery’s flexibility.</p>
<p>The other two methods are:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">\Mockery::getConfiguration()->setInternalClassMethodParamMap($class, $method, array $paramMap)</span>
<span class="x">\Mockery::getConfiguration()->getInternalClassMethodParamMap($class, $method)</span>
</pre></div>
</div>
<p>These are used to define parameters (i.e. the signature string of each) for the
methods of internal PHP classes (e.g. SPL, or PECL extension classes like
ext/mongo’s MongoCollection. Reflection cannot analyse the parameters of internal
classes. Most of the time, you never need to do this. It’s mainly needed where an
internal class method uses pass-by-reference for a parameter - you MUST in such
cases ensure the parameter signature includes the <code class="docutils literal"><span class="pre">&</span></code> symbol correctly as Mockery
won’t correctly add it automatically for internal classes.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="exceptions.html" class="btn btn-neutral float-right" title="Mockery Exceptions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Mockery" 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>
|