224 lines
9.0 KiB
HTML
224 lines
9.0 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_Validation</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_Validation</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-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 FileMaker_Error class that adds information about pre-validation errors.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="FME_Validation.php.html">/FileMaker/Error/Validation.php</a> (line <span class="field">28</span>)
|
|
</p>
|
|
|
|
|
|
<pre>PEAR_Error
|
|
|
|
|
--<a href="../FileMaker/FME.html">FileMaker_Error</a>
|
|
|
|
|
--FileMaker_Error_Validation</pre>
|
|
|
|
</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> |
|
|
<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">void</span>
|
|
<a href="#addError" title="details" class="method-name">addError</a>
|
|
(<span class="var-type"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a></span> <span class="var-name">$field</span>, <span class="var-type">integer</span> <span class="var-name">$rule</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#getErrors" title="details" class="method-name">getErrors</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$fieldName</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#isValidationError" title="details" class="method-name">isValidationError</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">integer</span>
|
|
<a href="#numErrors" title="details" class="method-name">numErrors</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
|
|
<a name="methodaddError" id="addError"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">addError</span> (line <span class="line-number">46</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Adds an error.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
addError
|
|
</span>
|
|
(<span class="var-type"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a></span> <span class="var-name">$field</span>, <span class="var-type">integer</span> <span class="var-name">$rule</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a></span>
|
|
<span class="var-name">$field</span><span class="var-description">: Field object that failed pre-validation.</span> </li>
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$rule</span><span class="var-description">: Pre-validation rule that failed specified as one of the FILEMAKER_RULE_* constants.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$value</span><span class="var-description">: Value that failed pre-validation.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetErrors" id="getErrors"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getErrors</span> (line <span class="line-number">94</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns an array of arrays describing the pre-validation errors that occurred.</p>
|
|
<p class="description"><p>Each entry in the outer array represents a pre-validation failure. Each failure is represented by a three-element array with the following members:</p><p><ul><li>0 => The field object for the field that failed pre-validation.</li><li>1 => The pre-validation rule that failed specified as a
|
|
FILEMAKER_RULE_* constant.</li><li>2 => The value entered for the field that failed pre-validation.</li></ul> Multiple pre-validation rules can fail on a single field. If you set the optional $fieldName parameter, then failures for only the specified field are returned.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Pre-validation error details.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
getErrors
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$fieldName</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$fieldName</span><span class="var-description">: Name of the field to get errors for.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</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">58</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> TRUE, to indicate that this is a pre-validation error object.</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">Redefinition of:</div>
|
|
<dl>
|
|
<dt><a href="../FileMaker/FME.html#methodisValidationError">FileMaker_Error::isValidationError()</a></dt>
|
|
<dd>Indicates whether the error is a detailed pre-validation error or a FileMaker Web Publishing Engine error.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
<a name="methodnumErrors" id="numErrors"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">numErrors</span> (line <span class="line-number">68</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the number of pre-validation rules that failed.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Number of failures.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">integer</span>
|
|
<span class="method-name">
|
|
numErrors
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../FileMaker/FME.html">FileMaker_Error</a></span></p>
|
|
<blockquote>
|
|
<span class="method-name"><a href="../FileMaker/FME.html#methodFileMaker_Error">FileMaker_Error::FileMaker_Error()</a></span><br>
|
|
<span class="method-name"><a href="../FileMaker/FME.html#methodgetErrorString">FileMaker_Error::getErrorString()</a></span><br>
|
|
<span class="method-name"><a href="../FileMaker/FME.html#methodgetMessage">FileMaker_Error::getMessage()</a></span><br>
|
|
<span class="method-name"><a href="../FileMaker/FME.html#methodisValidationError">FileMaker_Error::isValidationError()</a></span><br>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Mon, 28 Jul 2008 14:47:45 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |