| 98 |
- |
1 |
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
|
|
|
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><title>SetFailureImage</title><link rel="stylesheet" type="text/css" href="phplotdoc.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="PHPlot Reference Manual" /><link rel="up" href="reference.html" title="PHPlot Function Reference" /><link rel="prev" href="SetErrorBarSize.html" title="SetErrorBarSize" /><link rel="next" href="SetFileFormat.html" title="SetFileFormat" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetFailureImage</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetErrorBarSize.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetFileFormat.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetFailureImage"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetFailureImage</span></h2><p>SetFailureImage — Enable or disable error image production on failure</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot->SetFailureImage(<em class="parameter"><code>$error_image</code></em>)</pre></div><div class="refsect1"><a id="idp1378084180"></a><h2>Description</h2><p>
|
|
|
3 |
<code class="function">SetFailureImage</code> can be used to disable the error image
|
|
|
4 |
normally produced by PHPlot if a fatal error occurs.
|
|
|
5 |
</p></div><div class="refsect1"><a id="idp1378085228"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$error_image</code></em></span></dt><dd><p>
|
|
|
6 |
True to enable the error image, False to disable the error image.
|
|
|
7 |
</p></dd></dl></div></div><div class="refsect1"><a id="idp1378086764"></a><h2>Notes</h2><p>
|
|
|
8 |
See <a class="xref" href="conc-errors.html" title="3.9. Error Handling">Section 3.9, “Error Handling”</a> for an overview of error handling in PHPlot.
|
|
|
9 |
The error image is enabled by default.
|
|
|
10 |
</p><p>
|
|
|
11 |
If failure occurs when error images are disabled, PHPlot will still trigger
|
|
|
12 |
a user-level error condition, which will normally log the error to the
|
|
|
13 |
server log and terminate the script. However, there will be no feedback to
|
|
|
14 |
the user that the error occurred.
|
|
|
15 |
</p><p>
|
|
|
16 |
<code class="function">SetFailureImage(False)</code> should be called right after
|
|
|
17 |
creating the PHPlot object if using <a class="xref" href="EncodeImage.html" title="EncodeImage"><span class="refentrytitle">EncodeImage</span></a> to return
|
|
|
18 |
the image as a string (rather than output the image).
|
|
|
19 |
This will make sure that no unexpected error image is produced by a script
|
|
|
20 |
that would not normally produce an image at all.
|
|
|
21 |
</p></div><div class="refsect1"><a id="idp1378089444"></a><h2>History</h2><p>
|
|
|
22 |
This function was added in PHPlot-5.5.0.
|
|
|
23 |
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetErrorBarSize.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="SetFileFormat.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetErrorBarSize </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetFileFormat</td></tr></table></div></body></html>
|