397 lines
16 KiB
HTML
397 lines
16 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_Command</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_Command</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">Base Command class. Represents commands that add records, delete records, duplicate records, edit records, perform find requests, and perform ScriptMaker scripts.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="FMC.php.html">/FileMaker/Command.php</a> (line <span class="field">29</span>)
|
|
</p>
|
|
|
|
|
|
<pre></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/FMC_Add.html">FileMaker_Command_Add</a></td>
|
|
<td>
|
|
Command class that adds a new record.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_CompoundFind.html">FileMaker_Command_CompoundFind</a></td>
|
|
<td>
|
|
Command class that performs multiple find requests, also known as a compound find set.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_Delete.html">FileMaker_Command_Delete</a></td>
|
|
<td>
|
|
Command class that deletes a single record.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_Duplicate.html">FileMaker_Command_Duplicate</a></td>
|
|
<td>
|
|
Command class that duplicates a single record.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_Edit.html">FileMaker_Command_Edit</a></td>
|
|
<td>
|
|
Command class that edits a single record.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a></td>
|
|
<td>
|
|
Command class that finds records using the specified criteria.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em"><a href="../FileMaker/FMC_PerformScript.html">FileMaker_Command_PerformScript</a></td>
|
|
<td>
|
|
Command class that performs a ScriptMaker script.
|
|
</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"><a href="../FileMaker/FM_Result.html">FileMaker_Result</a></span>
|
|
<a href="#execute" title="details" class="method-name">&execute</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setPreCommandScript" title="details" class="method-name">setPreCommandScript</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setPreSortScript" title="details" class="method-name">setPreSortScript</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setRecordClass" title="details" class="method-name">setRecordClass</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$className</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setRecordId" title="details" class="method-name">setRecordId</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setResultLayout" title="details" class="method-name">setResultLayout</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setScript" title="details" class="method-name">setScript</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean|<a href="../FileMaker/FME_Validation.html">FileMaker_Error_Validation</a></span>
|
|
<a href="#validate" title="details" class="method-name">validate</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$fieldName</span> = <span class="var-default">null</span>])
|
|
</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="methodexecute" id="execute"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">execute</span> (line <span class="line-number">135</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Executes the command.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Result object.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result"><a href="../FileMaker/FM_Result.html">FileMaker_Result</a></span>
|
|
<span class="method-name">
|
|
&execute
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodsetPreCommandScript" id="setPreCommandScript"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPreCommandScript</span> (line <span class="line-number">69</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets a ScriptMaker script to be run before performing a command.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setPreCommandScript
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptName</span><span class="var-description">: Name of the ScriptMaker script to run.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptParameters</span><span class="var-description">: Any parameters to pass to the script.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetPreSortScript" id="setPreSortScript"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPreSortScript</span> (line <span class="line-number">81</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets a ScriptMaker script to be run after performing a Find command, but before sorting the result set.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setPreSortScript
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptName</span><span class="var-description">: Name of the ScriptMaker script to run.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptParameters</span><span class="var-description">: Any parameters to pass to the script.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetRecordClass" id="setRecordClass"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setRecordClass</span> (line <span class="line-number">98</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets the PHP class that the API instantiates to represent records returned in any result set.</p>
|
|
<p class="description"><p>The default is to use the provided FileMaker_Record class. Any substitute classes must provide the same API that FileMaker_Record does, either by extending it or re-implementing the necessary methods. The user is responsible for defining any custom class before the API needs to instantiate it.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setRecordClass
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$className</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$className</span><span class="var-description">: Name of the class to represent records.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetRecordId" id="setRecordId"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setRecordId</span> (line <span class="line-number">149</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets the record ID for this command.</p>
|
|
<p class="description"><p>For Edit, Delete, and Duplicate commands, a record ID must be specified. It is also possible to find a single record by specifying its record ID. This method is ignored by Add and FindAny commands.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setRecordId
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$recordId</span><span class="var-description">: ID of record this command acts upon.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetResultLayout" id="setResultLayout"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setResultLayout</span> (line <span class="line-number">46</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Requests that the command's result be returned in a layout different from the current layout.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setResultLayout
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$layout</span><span class="var-description">: Layout to return results in.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetScript" id="setScript"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setScript</span> (line <span class="line-number">58</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets a ScriptMaker script to be run after the Find result set is generated and sorted.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setScript
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$scriptName</span>, [<span class="var-type">string</span> <span class="var-name">$scriptParameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptName</span><span class="var-description">: Name of the ScriptMaker script to run.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$scriptParameters</span><span class="var-description">: Any parameters to pass to the script.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodvalidate" id="validate"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">validate</span> (line <span class="line-number">125</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Pre-validates either a single field or the entire command.</p>
|
|
<p class="description"><p>This method uses the pre-validation rules that are enforceable by the PHP engine -- for example, type rules, ranges, and four-digit dates. Rules such as "unique" or "existing," or validation by calculation field, cannot be pre-validated.</p><p>If you pass the optional $fieldName argument, only that field is pre-validated. Otherwise, the command is pre-validated as if execute() were called with "Enable record data pre-validation" selected in FileMaker Server Admin Console. If pre-validation passes, validate() returns TRUE. If pre-validation fails, then validate() returns a FileMaker_Error_Validation object containing details about what failed to pre-validate.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> TRUE, if pre-validation passes. Otherwise, an Error Validation object.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean|<a href="../FileMaker/FME_Validation.html">FileMaker_Error_Validation</a></span>
|
|
<span class="method-name">
|
|
validate
|
|
</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 field to pre-validate. If empty, pre-validates the entire command.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Mon, 28 Jul 2008 14:47:44 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |