<!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>Set/get the various assert flags</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.assert.html">assert</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.assert-options" class="refentry"> <div class="refnamediv"> <h1 class="refname">assert_options</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">assert_options</span> — <span class="dc-title">Set/get the various assert flags</span></p> </div> <div class="refsect1 description" id="refsect1-function.assert-options-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>assert_options</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$what</code></span> [, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span> ] )</div> <p class="para rdfs-comment"> Set the various <span class="function"><a href="function.assert.html" class="function">assert()</a></span> control options or just query their current settings. </p> </div> <div class="refsect1 parameters" id="refsect1-function.assert-options-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">what</code></em></span> <dd> <p class="para"> <table class="doctable table"> <caption><strong>Assert Options</strong></caption> <thead> <tr> <th>Option</th> <th>INI Setting</th> <th>Default value</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>ASSERT_ACTIVE</td> <td>assert.active</td> <td>1</td> <td>enable <span class="function"><a href="function.assert.html" class="function">assert()</a></span> evaluation</td> </tr> <tr> <td>ASSERT_WARNING</td> <td>assert.warning</td> <td>1</td> <td>issue a PHP warning for each failed assertion</td> </tr> <tr> <td>ASSERT_BAIL</td> <td>assert.bail</td> <td>0</td> <td>terminate execution on failed assertions</td> </tr> <tr> <td>ASSERT_QUIET_EVAL</td> <td>assert.quiet_eval</td> <td>0</td> <td> disable error_reporting during assertion expression evaluation </td> </tr> <tr> <td>ASSERT_CALLBACK</td> <td>assert.callback</td> <td>(<strong><code>NULL</code></strong>)</td> <td>Callback to call on failed assertions</td> </tr> </tbody> </table> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">value</code></em></span> <dd> <p class="para"> An optional new value for the option. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.assert-options-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the original setting of any option or <strong><code>FALSE</code></strong> on errors. </p> </div> <div class="refsect1 examples" id="refsect1-function.assert-options-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-477"> <p><strong>Example #1 <span class="function"><strong>assert_options()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// This is our function to handle <br />// assert failures<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">assert_failure</span><span style="color: #007700">()<br />{<br /> echo </span><span style="color: #DD0000">'Assert failed'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// This is our test function<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">test_assert</span><span style="color: #007700">(</span><span style="color: #0000BB">$parameter</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">assert</span><span style="color: #007700">(</span><span style="color: #0000BB">is_bool</span><span style="color: #007700">(</span><span style="color: #0000BB">$parameter</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #FF8000">// Set our assert options<br /></span><span style="color: #0000BB">assert_options</span><span style="color: #007700">(</span><span style="color: #0000BB">ASSERT_ACTIVE</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">assert_options</span><span style="color: #007700">(</span><span style="color: #0000BB">ASSERT_BAIL</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">assert_options</span><span style="color: #007700">(</span><span style="color: #0000BB">ASSERT_WARNING</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">assert_options</span><span style="color: #007700">(</span><span style="color: #0000BB">ASSERT_CALLBACK</span><span style="color: #007700">, </span><span style="color: #DD0000">'assert_failure'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Make an assert that would fail<br /></span><span style="color: #0000BB">test_assert</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// This is never reached due to ASSERT_BAIL <br />// being true<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'Never reached'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.assert-options-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.assert.html" class="function" rel="rdfs-seeAlso">assert()</a> - Checks if assertion is FALSE</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.assert.html">assert</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>