235 lines
8.5 KiB
HTML
235 lines
8.5 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!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>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class FileMaker_Error</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name">Class FileMaker_Error</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-descendents">Descendents</a>
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Extension of the PEAR_Error class for use in all FileMaker classes.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_FileMaker---Error.php.html">/FileMaker/Error.php</a> (line <span class="field">31</span>)
|
|
</p>
|
|
|
|
|
|
<pre>PEAR_Error
|
|
|
|
|
--FileMaker_Error</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-descendents"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Direct descendents</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Descendents</span>
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
|
<tr>
|
|
<th class="class-table-header">Class</th>
|
|
<th class="class-table-header">Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></td>
|
|
<td>
|
|
Extension of the FileMaker_Error class that adds information about pre-validation errors.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-descendents">Descendents</a> |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">FileMaker_Error</span>
|
|
<a href="#FileMaker_Error" title="details" class="method-name">FileMaker_Error</a>
|
|
(<span class="var-type">FileMaker_Delegate</span> <span class="var-name">&$fm</span>, [<span class="var-type">string</span> <span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$code</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">string</span>
|
|
<a href="#getErrorString" title="details" class="method-name">getErrorString</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">string</span>
|
|
<a href="#getMessage" title="details" class="method-name">getMessage</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#isValidationError" title="details" class="method-name">isValidationError</a>
|
|
()
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-descendents">Descendents</a> |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
|
|
<a name="methodFileMaker_Error" id="FileMaker_Error"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor FileMaker_Error</span> (line <span class="line-number">49</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Overloaded FileMaker_Error constructor.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">FileMaker_Error</span>
|
|
<span class="method-name">
|
|
FileMaker_Error
|
|
</span>
|
|
(<span class="var-type">FileMaker_Delegate</span> <span class="var-name">&$fm</span>, [<span class="var-type">string</span> <span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$code</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">FileMaker_Delegate</span>
|
|
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Delegate object this error came from.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$message</span><span class="var-description">: Error message.</span> </li>
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$code</span><span class="var-description">: Error code.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetErrorString" id="getErrorString"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getErrorString</span> (line <span class="line-number">83</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the string representation of $this->code in the language currently set for PHP error messages in FileMaker Server Admin Console.</p>
|
|
<p class="description"><p>You should call getMessage() in most cases, if you are not sure whether the error is a FileMaker Web Publishing Engine error with an error code.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Error description.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
getErrorString
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetMessage" id="getMessage"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getMessage</span> (line <span class="line-number">65</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Overloads getMessage() to return an equivalent FileMaker Web Publishing Engine error if no message is explicitly set and this object has an error code.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Error message.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
getMessage
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodisValidationError" id="isValidationError"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">isValidationError</span> (line <span class="line-number">113</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Indicates whether the error is a detailed pre-validation error or a FileMaker Web Publishing Engine error.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> FALSE, to indicate that this is an error from the Web Publishing Engine.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
isValidationError
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
<hr class="separator" />
|
|
<div class="notes">Redefined in descendants as:</div>
|
|
<ul class="redefinitions">
|
|
<li>
|
|
<a href="../FileMaker/FileMaker_Error_Validation.html#methodisValidationError">FileMaker_Error_Validation::isValidationError()</a>
|
|
: Indicates whether the error is a detailed pre-validation error or a FileMaker Web Publishing Engine error.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Wed, 29 Jun 2011 12:31:22 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |