start copy from cimac web
This commit is contained in:
@@ -0,0 +1,930 @@
|
||||
<?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</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</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">Base FileMaker class. Defines database properties, connects to a database, and gets information about the API.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM.php.html">/FileMaker.php</a> (line <span class="field">87</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">
|
||||
static <span class="method-result">string</span>
|
||||
<a href="#getAPIVersion" title="details" class="method-name">getAPIVersion</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
static <span class="method-result">string</span>
|
||||
<a href="#getMinServerVersion" title="details" class="method-name">getMinServerVersion</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
static <span class="method-result">boolean</span>
|
||||
<a href="#isError" title="details" class="method-name">isError</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">FileMaker</span>
|
||||
<a href="#FileMaker" title="details" class="method-name">FileMaker</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$hostspec</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">NULL</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#createRecord" title="details" class="method-name">&createRecord</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$fieldValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getContainerData" title="details" class="method-name">getContainerData</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getProperties" title="details" class="method-name">getProperties</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getProperty" title="details" class="method-name">getProperty</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#getRecordById" title="details" class="method-name">&getRecordById</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#listDatabases" title="details" class="method-name">listDatabases</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#listLayouts" title="details" class="method-name">listLayouts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#listScripts" title="details" class="method-name">listScripts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Add.html">FileMaker_Command_Add</a></span>
|
||||
<a href="#newAddCommand" title="details" class="method-name">&newAddCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_CompoundFind.html">FileMaker_Command_CompoundFind</a></span>
|
||||
<a href="#newCompoundFindCommand" title="details" class="method-name">&newCompoundFindCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Delete.html">FileMaker_Command_Delete</a></span>
|
||||
<a href="#newDeleteCommand" title="details" class="method-name">&newDeleteCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Duplicate.html">FileMaker_Command_Duplicate</a></span>
|
||||
<a href="#newDuplicateCommand" title="details" class="method-name">&newDuplicateCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Edit.html">FileMaker_Command_Edit</a></span>
|
||||
<a href="#newEditCommand" title="details" class="method-name">&newEditCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>, [<span class="var-type">array</span> <span class="var-name">$updatedValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindAll.html">FileMaker_Command_FindAll</a></span>
|
||||
<a href="#newFindAllCommand" title="details" class="method-name">&newFindAllCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindAny.html">FileMaker_Command_FindAny</a></span>
|
||||
<a href="#newFindAnyCommand" title="details" class="method-name">&newFindAnyCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a></span>
|
||||
<a href="#newFindCommand" title="details" class="method-name">&newFindCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindRequest.html">FileMaker_Command_FindRequest</a></span>
|
||||
<a href="#newFindRequest" title="details" class="method-name">&newFindRequest</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_PerformScript.html">FileMaker_Command_PerformScript</a></span>
|
||||
<a href="#newPerformScriptCommand" title="details" class="method-name">&newPerformScriptCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setLogger" title="details" class="method-name">setLogger</a>
|
||||
(<span class="var-type">Log</span> <span class="var-name">&$logger</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setProperty" title="details" class="method-name">setProperty</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>, <span class="var-type">string</span> <span class="var-name">$value</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodgetAPIVersion" id="getAPIVersion"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method getAPIVersion</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the version of the FileMaker API for PHP.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> API version.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getAPIVersion
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetMinServerVersion" id="getMinServerVersion"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method getMinServerVersion</span> (line <span class="line-number">127</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the minimum version of FileMaker Server that this API works with.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Minimum FileMaker Server version.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getMinServerVersion
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisError" id="isError"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method isError</span> (line <span class="line-number">105</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Tests whether a variable is a FileMaker API Error.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> TRUE, if the variable is a <a href="../FileMaker/FME.html">FileMaker_Error</a> object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isError
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$variable</span><span class="var-description">: Variable to test.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<a name="methodFileMaker" id="FileMaker"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker</span> (line <span class="line-number">150</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker object constructor.</p>
|
||||
<p class="description"><p>If you want to use the constructor without specifying all the parameters, pass in NULL for the parameters you want to omit. For example, to specify only the database name, username, and password, but omit the hostspec, call the constructor as follows:</p><p><samp>new FileMaker('DatabaseName', NULL, 'username', 'password');</samp></p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker</span>
|
||||
<span class="method-name">
|
||||
FileMaker
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$hostspec</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">NULL</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$database</span><span class="var-description">: Name of the database to connect to.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$hostspec</span><span class="var-description">: Hostspec of web server in FileMaker Server deployment. Defaults to http://localhost, if set to NULL.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: Account name to log into database.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$password</span><span class="var-description">: Password for account.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodcreateRecord" id="createRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">createRecord</span> (line <span class="line-number">357</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Record object.</p>
|
||||
<p class="description"><p>This method does not save the new record to the database. The record is not created on the Database Server until you call this record's commit() method. You must specify a layout name, and you can optionally specify an array of field values. Individual field values can also be set in the new record object.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Record object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&createRecord
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$fieldValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout to create a new record for.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$fieldValues</span><span class="var-description">: Initial values for the new record's fields.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetContainerData" id="getContainerData"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getContainerData</span> (line <span class="line-number">447</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the data for the specified container field.</p>
|
||||
<p class="description"><p>Pass in a URL string that represents the file path for the container field contents. For example, get the image data from a container field named 'Cover Image'. For a FileMaker_Record object named $record, URL-encode the path returned by the getField() method. For example:</p><p><samp><IMG src="img.php?-url=<?php echo urlencode($record->getField('Cover Image')); ?>"></samp></p><p>Then as shown below in a line from img.php, pass the URL into getContainerData() for the FileMaker object named $fm:</p><p><samp>echo $fm->getContainerData($_GET['-url']);</samp></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Raw field data.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getContainerData
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$url</span><span class="var-description">: URL of the container field contents to get.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">384</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a Layout object that describes the specified layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout or Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</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">: Name of the layout to describe.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetProperties" id="getProperties"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getProperties</span> (line <span class="line-number">186</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array of property name => property value for all current properties and their current values.</p>
|
||||
<p class="description"><p>This array enables PHP object introspection and debugging when necessary.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> All current properties.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getProperties
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetProperty" id="getProperty"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getProperty</span> (line <span class="line-number">173</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current value of a property.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Property's current value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getProperty
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$prop</span><span class="var-description">: Name of the property.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecordById" id="getRecordById"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecordById</span> (line <span class="line-number">372</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a single FileMaker_Record object matching the given layout and record ID, or a FileMaker_Error object, if this operation fails.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record or Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getRecordById
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout that $recordId is in.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to get.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistDatabases" id="listDatabases"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listDatabases</span> (line <span class="line-number">396</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of databases that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of database names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listDatabases
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistLayouts" id="listLayouts"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listLayouts</span> (line <span class="line-number">420</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of layouts from the current database that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of layout names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listLayouts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistScripts" id="listScripts"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listScripts</span> (line <span class="line-number">408</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of ScriptMaker scripts from the current database that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of script names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listScripts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewAddCommand" id="newAddCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newAddCommand</span> (line <span class="line-number">213</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Add object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Add command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Add.html">FileMaker_Command_Add</a></span>
|
||||
<span class="method-name">
|
||||
&newAddCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout to add a record to.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$values</span><span class="var-description">: Associative array of field name => value pairs. To set field repetitions, use a numerically indexed array for the value of a field, with the numeric keys corresponding to the repetition number to set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewCompoundFindCommand" id="newCompoundFindCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newCompoundFindCommand</span> (line <span class="line-number">283</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_CompoundFind object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Compound Find Set command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_CompoundFind.html">FileMaker_Command_CompoundFind</a></span>
|
||||
<span class="method-name">
|
||||
&newCompoundFindCommand
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewDeleteCommand" id="newDeleteCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newDeleteCommand</span> (line <span class="line-number">244</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Delete object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Delete command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Delete.html">FileMaker_Command_Delete</a></span>
|
||||
<span class="method-name">
|
||||
&newDeleteCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout to delete record from.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to delete.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewDuplicateCommand" id="newDuplicateCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newDuplicateCommand</span> (line <span class="line-number">257</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Duplicate object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Duplicate command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Duplicate.html">FileMaker_Command_Duplicate</a></span>
|
||||
<span class="method-name">
|
||||
&newDuplicateCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout that the record to duplicate is in.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to duplicate.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewEditCommand" id="newEditCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newEditCommand</span> (line <span class="line-number">231</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Edit object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Edit command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Edit.html">FileMaker_Command_Edit</a></span>
|
||||
<span class="method-name">
|
||||
&newEditCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>, [<span class="var-type">array</span> <span class="var-name">$updatedValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout that the record is part of.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to edit.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$updatedValues</span><span class="var-description">: Associative array of field name => value pairs that contain the updated field values. To set field repetitions, use a numerically indexed array for the value of a field, with the numeric keys corresponding to the repetition number to set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindAllCommand" id="newFindAllCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindAllCommand</span> (line <span class="line-number">322</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindAll object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find All command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindAll.html">FileMaker_Command_FindAll</a></span>
|
||||
<span class="method-name">
|
||||
&newFindAllCommand
|
||||
</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 find all records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindAnyCommand" id="newFindAnyCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindAnyCommand</span> (line <span class="line-number">310</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindAny object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find Any command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindAny.html">FileMaker_Command_FindAny</a></span>
|
||||
<span class="method-name">
|
||||
&newFindAnyCommand
|
||||
</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 find one random record from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindCommand" id="newFindCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindCommand</span> (line <span class="line-number">269</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Find object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a></span>
|
||||
<span class="method-name">
|
||||
&newFindCommand
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindRequest" id="newFindRequest"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindRequest</span> (line <span class="line-number">298</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindRequest object. Add one or more Find Request objects to a <a href="../FileMaker/FMC_CompoundFind.html">FileMaker_Command_CompoundFind</a> object, then execute the Compound Find command.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find Request command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_FindRequest.html">FileMaker_Command_FindRequest</a></span>
|
||||
<span class="method-name">
|
||||
&newFindRequest
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewPerformScriptCommand" id="newPerformScriptCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newPerformScriptCommand</span> (line <span class="line-number">337</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_PerformScript object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Perform Script command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FMC_PerformScript.html">FileMaker_Command_PerformScript</a></span>
|
||||
<span class="method-name">
|
||||
&newPerformScriptCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout to use for script context.</span> </li>
|
||||
<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="methodsetLogger" id="setLogger"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setLogger</span> (line <span class="line-number">197</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Associates a PEAR Log object with the API for logging requests and responses.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setLogger
|
||||
</span>
|
||||
(<span class="var-type">Log</span> <span class="var-name">&$logger</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">Log</span>
|
||||
<span class="var-name">&$logger</span><span class="var-description">: PEAR Log object.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetProperty" id="setProperty"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setProperty</span> (line <span class="line-number">161</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a property to a new value for all API calls.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setProperty
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$prop</span><span class="var-description">: Name of the property to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Property's new value.</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>
|
||||
@@ -0,0 +1,513 @@
|
||||
<?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 page FileMaker.php</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="file-name">/FileMaker.php</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-classes">Classes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-constants">Constants</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM.html">FileMaker</a>
|
||||
</td>
|
||||
<td>
|
||||
Base FileMaker class. Defines database properties, connects to a database, and gets information about the API.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineFILEMAKER_FIND_AND"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_AND</span> = 'and'
|
||||
(line <span class="line-number">47</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find logical operator constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FMC_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a> method.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_CHAR"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_CHAR</span> = '@'
|
||||
(line <span class="line-number">34</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_CHAR_WILDCARD"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_CHAR_WILDCARD</span> = '*'
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_DIGIT"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_DIGIT</span> = '#'
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_DUPLICATES"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_DUPLICATES</span> = '!'
|
||||
(line <span class="line-number">31</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_FIELDMATCH"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_FIELDMATCH</span> = '=='
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_GT"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_GT</span> = '>'
|
||||
(line <span class="line-number">28</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_GTE"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_GTE</span> = '>='
|
||||
(line <span class="line-number">29</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_INVALID_DATETIME"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_INVALID_DATETIME</span> = '?'
|
||||
(line <span class="line-number">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LITERAL"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LITERAL</span> = '""'
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LT"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LT</span> = '<'
|
||||
(line <span class="line-number">26</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LTE"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LTE</span> = '<='
|
||||
(line <span class="line-number">27</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_OR"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_OR</span> = 'or'
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find logical operator constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FMC_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a> method.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_RANGE"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_RANGE</span> = '...'
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_RELAXED"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_RELAXED</span> = '~'
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_TODAY"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_TODAY</span> = '//'
|
||||
(line <span class="line-number">32</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_DEBUG"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_DEBUG</span> = 7
|
||||
(line <span class="line-number">78</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_ERR"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_ERR</span> = 3
|
||||
(line <span class="line-number">76</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_INFO"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_INFO</span> = 6
|
||||
(line <span class="line-number">77</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_DATE_FIELD"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_DATE_FIELD</span> = 7
|
||||
(line <span class="line-number">60</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_FOURDIGITYEAR"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_FOURDIGITYEAR</span> = 4
|
||||
(line <span class="line-number">57</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_MAXCHARACTERS"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_MAXCHARACTERS</span> = 3
|
||||
(line <span class="line-number">56</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_NOTEMPTY"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_NOTEMPTY</span> = 1
|
||||
(line <span class="line-number">54</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_NUMERICONLY"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_NUMERICONLY</span> = 2
|
||||
(line <span class="line-number">55</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIMEOFDAY"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIMEOFDAY</span> = 5
|
||||
(line <span class="line-number">58</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIMESTAMP_FIELD"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIMESTAMP_FIELD</span> = 6
|
||||
(line <span class="line-number">59</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIME_FIELD"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIME_FIELD</span> = 8
|
||||
(line <span class="line-number">61</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_SORT_ASCEND"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_SORT_ASCEND</span> = 'ascend'
|
||||
(line <span class="line-number">69</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sort direction constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FMC_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a> and <a href="../FileMaker/FMC_CompoundFind.html#methodaddSortRule">FileMaker_Command_CompoundFind::addSortRule()</a> methods.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_SORT_DESCEND"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_SORT_DESCEND</span> = 'descend'
|
||||
(line <span class="line-number">70</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sort direction constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FMC_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a> and <a href="../FileMaker/FMC_CompoundFind.html#methodaddSortRule">FileMaker_Command_CompoundFind::addSortRule()</a> methods.</p></p>
|
||||
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,397 @@
|
||||
<?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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Command.php</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="file-name">/FileMaker/Command.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
</td>
|
||||
<td>
|
||||
Base Command class. Represents commands that add records, delete records, duplicate records, edit records, perform find requests, and perform ScriptMaker scripts.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,36 @@
|
||||
<?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 page filemaker-api.php</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="file-name">/FileMaker/conf/filemaker-api.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP configuration file.</p>
|
||||
<p class="description"><p>All settings are in the $__FM_CONFIG array to maintain a clean global namespace.</p></p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,165 @@
|
||||
<?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_Add</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_Add</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">Command class that adds a new record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewAddCommand">FileMaker::newAddCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_Add.php.html">/FileMaker/Command/Add.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Add</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="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">62</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value to set for this field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set, Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">83</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then this method returns an Error object. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Add.php</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="file-name">/FileMaker/Command/Add.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Add.html">FileMaker_Command_Add</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that adds a new record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,314 @@
|
||||
<?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_CompoundFind</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_CompoundFind</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">Command class that performs multiple find requests, also known as a compound find set.</p>
|
||||
<p class="description"><p>Requests are executed in the order specified in the add() method. The found set includes the results of the entire compound find request. Create this command with <a href="../FileMaker/FM.html#methodnewCompoundFindCommand">FileMaker::newCompoundFindCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_CompoundFind.php.html">/FileMaker/Command/CompoundFind.php</a> (line <span class="field">32</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_CompoundFind</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="#add" title="details" class="method-name">add</a>
|
||||
(<span class="var-type">int</span> <span class="var-name">$precedence</span>, <span class="var-type">findrequest</span> <span class="var-name">$findrequest</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#addSortRule" title="details" class="method-name">addSortRule</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearSortRules" title="details" class="method-name">clearSortRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRange" title="details" class="method-name">getRange</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSetsFilters" title="details" class="method-name">getRelatedSetsFilters</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRange" title="details" class="method-name">setRange</a>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRelatedSetsFilters" title="details" class="method-name">setRelatedSetsFilters</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodadd" id="add"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">add</span> (line <span class="line-number">63</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a Find Request object to this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
add
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$precedence</span>, <span class="var-type">findrequest</span> <span class="var-name">$findrequest</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Priority in which the find requests are added to this compound find set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">findrequest</span>
|
||||
<span class="var-name">$findrequest</span><span class="var-description">: FileMaker_FindRequest object to add to this compound find set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodaddSortRule" id="addSortRule"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addSortRule</span> (line <span class="line-number">81</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a sorting rule to this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addSortRule
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</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 sort by.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Integer from 1 to 9, inclusive. A value of 1 sorts records based on this sorting rule first, a value of 2 sorts records based on this sorting rule only when two or more records have the same value after the first sorting rule is applied, and so on.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$order</span><span class="var-description">: Direction of the sort. Specify the FILEMAKER_SORT_ASCEND constant, the FILEMAKER_SORT_DESCEND constant, or the name of a value list specified as a string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearSortRules" id="clearSortRules"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearSortRules</span> (line <span class="line-number">89</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing sorting rules from this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearSortRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRange" id="getRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRange</span> (line <span class="line-number">114</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current range settings.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'skip' for the current skip setting, and 'max' for the current maximum number of records. If either key does not have a value, the returned value for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRange
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSetsFilters" id="getRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSetsFilters</span> (line <span class="line-number">145</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current settings for the related records filter and the maximum number of related records to return.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'relatedsetsfilter' for the portal filter setting, and 'relatedsetsmax' for the maximum number of records. If either key does not have a value, the returned for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSetsFilters
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRange" id="setRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRange</span> (line <span class="line-number">101</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a range to request only part of the result set.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRange
|
||||
</span>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$skip</span><span class="var-description">: Number of records to skip past. Default is 0.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$max</span><span class="var-description">: Maximum number of records to return. Default is all.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRelatedSetsFilters" id="setRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRelatedSetsFilters</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a filter to restrict the number of related records to return from a portal.</p>
|
||||
<p class="description"><p>For more information, see the description for the <a href="../FileMaker/FMC_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a> method.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRelatedSetsFilters
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsfilter</span><span class="var-description">: Specify either 'layout' or 'none' to control filtering.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsmax</span><span class="var-description">: Maximum number of portal records to return.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page CompoundFind.php</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="file-name">/FileMaker/Command/CompoundFind.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<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>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_Delete</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_Delete</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that deletes a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewDeleteCommand">FileMaker::newDeleteCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_Delete.php.html">/FileMaker/Command/Delete.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Delete</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Delete.php</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="file-name">/FileMaker/Command/Delete.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Delete.html">FileMaker_Command_Delete</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that deletes a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_Duplicate</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_Duplicate</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that duplicates a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewDuplicateCommand">FileMaker::newDuplicateCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_Duplicate.php.html">/FileMaker/Command/Duplicate.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Duplicate</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Duplicate.php</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="file-name">/FileMaker/Command/Duplicate.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Duplicate.html">FileMaker_Command_Duplicate</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that duplicates a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,197 @@
|
||||
<?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_Edit</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_Edit</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">Command class that edits a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewEditCommand">FileMaker::newEditCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_Edit.php.html">/FileMaker/Command/Edit.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Edit</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="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setModificationId" title="details" class="method-name">setModificationId</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$modificationId</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">65</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value for the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set, Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">86</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then this method returns an Error object. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetModificationId" id="setModificationId"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setModificationId</span> (line <span class="line-number">104</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the modification ID for this command.</p>
|
||||
<p class="description"><p>Before you edit a record, you can use the <a href="../FileMaker/FM_Record.html#methodgetModificationId">FileMaker_Record::getModificationId()</a> method to get the record's modification ID. By specifying a modification ID when you execute an Edit command, you can make sure that you are editing the current version of a record. If the modification ID value you specify does not match the current modification ID value in the database, the Edit command is not allowed and an error code is returned.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setModificationId
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$modificationId</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$modificationId</span><span class="var-description">: Modification ID.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Edit.php</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="file-name">/FileMaker/Command/Edit.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Edit.html">FileMaker_Command_Edit</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that edits a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,414 @@
|
||||
<?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_Find</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_Find</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">Command class that finds records using the specified criteria.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewFindCommand">FileMaker::newFindCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_Find.php.html">/FileMaker/Command/Find.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Find</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_FindAll.html">FileMaker_Command_FindAll</a></td>
|
||||
<td>
|
||||
Command class that finds all records from a layout.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../FileMaker/FMC_FindAny.html">FileMaker_Command_FindAny</a></td>
|
||||
<td>
|
||||
Command class that finds one random record.
|
||||
</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">void</span>
|
||||
<a href="#addFindCriterion" title="details" class="method-name">addFindCriterion</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#addSortRule" title="details" class="method-name">addSortRule</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearFindCriteria" title="details" class="method-name">clearFindCriteria</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearSortRules" title="details" class="method-name">clearSortRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRange" title="details" class="method-name">getRange</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSetsFilters" title="details" class="method-name">getRelatedSetsFilters</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setLogicalOperator" title="details" class="method-name">setLogicalOperator</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$operator</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRange" title="details" class="method-name">setRange</a>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRelatedSetsFilters" title="details" class="method-name">setRelatedSetsFilters</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</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="methodaddFindCriterion" id="addFindCriterion"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addFindCriterion</span> (line <span class="line-number">58</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a criterion to this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addFindCriterion
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</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 being tested.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$testvalue</span><span class="var-description">: Value of field to test against.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodaddSortRule" id="addSortRule"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addSortRule</span> (line <span class="line-number">84</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a sorting rule to this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addSortRule
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</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 sort by.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Integer from 1 to 9, inclusive. A value of 1 sorts records based on this sorting rule first, a value of 2 sorts records based on this sorting rule only when two or more records have the same value after the first sorting rule is applied, and so on.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$order</span><span class="var-description">: Direction of the sort. Specify the FILEMAKER_SORT_ASCEND constant, the FILEMAKER_SORT_DESCEND constant, or the name of a value list specified as a string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearFindCriteria" id="clearFindCriteria"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearFindCriteria</span> (line <span class="line-number">66</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing criteria from this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearFindCriteria
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearSortRules" id="clearSortRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearSortRules</span> (line <span class="line-number">92</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing sorting rules from this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearSortRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRange" id="getRange"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRange</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current range settings.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'skip' for the current skip setting, and 'max' for the current maximum number of records. If either key does not have a value, the returned value for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRange
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSetsFilters" id="getRelatedSetsFilters"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSetsFilters</span> (line <span class="line-number">177</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current settings for the related records filter and the maximum number of related records to return.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'relatedsetsfilter' for the portal filter setting, and 'relatedsetsmax' for the maximum number of records. If either key does not have a value, the returned for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSetsFilters
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetLogicalOperator" id="setLogicalOperator"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setLogicalOperator</span> (line <span class="line-number">106</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Specifies how the find criteria in this Find command are combined as either a logical AND or OR search.</p>
|
||||
<p class="description"><p>If not specified, the default is a logical AND.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setLogicalOperator
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$operator</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$operator</span><span class="var-description">: Specify the FILEMAKER_FIND_AND or FILEMAKER_FIND_OR constant.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRange" id="setRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRange</span> (line <span class="line-number">118</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a range to request only part of the result set.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRange
|
||||
</span>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$skip</span><span class="var-description">: Number of records to skip past. Default is 0.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$max</span><span class="var-description">: Maximum number of records to return. Default is all.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRelatedSetsFilters" id="setRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRelatedSetsFilters</span> (line <span class="line-number">163</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a filter to restrict the number of related records to return from a portal.</p>
|
||||
<p class="description"><p>The filter limits the number of related records returned by respecting the settings specified in the FileMaker Pro Portal Setup dialog box.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRelatedSetsFilters
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsfilter</span><span class="var-description">: Specify one of these values to control filtering: <ul><li>'layout': Apply the settings specified in the FileMaker Pro
|
||||
Portal Setup dialog box. The records are sorted based
|
||||
on the sort defined in the Portal Setup dialog box,
|
||||
with the record set filtered to start with the
|
||||
specified "Initial row."</li><li>'none': Return all related records in the portal without
|
||||
filtering or presorting them.</li></ul></span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsmax</span><span class="var-description">: If the "Show vertical scroll bar" setting is enabled in the Portal Setup dialog box, specify one of these values: <ul><li>an integer value: Return this maximum number of related records
|
||||
after the initial record.</li><li>'all': Return all of the related records in the portal.
|
||||
If "Show vertical scroll bar" is disabled, the Portal
|
||||
Setup dialog box's "Number of rows" setting determines
|
||||
the maximum number of related records to return.</li></ul></span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Find.php</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="file-name">/FileMaker/Command/Find.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds records using the specified criteria.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,92 @@
|
||||
<?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_FindAll</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_FindAll</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that finds all records from a layout.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewFindAllCommand">FileMaker::newFindAllCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_FindAll.php.html">/FileMaker/Command/FindAll.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--<a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a>
|
||||
|
|
||||
--FileMaker_Command_FindAll</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodaddFindCriterion">FileMaker_Command_Find::addFindCriterion()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodclearFindCriteria">FileMaker_Command_Find::clearFindCriteria()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodclearSortRules">FileMaker_Command_Find::clearSortRules()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodgetRange">FileMaker_Command_Find::getRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodgetRelatedSetsFilters">FileMaker_Command_Find::getRelatedSetsFilters()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetRange">FileMaker_Command_Find::setRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a></span><br>
|
||||
</blockquote>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindAll.php</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="file-name">/FileMaker/Command/FindAll.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindAll.html">FileMaker_Command_FindAll</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds all records from a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,92 @@
|
||||
<?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_FindAny</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_FindAny</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that finds one random record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewFindAnyCommand">FileMaker::newFindAnyCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_FindAny.php.html">/FileMaker/Command/FindAny.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--<a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a>
|
||||
|
|
||||
--FileMaker_Command_FindAny</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodaddFindCriterion">FileMaker_Command_Find::addFindCriterion()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodclearFindCriteria">FileMaker_Command_Find::clearFindCriteria()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodclearSortRules">FileMaker_Command_Find::clearSortRules()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodgetRange">FileMaker_Command_Find::getRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodgetRelatedSetsFilters">FileMaker_Command_Find::getRelatedSetsFilters()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetRange">FileMaker_Command_Find::setRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a></span><br>
|
||||
</blockquote>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindAny.php</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="file-name">/FileMaker/Command/FindAny.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindAny.html">FileMaker_Command_FindAny</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds one random record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,166 @@
|
||||
<?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_FindRequest</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_FindRequest</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">Find Request class. Contains all the information about a single find request for a Compound Find command.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewFindRequest">FileMaker::newFindRequest()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_FindRequest.php.html">/FileMaker/Command/FindRequest.php</a> (line <span class="field">30</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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="#addFindCriterion" title="details" class="method-name">addFindCriterion</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearFindCriteria" title="details" class="method-name">clearFindCriteria</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setOmit" title="details" class="method-name">setOmit</a>
|
||||
(<span class="var-type">boolean</span> <span class="var-name">$value</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodaddFindCriterion" id="addFindCriterion"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addFindCriterion</span> (line <span class="line-number">71</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a criterion to this find request.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addFindCriterion
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</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 being tested.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$testvalue</span><span class="var-description">: Value of the field to test against.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearFindCriteria" id="clearFindCriteria"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearFindCriteria</span> (line <span class="line-number">79</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing criteria from this find request.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearFindCriteria
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetOmit" id="setOmit"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setOmit</span> (line <span class="line-number">60</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets whether this request is an omit request.</p>
|
||||
<p class="description"><p>An omit request removes the matching records from the final result set.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setOmit
|
||||
</span>
|
||||
(<span class="var-type">boolean</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: TRUE if this is an omit request. Otherwise, FALSE.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindRequest.php</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="file-name">/FileMaker/Command/FindRequest.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindRequest.html">FileMaker_Command_FindRequest</a>
|
||||
</td>
|
||||
<td>
|
||||
Find Request class. Contains all the information about a single find request for a Compound Find command.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_PerformScript</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_PerformScript</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that performs a ScriptMaker script.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FM.html#methodnewPerformScriptCommand">FileMaker::newPerformScriptCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FMC_PerformScript.php.html">/FileMaker/Command/PerformScript.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FMC.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_PerformScript</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FMC.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FMC.html#methodvalidate">FileMaker_Command::validate()</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page PerformScript.php</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="file-name">/FileMaker/Command/PerformScript.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_PerformScript.html">FileMaker_Command_PerformScript</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that performs a ScriptMaker script.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,235 @@
|
||||
<?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="FME.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/FME_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/FME_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 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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Error.php</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="file-name">/FileMaker/Error.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FME.html">FileMaker_Error</a>
|
||||
</td>
|
||||
<td>
|
||||
Extension of the PEAR_Error class for use in all FileMaker classes.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,224 @@
|
||||
<?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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Validation.php</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="file-name">/FileMaker/Error/Validation.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FME_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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page de.php</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="file-name">/FileMaker/Error/de.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - German translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page en.php</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="file-name">/FileMaker/Error/en.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - English translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page fr.php</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="file-name">/FileMaker/Error/fr.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - French translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page it.php</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="file-name">/FileMaker/Error/it.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Italian translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page ja.php</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="file-name">/FileMaker/Error/ja.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Japanese translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page sv.php</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="file-name">/FileMaker/Error/sv.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Swedish translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,621 @@
|
||||
<?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_Field</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_Field</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">Field description class. Contains all the information about a specific field on a layout.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM_Field.php.html">/FileMaker/Field.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Field</span>
|
||||
<a href="#FileMaker_Field" title="details" class="method-name">FileMaker_Field</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeLocalValidationRules" title="details" class="method-name">describeLocalValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeValidationRule" title="details" class="method-name">describeValidationRule</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeValidationRules" title="details" class="method-name">describeValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getLocalValidationRules" title="details" class="method-name">getLocalValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getRepetitionCount" title="details" class="method-name">getRepetitionCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getResult" title="details" class="method-name">getResult</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getStyleType" title="details" class="method-name">getStyleType</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getType" title="details" class="method-name">getType</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getValidationMask" title="details" class="method-name">getValidationMask</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValidationRules" title="details" class="method-name">getValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueList" title="details" class="method-name">getValueList</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#hasValidationRule" title="details" class="method-name">hasValidationRule</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#isAutoEntered" title="details" class="method-name">isAutoEntered</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#isGlobal" title="details" class="method-name">isGlobal</a>
|
||||
()
|
||||
</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">mixed</span> <span class="var-name">$value</span>, [<span class="var-type"><a href="../FileMaker/FME_Validation.html">FileMaker_Error_Validation</a></span> <span class="var-name">$error</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodFileMaker_Field" id="FileMaker_Field"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Field</span> (line <span class="line-number">44</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Field object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Field</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Field
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: Parent Layout object.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeLocalValidationRules" id="describeLocalValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeLocalValidationRules</span> (line <span class="line-number">201</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return an array of arrays containing the extra information for all pre-validation rules on this field that can be evaluated by the PHP engine.</p>
|
||||
<p class="description"><p>Rules such as "unique" and "exists" can be validated only on the Database Server and are not included in this list. Indexes of the outer array are FILEMAKER_RULE_* constants, and values are the same array returned by describeValidationRule().</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An associative array of all extra pre-validation information, with rule constants as indexes and extra information as the values.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeLocalValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeValidationRule" id="describeValidationRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeValidationRule</span> (line <span class="line-number">182</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any additional information for the specified pre-validation rule.</p>
|
||||
<p class="description"><p>Used for range rules and other rules that have additional pre-validation parameters.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Any extra information for $validationRule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeValidationRule
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$validationRule</span><span class="var-description">: FILEMAKER_RULE_* constant to get information for.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeValidationRules" id="describeValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeValidationRules</span> (line <span class="line-number">213</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any additional information for all pre-validation rules.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An associative array of all extra pre-validation information, with FILEMAKER_RULE_* constants as keys and extra information as the values.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">64</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the FileMaker_Layout object that contains this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLocalValidationRules" id="getLocalValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLocalValidationRules</span> (line <span class="line-number">130</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of FILEMAKER_RULE_* constants for each rule set on this field that can be evaluated by the PHP engine.</p>
|
||||
<p class="description"><p>Rules such as "unique" and "exists" can only be pre-validated on the Database Server and are not included in this list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Local rule array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getLocalValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">54</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRepetitionCount" id="getRepetitionCount"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRepetitionCount</span> (line <span class="line-number">95</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the maximum number of repetitions for this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Maximum repetitions of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getRepetitionCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetResult" id="getResult"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getResult</span> (line <span class="line-number">224</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the result type of this field -- for example, 'text', 'number', 'date', 'time', 'timestamp', or 'container'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Result type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getResult
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetStyleType" id="getStyleType"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getStyleType</span> (line <span class="line-number">263</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the control style type of this field -- for example, 'EDITTEXT', 'POPUPLIST', 'POPUPMENU', 'CHECKBOX', 'RADIOBUTTONS' or 'CALENDAR'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Style type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getStyleType
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetType" id="getType"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getType</span> (line <span class="line-number">235</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the type of this field -- for example, 'normal', 'calculation', or 'summary'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getType
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValidationMask" id="getValidationMask"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValidationMask</span> (line <span class="line-number">152</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the full additive bitmask of pre-validation rules for this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Rule bitmask.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getValidationMask
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValidationRules" id="getValidationRules"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValidationRules</span> (line <span class="line-number">141</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of FILEMAKER_RULE_* constants for each rule set on this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Rule array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueList" id="getValueList"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueList</span> (line <span class="line-number">251</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of choices from the value list associated with this field.</p>
|
||||
<p class="description"><p>If this field is not associated with a value list, this method returns NULL.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Value list array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueList
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which to display the value list.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodhasValidationRule" id="hasValidationRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">hasValidationRule</span> (line <span class="line-number">165</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if the specified FILEMAKER_RULE_* constant matches the field's pre-validation bitmask. Otherwise, returns FALSE.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
hasValidationRule
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$validationRule</span><span class="var-description">: Pre-validation rule constant to test.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisAutoEntered" id="isAutoEntered"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">isAutoEntered</span> (line <span class="line-number">75</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if data in this field is auto-entered or FALSE if it is entered manually.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Auto-entered status of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isAutoEntered
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisGlobal" id="isGlobal"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">isGlobal</span> (line <span class="line-number">85</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if this field is global or FALSE if it is not.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Global status of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isGlobal
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if $value is valid for this field, or a FileMaker_Error_Validation object describing how pre-validation failed.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Result of field pre-validation on $value.</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">mixed</span> <span class="var-name">$value</span>, [<span class="var-type"><a href="../FileMaker/FME_Validation.html">FileMaker_Error_Validation</a></span> <span class="var-name">$error</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value to pre-validate.</span> </li>
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FME_Validation.html">FileMaker_Error_Validation</a></span>
|
||||
<span class="var-name">$error</span><span class="var-description">: If pre-validation is being done on more than one field, you may pass validate() an existing error object to add pre-validation failures to.$error is not passed by reference, though, so you must catch the return value of validate() and use it as the new $error object. This method never overwrites an existing $error object with boolean TRUE.</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Field.php</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="file-name">/FileMaker/Field.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM_Field.html">FileMaker_Field</a>
|
||||
</td>
|
||||
<td>
|
||||
Field description class. Contains all the information about a specific field on a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,524 @@
|
||||
<?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_Layout</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_Layout</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">Layout description class. Contains all the information about a specific layout. Can be requested directly or returned as part of a result set.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM_Layout.php.html">/FileMaker/Layout.php</a> (line <span class="field">30</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Layout</span>
|
||||
<a href="#FileMaker_Layout" title="details" class="method-name">FileMaker_Layout</a>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getDatabase" title="details" class="method-name">getDatabase</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#getField" title="details" class="method-name">&getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">&getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#getRelatedSet" title="details" class="method-name">&getRelatedSet</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSets" title="details" class="method-name">&getRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueList" title="details" class="method-name">getValueList</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueLists" title="details" class="method-name">getValueLists</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueListsTwoFields" title="details" class="method-name">getValueListsTwoFields</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueListTwoFields" title="details" class="method-name">getValueListTwoFields</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listFields" title="details" class="method-name">listFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listRelatedSets" title="details" class="method-name">listRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listValueLists" title="details" class="method-name">listValueLists</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="methodFileMaker_Layout" id="FileMaker_Layout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Layout</span> (line <span class="line-number">47</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Layout object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Layout</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Layout
|
||||
</span>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">FileMaker_Implementation</span>
|
||||
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Implementation object that this layout was created through.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetDatabase" id="getDatabase"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getDatabase</span> (line <span class="line-number">67</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of the database that this layout is in.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Database name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getDatabase
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Field object that describes the specified field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</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.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">101</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the names of all fields as keys and FileMaker_Field objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FM_Field.html">FileMaker_Field</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSet" id="getRelatedSet"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSet</span> (line <span class="line-number">126</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_RelatedSet object that describes the specified portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> RelatedSet object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getRelatedSet
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the related table for a portal.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSets" id="getRelatedSets"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSets</span> (line <span class="line-number">137</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the related table names of all portals as keys and FileMaker_RelatedSet objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueList" id="getValueList"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueList</span> (line <span class="line-number">164</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of defined values in the specified value list.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of defined values.</li>
|
||||
<li><span class="field">see:</span> <a href="../FileMaker/FM_Layout.html#methodgetValueListTwoFields">FileMaker_Layout::getValueListTwoFields()</a></li>
|
||||
<li><span class="field">deprecated:</span> Use getValueListTwoFields instead.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueList
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$valueList</span><span class="var-description">: Name of value list.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueLists" id="getValueLists"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueLists</span> (line <span class="line-number">198</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a multi-level associative array of value lists.</p>
|
||||
<p class="description"><p>The top-level array has names of value lists as keys and arrays as values. The second level arrays are the lists of defined values from each value list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of value-list arrays.</li>
|
||||
<li><span class="field">see:</span> <a href="../FileMaker/FM_Layout.html#methodgetValueListsTwoFields">FileMaker_Layout::getValueListsTwoFields()</a></li>
|
||||
<li><span class="field">deprecated:</span> Use getValueListTwoFields instead.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueLists
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueListsTwoFields" id="getValueListsTwoFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueListsTwoFields</span> (line <span class="line-number">214</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a multi-level associative array of value lists.</p>
|
||||
<p class="description"><p>The top-level array has names of value lists as keys and associative arrays as values. The second level associative arrays are lists of display name and its corresponding value from the value list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of value-list associative arrays.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueListsTwoFields
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueListTwoFields" id="getValueListTwoFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueListTwoFields</span> (line <span class="line-number">180</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of defined values in the specified value list.</p>
|
||||
<p class="description"><p>This method supports single, 2nd only, and both fields value lists.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> of display names and its corresponding value from the value list.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueListTwoFields
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$valueList</span><span class="var-description">: Name of value list.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistFields" id="listFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listFields</span> (line <span class="line-number">77</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array with the names of all fields in this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistRelatedSets" id="listRelatedSets"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listRelatedSets</span> (line <span class="line-number">112</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of related table names for all portals on this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of related table names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistValueLists" id="listValueLists"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listValueLists</span> (line <span class="line-number">148</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the names of any value lists associated with this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of value list names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listValueLists
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Layout.php</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="file-name">/FileMaker/Layout.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>
|
||||
</td>
|
||||
<td>
|
||||
Layout description class. Contains all the information about a specific layout. Can be requested directly or returned as part of a result set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,602 @@
|
||||
<?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_Record</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_Record</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">Default Record class that represents each record of a result set.</p>
|
||||
<p class="description"><p>From a Record object, you can get field data, edit and delete the record, get its parent record, get its related record set, and create related records.</p><p>Instead of this class, you can specify a different class to use for Record objects. To specify the record class to use, open the FileMaker/conf/filemaker-api.php configuration file where the API is installed. Then set $__FM_CONFIG['recordClass'] to the name of the record class to use. The class you specify should be a subclass of the FileMaker_Record base class or encapsulate its functionality. In PHP 5, this class would implement an interface that alternate classes would be required to implement as well.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM_Record.php.html">/FileMaker/Record.php</a> (line <span class="field">40</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Record</span>
|
||||
<a href="#FileMaker_Record" title="details" class="method-name">FileMaker_Record</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#commit" title="details" class="method-name">commit</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Result.html">FileMaker_Result</a></span>
|
||||
<a href="#delete" title="details" class="method-name">delete</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getField" title="details" class="method-name">getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFieldAsTimestamp" title="details" class="method-name">getFieldAsTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getFieldUnencoded" title="details" class="method-name">getFieldUnencoded</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getModificationId" title="details" class="method-name">getModificationId</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getParent" title="details" class="method-name">&getParent</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getRecordId" title="details" class="method-name">getRecordId</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSet" title="details" class="method-name">&getRelatedSet</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#newRelatedRecord" title="details" class="method-name">&newRelatedRecord</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodFileMaker_Record" id="FileMaker_Record"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Record</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Record object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Record</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Record
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: Specify either the Layout object associated with this record or the Related Set object that this record is a member of.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodcommit" id="commit"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">commit</span> (line <span class="line-number">269</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Saves any changes to this record in the database on the Database Server.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> TRUE, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
commit
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddelete" id="delete"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">delete</span> (line <span class="line-number">279</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Deletes this record from the database on the Database Server.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Response 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">
|
||||
delete
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">99</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the HTML-encoded value of the specified field.</p>
|
||||
<p class="description"><p>This method converts some special characters in the field value to HTML entities. For example, '&', '"', '<', and '>' are converted to '&amp;', '&quot;', '&lt;', and '&gt;', respectively.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Encoded field value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFieldAsTimestamp" id="getFieldAsTimestamp"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFieldAsTimestamp</span> (line <span class="line-number">139</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the value of the specified field as a UNIX timestamp.</p>
|
||||
<p class="description"><p>If the field is a date field, the timestamp is for the field date at midnight. It the field is a time field, the timestamp is for that time on January 1, 1970. Timestamp (date and time) fields map directly to the UNIX timestamp. If the specified field is not a date or time field, or if the timestamp generated would be out of range, then this method returns a FileMaker_Error object instead.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Timestamp value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFieldAsTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">81</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a list of the names of all fields in the record.</p>
|
||||
<p class="description"><p>Only the field names are returned. If you need additional information, examine the Layout object provided by the parent object's <a href="../FileMaker/FM_Result.html#methodgetLayout">FileMaker_Result::getLayout()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFieldUnencoded" id="getFieldUnencoded"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFieldUnencoded</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the unencoded value of the specified field.</p>
|
||||
<p class="description"><p>This method does not convert special characters in the field value to HTML entities.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Unencoded field value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getFieldUnencoded
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">67</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the layout this record is associated with.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> This record's layout.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetModificationId" id="getModificationId"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getModificationId</span> (line <span class="line-number">197</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the modification ID of this record.</p>
|
||||
<p class="description"><p>The modification ID is an incremental counter that specifies the current version of a record. See the <a href="../FileMaker/FMC_Edit.html#methodsetModificationId">FileMaker_Command_Edit::setModificationId()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Modification ID.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getModificationId
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetParent" id="getParent"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getParent</span> (line <span class="line-number">231</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the parent record, if this record is a child record in a portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Parent record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&getParent
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecordId" id="getRecordId"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecordId</span> (line <span class="line-number">183</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the record ID of this object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record ID.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getRecordId
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSet" id="getRelatedSet"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSet</span> (line <span class="line-number">209</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any Record objects in the specified portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of FileMaker_Record objects from $relatedSet.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRelatedSet
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the portal to return records from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewRelatedRecord" id="newRelatedRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newRelatedRecord</span> (line <span class="line-number">221</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new record in the specified portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> A new, blank record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&newRelatedRecord
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the portal to create a new record in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">152</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the value of $field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: New value of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">173</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then returns an error. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</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">258</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validates either a single field or the entire record.</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 record is pre-validated as if commit() 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 for $value. 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 record.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Record.php</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="file-name">/FileMaker/Record.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM_Record.html">FileMaker_Record</a>
|
||||
</td>
|
||||
<td>
|
||||
Default Record class that represents each record of a result set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,225 @@
|
||||
<?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_RelatedSet</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_RelatedSet</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">Portal description class. Contains all the information about a specific set of related records defined by a portal on a layout.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM_RelatedSet.php.html">/FileMaker/RelatedSet.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_RelatedSet</span>
|
||||
<a href="#FileMaker_RelatedSet" title="details" class="method-name">FileMaker_RelatedSet</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<a href="#getField" title="details" class="method-name">&getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">&getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listFields" title="details" class="method-name">listFields</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="methodFileMaker_RelatedSet" id="FileMaker_RelatedSet"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_RelatedSet</span> (line <span class="line-number">45</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Portal constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_RelatedSet</span>
|
||||
<span class="method-name">
|
||||
FileMaker_RelatedSet
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: FileMaker_Layout object that this portal is on.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">79</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Field object that describes the specified field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FME.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</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.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the names of all fields as keys and FileMaker_Field objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FM_Field.html">FileMaker_Field</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">56</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of the related table from which this portal displays related records.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Name of related table for this portal.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistFields" id="listFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listFields</span> (line <span class="line-number">66</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of the names of all fields in this portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page RelatedSet.php</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="file-name">/FileMaker/RelatedSet.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM_RelatedSet.html">FileMaker_RelatedSet</a>
|
||||
</td>
|
||||
<td>
|
||||
Portal description class. Contains all the information about a specific set of related records defined by a portal on a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,368 @@
|
||||
<?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_Result</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_Result</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">Result set description class. Contains all the information about a set of records returned by a command.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="FM_Result.php.html">/FileMaker/Result.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Result</span>
|
||||
<a href="#FileMaker_Result" title="details" class="method-name">FileMaker_Result</a>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFetchCount" title="details" class="method-name">getFetchCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getFirstRecord" title="details" class="method-name">getFirstRecord</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFoundSetCount" title="details" class="method-name">getFoundSetCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getLastRecord" title="details" class="method-name">getLastRecord</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRecords" title="details" class="method-name">&getRecords</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSets" title="details" class="method-name">getRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getTableRecordCount" title="details" class="method-name">getTableRecordCount</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="methodFileMaker_Result" id="FileMaker_Result"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Result</span> (line <span class="line-number">44</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Result object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Result</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Result
|
||||
</span>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">FileMaker_Implementation</span>
|
||||
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Implementation object that this result came from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFetchCount" id="getFetchCount"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFetchCount</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the filtered result set.</p>
|
||||
<p class="description"><p>If no range parameters were specified on the Find command, then this value is equal to the result of the <a href="../FileMaker/FM_Result.html#methodgetFoundSetCount">getFoundSetCount()</a> method. It is always equal to the value of count($response-><a href="../FileMaker/FM_Result.html#methodgetRecords">getRecords()</a>).</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Filtered record count.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFetchCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">85</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a list of the names of all fields in the records in this result set.</p>
|
||||
<p class="description"><p>Only the field names are returned. If you need additional information, examine the Layout object provided by the <a href="../FileMaker/FM_Result.html#methodgetLayout">getLayout()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFirstRecord" id="getFirstRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFirstRecord</span> (line <span class="line-number">141</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the first record in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> First record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
getFirstRecord
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFoundSetCount" id="getFoundSetCount"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFoundSetCount</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the entire found set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Found record count.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFoundSetCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLastRecord" id="getLastRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLastRecord</span> (line <span class="line-number">151</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the last record in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Last record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
getLastRecord
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">55</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Layout object that describes the layout of this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FM_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecords" id="getRecords"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecords</span> (line <span class="line-number">70</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array containing each record in the result set.</p>
|
||||
<p class="description"><p>Each member of the array is a FileMaker_Record object, or an instance of the alternate class you specified to use for records (see <a href="../FileMaker/FM_Record.html">FileMaker_Record</a>. The array may be empty if the result set contains no records.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRecords
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSets" id="getRelatedSets"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSets</span> (line <span class="line-number">96</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the names of related tables for all portals present in records in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of related table names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetTableRecordCount" id="getTableRecordCount"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getTableRecordCount</span> (line <span class="line-number">106</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the table that was accessed.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Total record count in table.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getTableRecordCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Result.php</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="file-name">/FileMaker/Result.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FM_Result.html">FileMaker_Result</a>
|
||||
</td>
|
||||
<td>
|
||||
Result set description class. Contains all the information about a set of records returned by a command.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,965 @@
|
||||
<?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</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</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">Base FileMaker class. Defines database properties, connects to a database, and gets information about the API.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker.php.html">/FileMaker.php</a> (line <span class="field">87</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">
|
||||
static <span class="method-result">string</span>
|
||||
<a href="#getAPIVersion" title="details" class="method-name">getAPIVersion</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
static <span class="method-result">string</span>
|
||||
<a href="#getMinServerVersion" title="details" class="method-name">getMinServerVersion</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
static <span class="method-result">boolean</span>
|
||||
<a href="#isError" title="details" class="method-name">isError</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">FileMaker</span>
|
||||
<a href="#FileMaker" title="details" class="method-name">FileMaker</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$hostspec</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">NULL</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#createRecord" title="details" class="method-name">&createRecord</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$fieldValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getContainerData" title="details" class="method-name">getContainerData</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getContainerDataURL" title="details" class="method-name">getContainerDataURL</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getProperties" title="details" class="method-name">getProperties</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getProperty" title="details" class="method-name">getProperty</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#getRecordById" title="details" class="method-name">&getRecordById</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#listDatabases" title="details" class="method-name">listDatabases</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#listLayouts" title="details" class="method-name">listLayouts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#listScripts" title="details" class="method-name">listScripts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Add.html">FileMaker_Command_Add</a></span>
|
||||
<a href="#newAddCommand" title="details" class="method-name">&newAddCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_CompoundFind.html">FileMaker_Command_CompoundFind</a></span>
|
||||
<a href="#newCompoundFindCommand" title="details" class="method-name">&newCompoundFindCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Delete.html">FileMaker_Command_Delete</a></span>
|
||||
<a href="#newDeleteCommand" title="details" class="method-name">&newDeleteCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Duplicate.html">FileMaker_Command_Duplicate</a></span>
|
||||
<a href="#newDuplicateCommand" title="details" class="method-name">&newDuplicateCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Edit.html">FileMaker_Command_Edit</a></span>
|
||||
<a href="#newEditCommand" title="details" class="method-name">&newEditCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>, [<span class="var-type">array</span> <span class="var-name">$updatedValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindAll.html">FileMaker_Command_FindAll</a></span>
|
||||
<a href="#newFindAllCommand" title="details" class="method-name">&newFindAllCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindAny.html">FileMaker_Command_FindAny</a></span>
|
||||
<a href="#newFindAnyCommand" title="details" class="method-name">&newFindAnyCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a></span>
|
||||
<a href="#newFindCommand" title="details" class="method-name">&newFindCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindRequest.html">FileMaker_Command_FindRequest</a></span>
|
||||
<a href="#newFindRequest" title="details" class="method-name">&newFindRequest</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_PerformScript.html">FileMaker_Command_PerformScript</a></span>
|
||||
<a href="#newPerformScriptCommand" title="details" class="method-name">&newPerformScriptCommand</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setLogger" title="details" class="method-name">setLogger</a>
|
||||
(<span class="var-type">Log</span> <span class="var-name">&$logger</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setProperty" title="details" class="method-name">setProperty</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>, <span class="var-type">string</span> <span class="var-name">$value</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodgetAPIVersion" id="getAPIVersion"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method getAPIVersion</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the version of the FileMaker API for PHP.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> API version.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getAPIVersion
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetMinServerVersion" id="getMinServerVersion"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method getMinServerVersion</span> (line <span class="line-number">127</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the minimum version of FileMaker Server that this API works with.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Minimum FileMaker Server version.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getMinServerVersion
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisError" id="isError"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">static method isError</span> (line <span class="line-number">105</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Tests whether a variable is a FileMaker API Error.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> TRUE, if the variable is a <a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a> object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
static
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isError
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$variable</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$variable</span><span class="var-description">: Variable to test.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<a name="methodFileMaker" id="FileMaker"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker</span> (line <span class="line-number">150</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker object constructor.</p>
|
||||
<p class="description"><p>If you want to use the constructor without specifying all the parameters, pass in NULL for the parameters you want to omit. For example, to specify only the database name, username, and password, but omit the hostspec, call the constructor as follows:</p><p><samp>new FileMaker('DatabaseName', NULL, 'username', 'password');</samp></p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker</span>
|
||||
<span class="method-name">
|
||||
FileMaker
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$database</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$hostspec</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$username</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$password</span> = <span class="var-default">NULL</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$database</span><span class="var-description">: Name of the database to connect to.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$hostspec</span><span class="var-description">: Hostspec of web server in FileMaker Server deployment. Defaults to http://localhost, if set to NULL.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: Account name to log into database.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$password</span><span class="var-description">: Password for account.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodcreateRecord" id="createRecord"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">createRecord</span> (line <span class="line-number">357</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Record object.</p>
|
||||
<p class="description"><p>This method does not save the new record to the database. The record is not created on the Database Server until you call this record's commit() method. You must specify a layout name, and you can optionally specify an array of field values. Individual field values can also be set in the new record object.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Record object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&createRecord
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$fieldValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout to create a new record for.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$fieldValues</span><span class="var-description">: Initial values for the new record's fields.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetContainerData" id="getContainerData"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getContainerData</span> (line <span class="line-number">447</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the data for the specified container field.</p>
|
||||
<p class="description"><p>Pass in a URL string that represents the file path for the container field contents. For example, get the image data from a container field named 'Cover Image'. For a FileMaker_Record object named $record, URL-encode the path returned by the getField() method. For example:</p><p><samp><IMG src="img.php?-url=<?php echo urlencode($record->getField('Cover Image')); ?>"></samp></p><p>Then as shown below in a line from img.php, pass the URL into getContainerData() for the FileMaker object named $fm:</p><p><samp>echo $fm->getContainerData($_GET['-url']);</samp></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Raw field data|FileMaker_Error if remote container field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getContainerData
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$url</span><span class="var-description">: URL of the container field contents to get.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetContainerDataURL" id="getContainerDataURL"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getContainerDataURL</span> (line <span class="line-number">466</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the fully qualified URL for the specified container field.</p>
|
||||
<p class="description"><p>Pass in a URL string that represents the file path for the container field contents. For example, get the URL for a container field named 'Cover Image'. For example:</p><p><samp><IMG src="<?php echo $fm->getContainerDataURL($record->getField('Cover Image')); ?>"></samp></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Fully qualified URL to container field contents</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getContainerDataURL
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$url</span><span class="var-description">: URL of the container field contents to get.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">384</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a Layout object that describes the specified layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout or Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</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">: Name of the layout to describe.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetProperties" id="getProperties"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getProperties</span> (line <span class="line-number">186</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array of property name => property value for all current properties and their current values.</p>
|
||||
<p class="description"><p>This array enables PHP object introspection and debugging when necessary.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> All current properties.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getProperties
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetProperty" id="getProperty"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getProperty</span> (line <span class="line-number">173</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current value of a property.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Property's current value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getProperty
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$prop</span><span class="var-description">: Name of the property.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecordById" id="getRecordById"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecordById</span> (line <span class="line-number">372</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a single FileMaker_Record object matching the given layout and record ID, or a FileMaker_Error object, if this operation fails.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record or Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getRecordById
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout that $recordId is in.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to get.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistDatabases" id="listDatabases"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listDatabases</span> (line <span class="line-number">396</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of databases that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of database names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listDatabases
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistLayouts" id="listLayouts"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listLayouts</span> (line <span class="line-number">420</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of layouts from the current database that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of layout names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listLayouts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistScripts" id="listScripts"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listScripts</span> (line <span class="line-number">408</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of ScriptMaker scripts from the current database that are available with the current server settings and the current user name and password credentials.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of script names or an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
listScripts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewAddCommand" id="newAddCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newAddCommand</span> (line <span class="line-number">213</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Add object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Add command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Add.html">FileMaker_Command_Add</a></span>
|
||||
<span class="method-name">
|
||||
&newAddCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout to add a record to.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$values</span><span class="var-description">: Associative array of field name => value pairs. To set field repetitions, use a numerically indexed array for the value of a field, with the numeric keys corresponding to the repetition number to set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewCompoundFindCommand" id="newCompoundFindCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newCompoundFindCommand</span> (line <span class="line-number">283</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_CompoundFind object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Compound Find Set command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_CompoundFind.html">FileMaker_Command_CompoundFind</a></span>
|
||||
<span class="method-name">
|
||||
&newCompoundFindCommand
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewDeleteCommand" id="newDeleteCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newDeleteCommand</span> (line <span class="line-number">244</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Delete object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Delete command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Delete.html">FileMaker_Command_Delete</a></span>
|
||||
<span class="method-name">
|
||||
&newDeleteCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout to delete record from.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to delete.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewDuplicateCommand" id="newDuplicateCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newDuplicateCommand</span> (line <span class="line-number">257</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Duplicate object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Duplicate command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Duplicate.html">FileMaker_Command_Duplicate</a></span>
|
||||
<span class="method-name">
|
||||
&newDuplicateCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout that the record to duplicate is in.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to duplicate.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewEditCommand" id="newEditCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newEditCommand</span> (line <span class="line-number">231</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Edit object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Edit command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Edit.html">FileMaker_Command_Edit</a></span>
|
||||
<span class="method-name">
|
||||
&newEditCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</span>, <span class="var-type">string</span> <span class="var-name">$recordId</span>, [<span class="var-type">array</span> <span class="var-name">$updatedValues</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$layout</span><span class="var-description">: Layout that the record is part of.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recordId</span><span class="var-description">: ID of the record to edit.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$updatedValues</span><span class="var-description">: Associative array of field name => value pairs that contain the updated field values. To set field repetitions, use a numerically indexed array for the value of a field, with the numeric keys corresponding to the repetition number to set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindAllCommand" id="newFindAllCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindAllCommand</span> (line <span class="line-number">322</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindAll object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find All command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindAll.html">FileMaker_Command_FindAll</a></span>
|
||||
<span class="method-name">
|
||||
&newFindAllCommand
|
||||
</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 find all records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindAnyCommand" id="newFindAnyCommand"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindAnyCommand</span> (line <span class="line-number">310</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindAny object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find Any command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindAny.html">FileMaker_Command_FindAny</a></span>
|
||||
<span class="method-name">
|
||||
&newFindAnyCommand
|
||||
</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 find one random record from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindCommand" id="newFindCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindCommand</span> (line <span class="line-number">269</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_Find object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a></span>
|
||||
<span class="method-name">
|
||||
&newFindCommand
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewFindRequest" id="newFindRequest"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newFindRequest</span> (line <span class="line-number">298</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_FindRequest object. Add one or more Find Request objects to a <a href="../FileMaker/FileMaker_Command_CompoundFind.html">FileMaker_Command_CompoundFind</a> object, then execute the Compound Find command.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Find Request command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_FindRequest.html">FileMaker_Command_FindRequest</a></span>
|
||||
<span class="method-name">
|
||||
&newFindRequest
|
||||
</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 find records in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewPerformScriptCommand" id="newPerformScriptCommand"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newPerformScriptCommand</span> (line <span class="line-number">337</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new FileMaker_Command_PerformScript object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> New Perform Script command object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Command_PerformScript.html">FileMaker_Command_PerformScript</a></span>
|
||||
<span class="method-name">
|
||||
&newPerformScriptCommand
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$layout</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">$layout</span><span class="var-description">: Layout to use for script context.</span> </li>
|
||||
<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="methodsetLogger" id="setLogger"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setLogger</span> (line <span class="line-number">197</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Associates a PEAR Log object with the API for logging requests and responses.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setLogger
|
||||
</span>
|
||||
(<span class="var-type">Log</span> <span class="var-name">&$logger</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">Log</span>
|
||||
<span class="var-name">&$logger</span><span class="var-description">: PEAR Log object.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetProperty" id="setProperty"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setProperty</span> (line <span class="line-number">161</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a property to a new value for all API calls.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setProperty
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$prop</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$prop</span><span class="var-description">: Name of the property to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Property's new value.</span> </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>
|
||||
@@ -0,0 +1,397 @@
|
||||
<?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="_FileMaker---Command.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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_Command_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/FileMaker_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/FileMaker_Error_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/FileMaker_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/FileMaker_Error_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 Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,165 @@
|
||||
<?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_Add</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_Add</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">Command class that adds a new record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewAddCommand">FileMaker::newAddCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---Add.php.html">/FileMaker/Command/Add.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Add</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="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">62</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value to set for this field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set, Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">83</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then this method returns an Error object. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,314 @@
|
||||
<?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_CompoundFind</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_CompoundFind</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">Command class that performs multiple find requests, also known as a compound find set.</p>
|
||||
<p class="description"><p>Requests are executed in the order specified in the add() method. The found set includes the results of the entire compound find request. Create this command with <a href="../FileMaker/FileMaker.html#methodnewCompoundFindCommand">FileMaker::newCompoundFindCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---CompoundFind.php.html">/FileMaker/Command/CompoundFind.php</a> (line <span class="field">32</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_CompoundFind</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="#add" title="details" class="method-name">add</a>
|
||||
(<span class="var-type">int</span> <span class="var-name">$precedence</span>, <span class="var-type">findrequest</span> <span class="var-name">$findrequest</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#addSortRule" title="details" class="method-name">addSortRule</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearSortRules" title="details" class="method-name">clearSortRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRange" title="details" class="method-name">getRange</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSetsFilters" title="details" class="method-name">getRelatedSetsFilters</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRange" title="details" class="method-name">setRange</a>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRelatedSetsFilters" title="details" class="method-name">setRelatedSetsFilters</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodadd" id="add"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">add</span> (line <span class="line-number">63</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a Find Request object to this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
add
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$precedence</span>, <span class="var-type">findrequest</span> <span class="var-name">$findrequest</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Priority in which the find requests are added to this compound find set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">findrequest</span>
|
||||
<span class="var-name">$findrequest</span><span class="var-description">: FileMaker_FindRequest object to add to this compound find set.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodaddSortRule" id="addSortRule"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addSortRule</span> (line <span class="line-number">81</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a sorting rule to this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addSortRule
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</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 sort by.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Integer from 1 to 9, inclusive. A value of 1 sorts records based on this sorting rule first, a value of 2 sorts records based on this sorting rule only when two or more records have the same value after the first sorting rule is applied, and so on.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$order</span><span class="var-description">: Direction of the sort. Specify the FILEMAKER_SORT_ASCEND constant, the FILEMAKER_SORT_DESCEND constant, or the name of a value list specified as a string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearSortRules" id="clearSortRules"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearSortRules</span> (line <span class="line-number">89</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing sorting rules from this Compound Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearSortRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRange" id="getRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRange</span> (line <span class="line-number">114</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current range settings.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'skip' for the current skip setting, and 'max' for the current maximum number of records. If either key does not have a value, the returned value for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRange
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSetsFilters" id="getRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSetsFilters</span> (line <span class="line-number">145</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current settings for the related records filter and the maximum number of related records to return.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'relatedsetsfilter' for the portal filter setting, and 'relatedsetsmax' for the maximum number of records. If either key does not have a value, the returned for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSetsFilters
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRange" id="setRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRange</span> (line <span class="line-number">101</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a range to request only part of the result set.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRange
|
||||
</span>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$skip</span><span class="var-description">: Number of records to skip past. Default is 0.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$max</span><span class="var-description">: Maximum number of records to return. Default is all.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRelatedSetsFilters" id="setRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRelatedSetsFilters</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a filter to restrict the number of related records to return from a portal.</p>
|
||||
<p class="description"><p>For more information, see the description for the <a href="../FileMaker/FileMaker_Command_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a> method.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRelatedSetsFilters
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsfilter</span><span class="var-description">: Specify either 'layout' or 'none' to control filtering.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsmax</span><span class="var-description">: Maximum number of portal records to return.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_Delete</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_Delete</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that deletes a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewDeleteCommand">FileMaker::newDeleteCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---Delete.php.html">/FileMaker/Command/Delete.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Delete</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_Duplicate</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_Duplicate</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that duplicates a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewDuplicateCommand">FileMaker::newDuplicateCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---Duplicate.php.html">/FileMaker/Command/Duplicate.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Duplicate</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,197 @@
|
||||
<?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_Edit</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_Edit</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">Command class that edits a single record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewEditCommand">FileMaker::newEditCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---Edit.php.html">/FileMaker/Command/Edit.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Edit</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="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setModificationId" title="details" class="method-name">setModificationId</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$modificationId</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">65</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value for the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set, Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">86</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then this method returns an Error object. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetModificationId" id="setModificationId"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setModificationId</span> (line <span class="line-number">104</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the modification ID for this command.</p>
|
||||
<p class="description"><p>Before you edit a record, you can use the <a href="../FileMaker/FileMaker_Record.html#methodgetModificationId">FileMaker_Record::getModificationId()</a> method to get the record's modification ID. By specifying a modification ID when you execute an Edit command, you can make sure that you are editing the current version of a record. If the modification ID value you specify does not match the current modification ID value in the database, the Edit command is not allowed and an error code is returned.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setModificationId
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$modificationId</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$modificationId</span><span class="var-description">: Modification ID.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,414 @@
|
||||
<?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_Find</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_Find</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">Command class that finds records using the specified criteria.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewFindCommand">FileMaker::newFindCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---Find.php.html">/FileMaker/Command/Find.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_Find</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_Command_FindAll.html">FileMaker_Command_FindAll</a></td>
|
||||
<td>
|
||||
Command class that finds all records from a layout.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em"><a href="../FileMaker/FileMaker_Command_FindAny.html">FileMaker_Command_FindAny</a></td>
|
||||
<td>
|
||||
Command class that finds one random record.
|
||||
</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">void</span>
|
||||
<a href="#addFindCriterion" title="details" class="method-name">addFindCriterion</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#addSortRule" title="details" class="method-name">addSortRule</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearFindCriteria" title="details" class="method-name">clearFindCriteria</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearSortRules" title="details" class="method-name">clearSortRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRange" title="details" class="method-name">getRange</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSetsFilters" title="details" class="method-name">getRelatedSetsFilters</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setLogicalOperator" title="details" class="method-name">setLogicalOperator</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$operator</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRange" title="details" class="method-name">setRange</a>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setRelatedSetsFilters" title="details" class="method-name">setRelatedSetsFilters</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</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="methodaddFindCriterion" id="addFindCriterion"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addFindCriterion</span> (line <span class="line-number">58</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a criterion to this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addFindCriterion
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</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 being tested.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$testvalue</span><span class="var-description">: Value of field to test against.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodaddSortRule" id="addSortRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addSortRule</span> (line <span class="line-number">84</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a sorting rule to this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addSortRule
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">integer</span> <span class="var-name">$precedence</span>, [<span class="var-type">mixed</span> <span class="var-name">$order</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 sort by.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$precedence</span><span class="var-description">: Integer from 1 to 9, inclusive. A value of 1 sorts records based on this sorting rule first, a value of 2 sorts records based on this sorting rule only when two or more records have the same value after the first sorting rule is applied, and so on.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$order</span><span class="var-description">: Direction of the sort. Specify the FILEMAKER_SORT_ASCEND constant, the FILEMAKER_SORT_DESCEND constant, or the name of a value list specified as a string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearFindCriteria" id="clearFindCriteria"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearFindCriteria</span> (line <span class="line-number">66</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing criteria from this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearFindCriteria
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearSortRules" id="clearSortRules"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearSortRules</span> (line <span class="line-number">92</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing sorting rules from this Find command.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearSortRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRange" id="getRange"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRange</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current range settings.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'skip' for the current skip setting, and 'max' for the current maximum number of records. If either key does not have a value, the returned value for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRange
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSetsFilters" id="getRelatedSetsFilters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSetsFilters</span> (line <span class="line-number">177</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the current settings for the related records filter and the maximum number of related records to return.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Associative array with two keys: 'relatedsetsfilter' for the portal filter setting, and 'relatedsetsmax' for the maximum number of records. If either key does not have a value, the returned for that key is NULL.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSetsFilters
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetLogicalOperator" id="setLogicalOperator"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setLogicalOperator</span> (line <span class="line-number">106</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Specifies how the find criteria in this Find command are combined as either a logical AND or OR search.</p>
|
||||
<p class="description"><p>If not specified, the default is a logical AND.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setLogicalOperator
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$operator</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$operator</span><span class="var-description">: Specify the FILEMAKER_FIND_AND or FILEMAKER_FIND_OR constant.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRange" id="setRange"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRange</span> (line <span class="line-number">118</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a range to request only part of the result set.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRange
|
||||
</span>
|
||||
([<span class="var-type">integer</span> <span class="var-name">$skip</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$max</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$skip</span><span class="var-description">: Number of records to skip past. Default is 0.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$max</span><span class="var-description">: Maximum number of records to return. Default is all.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetRelatedSetsFilters" id="setRelatedSetsFilters"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setRelatedSetsFilters</span> (line <span class="line-number">163</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets a filter to restrict the number of related records to return from a portal.</p>
|
||||
<p class="description"><p>The filter limits the number of related records returned by respecting the settings specified in the FileMaker Pro Portal Setup dialog box.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setRelatedSetsFilters
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedsetsfilter</span>, [<span class="var-type">string</span> <span class="var-name">$relatedsetsmax</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsfilter</span><span class="var-description">: Specify one of these values to control filtering: <ul><li>'layout': Apply the settings specified in the FileMaker Pro
|
||||
Portal Setup dialog box. The records are sorted based
|
||||
on the sort defined in the Portal Setup dialog box,
|
||||
with the record set filtered to start with the
|
||||
specified "Initial row."</li><li>'none': Return all related records in the portal without
|
||||
filtering or presorting them.</li></ul></span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedsetsmax</span><span class="var-description">: If the "Show vertical scroll bar" setting is enabled in the Portal Setup dialog box, specify one of these values: <ul><li>an integer value: Return this maximum number of related records
|
||||
after the initial record.</li><li>'all': Return all of the related records in the portal.
|
||||
If "Show vertical scroll bar" is disabled, the Portal
|
||||
Setup dialog box's "Number of rows" setting determines
|
||||
the maximum number of related records to return.</li></ul></span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,92 @@
|
||||
<?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_FindAll</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_FindAll</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that finds all records from a layout.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewFindAllCommand">FileMaker::newFindAllCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---FindAll.php.html">/FileMaker/Command/FindAll.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--<a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a>
|
||||
|
|
||||
--FileMaker_Command_FindAll</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodaddFindCriterion">FileMaker_Command_Find::addFindCriterion()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodclearFindCriteria">FileMaker_Command_Find::clearFindCriteria()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodclearSortRules">FileMaker_Command_Find::clearSortRules()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodgetRange">FileMaker_Command_Find::getRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodgetRelatedSetsFilters">FileMaker_Command_Find::getRelatedSetsFilters()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetRange">FileMaker_Command_Find::setRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a></span><br>
|
||||
</blockquote>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,92 @@
|
||||
<?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_FindAny</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_FindAny</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that finds one random record.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewFindAnyCommand">FileMaker::newFindAnyCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---FindAny.php.html">/FileMaker/Command/FindAny.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--<a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a>
|
||||
|
|
||||
--FileMaker_Command_FindAny</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodaddFindCriterion">FileMaker_Command_Find::addFindCriterion()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodclearFindCriteria">FileMaker_Command_Find::clearFindCriteria()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodclearSortRules">FileMaker_Command_Find::clearSortRules()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodgetRange">FileMaker_Command_Find::getRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodgetRelatedSetsFilters">FileMaker_Command_Find::getRelatedSetsFilters()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetRange">FileMaker_Command_Find::setRange()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command_Find.html#methodsetRelatedSetsFilters">FileMaker_Command_Find::setRelatedSetsFilters()</a></span><br>
|
||||
</blockquote>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,166 @@
|
||||
<?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_FindRequest</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_FindRequest</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">Find Request class. Contains all the information about a single find request for a Compound Find command.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewFindRequest">FileMaker::newFindRequest()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---FindRequest.php.html">/FileMaker/Command/FindRequest.php</a> (line <span class="field">30</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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="#addFindCriterion" title="details" class="method-name">addFindCriterion</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#clearFindCriteria" title="details" class="method-name">clearFindCriteria</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setOmit" title="details" class="method-name">setOmit</a>
|
||||
(<span class="var-type">boolean</span> <span class="var-name">$value</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodaddFindCriterion" id="addFindCriterion"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">addFindCriterion</span> (line <span class="line-number">71</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Adds a criterion to this find request.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addFindCriterion
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldname</span>, <span class="var-type">string</span> <span class="var-name">$testvalue</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 being tested.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$testvalue</span><span class="var-description">: Value of the field to test against.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclearFindCriteria" id="clearFindCriteria"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">clearFindCriteria</span> (line <span class="line-number">79</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Clears all existing criteria from this find request.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
clearFindCriteria
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetOmit" id="setOmit"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setOmit</span> (line <span class="line-number">60</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets whether this request is an omit request.</p>
|
||||
<p class="description"><p>An omit request removes the matching records from the final result set.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setOmit
|
||||
</span>
|
||||
(<span class="var-type">boolean</span> <span class="var-name">$value</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: TRUE if this is an omit request. Otherwise, FALSE.</span> </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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?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_PerformScript</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_PerformScript</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-methods">Methods</a>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Command class that performs a ScriptMaker script.</p>
|
||||
<p class="description"><p>Create this command with <a href="../FileMaker/FileMaker.html#methodnewPerformScriptCommand">FileMaker::newPerformScriptCommand()</a>.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Command---PerformScript.php.html">/FileMaker/Command/PerformScript.php</a> (line <span class="field">29</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
|
|
||||
--FileMaker_Command_PerformScript</pre>
|
||||
|
||||
</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> |
|
||||
<span class="disabled">Methods</span>
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodexecute">FileMaker_Command::execute()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreCommandScript">FileMaker_Command::setPreCommandScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetPreSortScript">FileMaker_Command::setPreSortScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordClass">FileMaker_Command::setRecordClass()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetRecordId">FileMaker_Command::setRecordId()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetResultLayout">FileMaker_Command::setResultLayout()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodsetScript">FileMaker_Command::setScript()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Command.html#methodvalidate">FileMaker_Command::validate()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,235 @@
|
||||
<?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>
|
||||
@@ -0,0 +1,224 @@
|
||||
<?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="_FileMaker---Error---Validation.php.html">/FileMaker/Error/Validation.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre>PEAR_Error
|
||||
|
|
||||
--<a href="../FileMaker/FileMaker_Error.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/FileMaker_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="evenrow">
|
||||
|
||||
<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/FileMaker_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/FileMaker_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="oddrow">
|
||||
|
||||
<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="evenrow">
|
||||
|
||||
<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/FileMaker_Error.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="oddrow">
|
||||
|
||||
<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/FileMaker_Error.html">FileMaker_Error</a></span></p>
|
||||
<blockquote>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Error.html#methodFileMaker_Error">FileMaker_Error::FileMaker_Error()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Error.html#methodgetErrorString">FileMaker_Error::getErrorString()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Error.html#methodgetMessage">FileMaker_Error::getMessage()</a></span><br>
|
||||
<span class="method-name"><a href="../FileMaker/FileMaker_Error.html#methodisValidationError">FileMaker_Error::isValidationError()</a></span><br>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,621 @@
|
||||
<?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_Field</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_Field</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">Field description class. Contains all the information about a specific field on a layout.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Field.php.html">/FileMaker/Field.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Field</span>
|
||||
<a href="#FileMaker_Field" title="details" class="method-name">FileMaker_Field</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeLocalValidationRules" title="details" class="method-name">describeLocalValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeValidationRule" title="details" class="method-name">describeValidationRule</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#describeValidationRules" title="details" class="method-name">describeValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getLocalValidationRules" title="details" class="method-name">getLocalValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getRepetitionCount" title="details" class="method-name">getRepetitionCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getResult" title="details" class="method-name">getResult</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getStyleType" title="details" class="method-name">getStyleType</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getType" title="details" class="method-name">getType</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getValidationMask" title="details" class="method-name">getValidationMask</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValidationRules" title="details" class="method-name">getValidationRules</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueList" title="details" class="method-name">getValueList</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#hasValidationRule" title="details" class="method-name">hasValidationRule</a>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#isAutoEntered" title="details" class="method-name">isAutoEntered</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#isGlobal" title="details" class="method-name">isGlobal</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></span>
|
||||
<a href="#validate" title="details" class="method-name">validate</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$value</span>, [<span class="var-type"><a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></span> <span class="var-name">$error</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodFileMaker_Field" id="FileMaker_Field"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Field</span> (line <span class="line-number">44</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Field object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Field</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Field
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: Parent Layout object.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeLocalValidationRules" id="describeLocalValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeLocalValidationRules</span> (line <span class="line-number">201</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return an array of arrays containing the extra information for all pre-validation rules on this field that can be evaluated by the PHP engine.</p>
|
||||
<p class="description"><p>Rules such as "unique" and "exists" can be validated only on the Database Server and are not included in this list. Indexes of the outer array are FILEMAKER_RULE_* constants, and values are the same array returned by describeValidationRule().</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An associative array of all extra pre-validation information, with rule constants as indexes and extra information as the values.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeLocalValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeValidationRule" id="describeValidationRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeValidationRule</span> (line <span class="line-number">182</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any additional information for the specified pre-validation rule.</p>
|
||||
<p class="description"><p>Used for range rules and other rules that have additional pre-validation parameters.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Any extra information for $validationRule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeValidationRule
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$validationRule</span><span class="var-description">: FILEMAKER_RULE_* constant to get information for.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddescribeValidationRules" id="describeValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">describeValidationRules</span> (line <span class="line-number">213</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any additional information for all pre-validation rules.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An associative array of all extra pre-validation information, with FILEMAKER_RULE_* constants as keys and extra information as the values.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
describeValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">64</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the FileMaker_Layout object that contains this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLocalValidationRules" id="getLocalValidationRules"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLocalValidationRules</span> (line <span class="line-number">130</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of FILEMAKER_RULE_* constants for each rule set on this field that can be evaluated by the PHP engine.</p>
|
||||
<p class="description"><p>Rules such as "unique" and "exists" can only be pre-validated on the Database Server and are not included in this list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Local rule array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getLocalValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">54</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRepetitionCount" id="getRepetitionCount"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRepetitionCount</span> (line <span class="line-number">95</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the maximum number of repetitions for this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Maximum repetitions of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getRepetitionCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetResult" id="getResult"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getResult</span> (line <span class="line-number">224</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the result type of this field -- for example, 'text', 'number', 'date', 'time', 'timestamp', or 'container'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Result type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getResult
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetStyleType" id="getStyleType"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getStyleType</span> (line <span class="line-number">263</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the control style type of this field -- for example, 'EDITTEXT', 'POPUPLIST', 'POPUPMENU', 'CHECKBOX', 'RADIOBUTTONS' or 'CALENDAR'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Style type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getStyleType
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetType" id="getType"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getType</span> (line <span class="line-number">235</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the type of this field -- for example, 'normal', 'calculation', or 'summary'.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Type.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getType
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValidationMask" id="getValidationMask"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValidationMask</span> (line <span class="line-number">152</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the full additive bitmask of pre-validation rules for this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Rule bitmask.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getValidationMask
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValidationRules" id="getValidationRules"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValidationRules</span> (line <span class="line-number">141</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of FILEMAKER_RULE_* constants for each rule set on this field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Rule array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValidationRules
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueList" id="getValueList"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueList</span> (line <span class="line-number">251</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of choices from the value list associated with this field.</p>
|
||||
<p class="description"><p>If this field is not associated with a value list, this method returns NULL.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Value list array.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueList
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which to display the value list.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodhasValidationRule" id="hasValidationRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">hasValidationRule</span> (line <span class="line-number">165</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if the specified FILEMAKER_RULE_* constant matches the field's pre-validation bitmask. Otherwise, returns FALSE.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
hasValidationRule
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$validationRule</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$validationRule</span><span class="var-description">: Pre-validation rule constant to test.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisAutoEntered" id="isAutoEntered"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">isAutoEntered</span> (line <span class="line-number">75</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if data in this field is auto-entered or FALSE if it is entered manually.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Auto-entered status of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isAutoEntered
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodisGlobal" id="isGlobal"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">isGlobal</span> (line <span class="line-number">85</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if this field is global or FALSE if it is not.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Global status of this field.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isGlobal
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns TRUE if $value is valid for this field, or a FileMaker_Error_Validation object describing how pre-validation failed.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Result of field pre-validation on $value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></span>
|
||||
<span class="method-name">
|
||||
validate
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$value</span>, [<span class="var-type"><a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></span> <span class="var-name">$error</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: Value to pre-validate.</span> </li>
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FileMaker_Error_Validation.html">FileMaker_Error_Validation</a></span>
|
||||
<span class="var-name">$error</span><span class="var-description">: If pre-validation is being done on more than one field, you may pass validate() an existing error object to add pre-validation failures to.$error is not passed by reference, though, so you must catch the return value of validate() and use it as the new $error object. This method never overwrites an existing $error object with boolean TRUE.</span> </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>
|
||||
@@ -0,0 +1,524 @@
|
||||
<?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_Layout</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_Layout</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">Layout description class. Contains all the information about a specific layout. Can be requested directly or returned as part of a result set.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Layout.php.html">/FileMaker/Layout.php</a> (line <span class="field">30</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Layout</span>
|
||||
<a href="#FileMaker_Layout" title="details" class="method-name">FileMaker_Layout</a>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getDatabase" title="details" class="method-name">getDatabase</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#getField" title="details" class="method-name">getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">&getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#getRelatedSet" title="details" class="method-name">&getRelatedSet</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSets" title="details" class="method-name">&getRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueList" title="details" class="method-name">getValueList</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueLists" title="details" class="method-name">getValueLists</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueListsTwoFields" title="details" class="method-name">getValueListsTwoFields</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getValueListTwoFields" title="details" class="method-name">getValueListTwoFields</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listFields" title="details" class="method-name">listFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listRelatedSets" title="details" class="method-name">listRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listValueLists" title="details" class="method-name">listValueLists</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="methodFileMaker_Layout" id="FileMaker_Layout"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Layout</span> (line <span class="line-number">47</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Layout object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Layout</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Layout
|
||||
</span>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">FileMaker_Implementation</span>
|
||||
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Implementation object that this layout was created through.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetDatabase" id="getDatabase"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getDatabase</span> (line <span class="line-number">67</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of the database that this layout is in.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Database name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getDatabase
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Field object that describes the specified field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</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.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">101</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the names of all fields as keys and FileMaker_Field objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout name.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSet" id="getRelatedSet"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSet</span> (line <span class="line-number">126</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_RelatedSet object that describes the specified portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> RelatedSet object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getRelatedSet
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the related table for a portal.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSets" id="getRelatedSets"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSets</span> (line <span class="line-number">137</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the related table names of all portals as keys and FileMaker_RelatedSet objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueList" id="getValueList"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueList</span> (line <span class="line-number">166</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of defined values in the specified value list.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of defined values.</li>
|
||||
<li><span class="field">see:</span> <a href="../FileMaker/FileMaker_Layout.html#methodgetValueListTwoFields">FileMaker_Layout::getValueListTwoFields()</a></li>
|
||||
<li><span class="field">deprecated:</span> Use getValueListTwoFields instead.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueList
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$valueList</span><span class="var-description">: Name of value list.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueLists" id="getValueLists"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueLists</span> (line <span class="line-number">218</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a multi-level associative array of value lists.</p>
|
||||
<p class="description"><p>The top-level array has names of value lists as keys and arrays as values. The second level arrays are the lists of defined values from each value list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of value-list arrays.</li>
|
||||
<li><span class="field">see:</span> <a href="../FileMaker/FileMaker_Layout.html#methodgetValueListsTwoFields">FileMaker_Layout::getValueListsTwoFields()</a></li>
|
||||
<li><span class="field">deprecated:</span> Use getValueListTwoFields instead.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueLists
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueListsTwoFields" id="getValueListsTwoFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueListsTwoFields</span> (line <span class="line-number">247</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a multi-level associative array of value lists.</p>
|
||||
<p class="description"><p>The top-level array has names of value lists as keys and associative arrays as values. The second level associative arrays are lists of display name and its corresponding value from the value list.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of value-list associative arrays.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueListsTwoFields
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetValueListTwoFields" id="getValueListTwoFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getValueListTwoFields</span> (line <span class="line-number">195</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the list of defined values in the specified value list.</p>
|
||||
<p class="description"><p>This method supports single, 2nd only, and both fields value lists.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> of display names and its corresponding value from the value list.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getValueListTwoFields
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$valueList</span>, [<span class="var-type">string</span> <span class="var-name">$recid</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$valueList</span><span class="var-description">: Name of value list.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$recid</span><span class="var-description">: Record from which the value list should be displayed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistFields" id="listFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listFields</span> (line <span class="line-number">77</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array with the names of all fields in this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistRelatedSets" id="listRelatedSets"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listRelatedSets</span> (line <span class="line-number">112</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of related table names for all portals on this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of related table names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistValueLists" id="listValueLists"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listValueLists</span> (line <span class="line-number">148</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the names of any value lists associated with this layout.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of value list names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listValueLists
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,602 @@
|
||||
<?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_Record</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_Record</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">Default Record class that represents each record of a result set.</p>
|
||||
<p class="description"><p>From a Record object, you can get field data, edit and delete the record, get its parent record, get its related record set, and create related records.</p><p>Instead of this class, you can specify a different class to use for Record objects. To specify the record class to use, open the FileMaker/conf/filemaker-api.php configuration file where the API is installed. Then set $__FM_CONFIG['recordClass'] to the name of the record class to use. The class you specify should be a subclass of the FileMaker_Record base class or encapsulate its functionality. In PHP 5, this class would implement an interface that alternate classes would be required to implement as well.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Record.php.html">/FileMaker/Record.php</a> (line <span class="field">40</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Record</span>
|
||||
<a href="#FileMaker_Record" title="details" class="method-name">FileMaker_Record</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#commit" title="details" class="method-name">commit</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Result.html">FileMaker_Result</a></span>
|
||||
<a href="#delete" title="details" class="method-name">delete</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getField" title="details" class="method-name">getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFieldAsTimestamp" title="details" class="method-name">getFieldAsTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getFieldUnencoded" title="details" class="method-name">getFieldUnencoded</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getModificationId" title="details" class="method-name">getModificationId</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getParent" title="details" class="method-name">&getParent</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getRecordId" title="details" class="method-name">getRecordId</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSet" title="details" class="method-name">&getRelatedSet</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#newRelatedRecord" title="details" class="method-name">&newRelatedRecord</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setField" title="details" class="method-name">setField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setFieldFromTimestamp" title="details" class="method-name">setFieldFromTimestamp</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error_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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
|
||||
<a name="methodFileMaker_Record" id="FileMaker_Record"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Record</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Record object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Record</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Record
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>|<a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: Specify either the Layout object associated with this record or the Related Set object that this record is a member of.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodcommit" id="commit"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">commit</span> (line <span class="line-number">270</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Saves any changes to this record in the database on the Database Server.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> TRUE, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
commit
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methoddelete" id="delete"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">delete</span> (line <span class="line-number">280</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Deletes this record from the database on the Database Server.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Response object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Result.html">FileMaker_Result</a></span>
|
||||
<span class="method-name">
|
||||
delete
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">99</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the HTML-encoded value of the specified field.</p>
|
||||
<p class="description"><p>This method converts some special characters in the field value to HTML entities. For example, '&', '"', '<', and '>' are converted to '&amp;', '&quot;', '&lt;', and '&gt;', respectively.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Encoded field value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFieldAsTimestamp" id="getFieldAsTimestamp"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFieldAsTimestamp</span> (line <span class="line-number">139</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the value of the specified field as a UNIX timestamp.</p>
|
||||
<p class="description"><p>If the field is a date field, the timestamp is for the field date at midnight. It the field is a time field, the timestamp is for that time on January 1, 1970. Timestamp (date and time) fields map directly to the UNIX timestamp. If the specified field is not a date or time field, or if the timestamp generated would be out of range, then this method returns a FileMaker_Error object instead.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Timestamp value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFieldAsTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">81</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a list of the names of all fields in the record.</p>
|
||||
<p class="description"><p>Only the field names are returned. If you need additional information, examine the Layout object provided by the parent object's <a href="../FileMaker/FileMaker_Result.html#methodgetLayout">FileMaker_Result::getLayout()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFieldUnencoded" id="getFieldUnencoded"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFieldUnencoded</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the unencoded value of the specified field.</p>
|
||||
<p class="description"><p>This method does not convert special characters in the field value to HTML entities.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Unencoded field value.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getFieldUnencoded
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to get. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">67</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the layout this record is associated with.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> This record's layout.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetModificationId" id="getModificationId"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getModificationId</span> (line <span class="line-number">197</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the modification ID of this record.</p>
|
||||
<p class="description"><p>The modification ID is an incremental counter that specifies the current version of a record. See the <a href="../FileMaker/FileMaker_Command_Edit.html#methodsetModificationId">FileMaker_Command_Edit::setModificationId()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Modification ID.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getModificationId
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetParent" id="getParent"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getParent</span> (line <span class="line-number">232</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the parent record, if this record is a child record in a portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Parent record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&getParent
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecordId" id="getRecordId"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecordId</span> (line <span class="line-number">183</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the record ID of this object.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record ID.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getRecordId
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSet" id="getRelatedSet"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSet</span> (line <span class="line-number">210</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns any Record objects in the specified portal or a FileMaker_Error object if there are no related records</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of FileMaker_Record objects from $relatedSet|FileMaker_Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRelatedSet
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the portal to return records from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodnewRelatedRecord" id="newRelatedRecord"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">newRelatedRecord</span> (line <span class="line-number">222</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Creates a new record in the specified portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> A new, blank record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
&newRelatedRecord
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$relatedSet</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$relatedSet</span><span class="var-description">: Name of the portal to create a new record in.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetField" id="setField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setField</span> (line <span class="line-number">152</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the value of $field.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: New value of the field.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetFieldFromTimestamp" id="setFieldFromTimestamp"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setFieldFromTimestamp</span> (line <span class="line-number">173</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the new value for a date, time, or timestamp field from a UNIX timestamp value.</p>
|
||||
<p class="description"><p>If the field is not a date or time field, then returns an error. Otherwise, returns TRUE.</p><p>If layout data for the target of this command has not already been loaded, calling this method loads layout data so that the type of the field can be checked.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setFieldFromTimestamp
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$timestamp</span>, [<span class="var-type">integer</span> <span class="var-name">$repetition</span> = <span class="var-default">0</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$field</span><span class="var-description">: Name of the field to set.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$timestamp</span><span class="var-description">: Timestamp value.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$repetition</span><span class="var-description">: Field repetition number to set. Defaults to the first repetition.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodvalidate" id="validate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">validate</span> (line <span class="line-number">259</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validates either a single field or the entire record.</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 record is pre-validated as if commit() 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 for $value. Otherwise, an Error Validation object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean|<a href="../FileMaker/FileMaker_Error_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 record.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,225 @@
|
||||
<?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_RelatedSet</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_RelatedSet</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">Portal description class. Contains all the information about a specific set of related records defined by a portal on a layout.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---RelatedSet.php.html">/FileMaker/RelatedSet.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_RelatedSet</span>
|
||||
<a href="#FileMaker_RelatedSet" title="details" class="method-name">FileMaker_RelatedSet</a>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<a href="#getField" title="details" class="method-name">&getField</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">&getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">string</span>
|
||||
<a href="#getName" title="details" class="method-name">getName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#listFields" title="details" class="method-name">listFields</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="methodFileMaker_RelatedSet" id="FileMaker_RelatedSet"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_RelatedSet</span> (line <span class="line-number">45</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Portal constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_RelatedSet</span>
|
||||
<span class="method-name">
|
||||
FileMaker_RelatedSet
|
||||
</span>
|
||||
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="var-name">&$layout</span><span class="var-description">: FileMaker_Layout object that this portal is on.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetField" id="getField"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getField</span> (line <span class="line-number">79</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Field object that describes the specified field.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Field object, if successful. Otherwise, an Error object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
||||
<span class="method-name">
|
||||
&getField
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$fieldName</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.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an associative array with the names of all fields as keys and FileMaker_Field objects as the array values.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of <a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a> objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetName" id="getName"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getName</span> (line <span class="line-number">56</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name of the related table from which this portal displays related records.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Name of related table for this portal.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodlistFields" id="listFields"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">listFields</span> (line <span class="line-number">66</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array of the names of all fields in this portal.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
listFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,368 @@
|
||||
<?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_Result</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_Result</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">Result set description class. Contains all the information about a set of records returned by a command.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_FileMaker---Result.php.html">/FileMaker/Result.php</a> (line <span class="field">28</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></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">FileMaker_Result</span>
|
||||
<a href="#FileMaker_Result" title="details" class="method-name">FileMaker_Result</a>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFetchCount" title="details" class="method-name">getFetchCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getFields" title="details" class="method-name">getFields</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getFirstRecord" title="details" class="method-name">getFirstRecord</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getFoundSetCount" title="details" class="method-name">getFoundSetCount</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<a href="#getLastRecord" title="details" class="method-name">getLastRecord</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRecords" title="details" class="method-name">&getRecords</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getRelatedSets" title="details" class="method-name">getRelatedSets</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#getTableRecordCount" title="details" class="method-name">getTableRecordCount</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="methodFileMaker_Result" id="FileMaker_Result"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor FileMaker_Result</span> (line <span class="line-number">44</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Result object constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">FileMaker_Result</span>
|
||||
<span class="method-name">
|
||||
FileMaker_Result
|
||||
</span>
|
||||
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">FileMaker_Implementation</span>
|
||||
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Implementation object that this result came from.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFetchCount" id="getFetchCount"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFetchCount</span> (line <span class="line-number">131</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the filtered result set.</p>
|
||||
<p class="description"><p>If no range parameters were specified on the Find command, then this value is equal to the result of the <a href="../FileMaker/FileMaker_Result.html#methodgetFoundSetCount">getFoundSetCount()</a> method. It is always equal to the value of count($response-><a href="../FileMaker/FileMaker_Result.html#methodgetRecords">getRecords()</a>).</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Filtered record count.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFetchCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFields" id="getFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFields</span> (line <span class="line-number">85</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a list of the names of all fields in the records in this result set.</p>
|
||||
<p class="description"><p>Only the field names are returned. If you need additional information, examine the Layout object provided by the <a href="../FileMaker/FileMaker_Result.html#methodgetLayout">getLayout()</a> method.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of field names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getFields
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFirstRecord" id="getFirstRecord"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFirstRecord</span> (line <span class="line-number">141</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the first record in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> First record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
getFirstRecord
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetFoundSetCount" id="getFoundSetCount"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getFoundSetCount</span> (line <span class="line-number">116</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the entire found set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Found record count.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getFoundSetCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLastRecord" id="getLastRecord"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLastRecord</span> (line <span class="line-number">151</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the last record in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Last record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
||||
<span class="method-name">
|
||||
getLastRecord
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getLayout</span> (line <span class="line-number">55</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a FileMaker_Layout object that describes the layout of this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Layout object.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
||||
<span class="method-name">
|
||||
&getLayout
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRecords" id="getRecords"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRecords</span> (line <span class="line-number">70</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an array containing each record in the result set.</p>
|
||||
<p class="description"><p>Each member of the array is a FileMaker_Record object, or an instance of the alternate class you specified to use for records (see <a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a>. The array may be empty if the result set contains no records.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Record objects.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&getRecords
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetRelatedSets" id="getRelatedSets"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getRelatedSets</span> (line <span class="line-number">96</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the names of related tables for all portals present in records in this result set.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> List of related table names as strings.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getRelatedSets
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetTableRecordCount" id="getTableRecordCount"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getTableRecordCount</span> (line <span class="line-number">106</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the number of records in the table that was accessed.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Total record count in table.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
getTableRecordCount
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Add.php</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="file-name">/FileMaker/Command/Add.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_Add.html">FileMaker_Command_Add</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that adds a new record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page CompoundFind.php</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="file-name">/FileMaker/Command/CompoundFind.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_CompoundFind.html">FileMaker_Command_CompoundFind</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that performs multiple find requests, also known as a compound find set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Delete.php</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="file-name">/FileMaker/Command/Delete.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_Delete.html">FileMaker_Command_Delete</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that deletes a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Duplicate.php</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="file-name">/FileMaker/Command/Duplicate.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_Duplicate.html">FileMaker_Command_Duplicate</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that duplicates a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Edit.php</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="file-name">/FileMaker/Command/Edit.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_Edit.html">FileMaker_Command_Edit</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that edits a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Find.php</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="file-name">/FileMaker/Command/Find.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_Find.html">FileMaker_Command_Find</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds records using the specified criteria.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindAll.php</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="file-name">/FileMaker/Command/FindAll.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_FindAll.html">FileMaker_Command_FindAll</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds all records from a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindAny.php</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="file-name">/FileMaker/Command/FindAny.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_FindAny.html">FileMaker_Command_FindAny</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that finds one random record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page FindRequest.php</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="file-name">/FileMaker/Command/FindRequest.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_FindRequest.html">FileMaker_Command_FindRequest</a>
|
||||
</td>
|
||||
<td>
|
||||
Find Request class. Contains all the information about a single find request for a Compound Find command.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page PerformScript.php</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="file-name">/FileMaker/Command/PerformScript.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command_PerformScript.html">FileMaker_Command_PerformScript</a>
|
||||
</td>
|
||||
<td>
|
||||
Command class that performs a ScriptMaker script.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Command.php</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="file-name">/FileMaker/Command.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Command.html">FileMaker_Command</a>
|
||||
</td>
|
||||
<td>
|
||||
Base Command class. Represents commands that add records, delete records, duplicate records, edit records, perform find requests, and perform ScriptMaker scripts.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:21 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Validation.php</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="file-name">/FileMaker/Error/Validation.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page de.php</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="file-name">/FileMaker/Error/de.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - German translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page en.php</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="file-name">/FileMaker/Error/en.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - English translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page fr.php</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="file-name">/FileMaker/Error/fr.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - French translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page it.php</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="file-name">/FileMaker/Error/it.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Italian translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page ja.php</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="file-name">/FileMaker/Error/ja.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Japanese translations.</p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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 page sv.php</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="file-name">/FileMaker/Error/sv.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker error codes - Swedish translations.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Error.php</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="file-name">/FileMaker/Error.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a>
|
||||
</td>
|
||||
<td>
|
||||
Extension of the PEAR_Error class for use in all FileMaker classes.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Field.php</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="file-name">/FileMaker/Field.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>
|
||||
</td>
|
||||
<td>
|
||||
Field description class. Contains all the information about a specific field on a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Layout.php</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="file-name">/FileMaker/Layout.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a>
|
||||
</td>
|
||||
<td>
|
||||
Layout description class. Contains all the information about a specific layout. Can be requested directly or returned as part of a result set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Record.php</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="file-name">/FileMaker/Record.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a>
|
||||
</td>
|
||||
<td>
|
||||
Default Record class that represents each record of a result set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page RelatedSet.php</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="file-name">/FileMaker/RelatedSet.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_RelatedSet.html">FileMaker_RelatedSet</a>
|
||||
</td>
|
||||
<td>
|
||||
Portal description class. Contains all the information about a specific set of related records defined by a portal on a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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 page Result.php</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="file-name">/FileMaker/Result.php</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-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker_Result.html">FileMaker_Result</a>
|
||||
</td>
|
||||
<td>
|
||||
Result set description class. Contains all the information about a set of records returned by a command.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,36 @@
|
||||
<?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 page filemaker-api.php</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="file-name">/FileMaker/conf/filemaker-api.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP configuration file.</p>
|
||||
<p class="description"><p>All settings are in the $__FM_CONFIG array to maintain a clean global namespace.</p></p>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,513 @@
|
||||
<?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 page FileMaker.php</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="file-name">/FileMaker.php</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-classes">Classes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker API for PHP</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-constants">Constants</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; vertical-align: top">
|
||||
<a href="../FileMaker/FileMaker.html">FileMaker</a>
|
||||
</td>
|
||||
<td>
|
||||
Base FileMaker class. Defines database properties, connects to a database, and gets information about the API.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineFILEMAKER_FIND_AND"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_AND</span> = 'and'
|
||||
(line <span class="line-number">47</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find logical operator constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FileMaker_Command_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a> method.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_CHAR"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_CHAR</span> = '@'
|
||||
(line <span class="line-number">34</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_CHAR_WILDCARD"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_CHAR_WILDCARD</span> = '*'
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_DIGIT"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_DIGIT</span> = '#'
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_DUPLICATES"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_DUPLICATES</span> = '!'
|
||||
(line <span class="line-number">31</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_FIELDMATCH"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_FIELDMATCH</span> = '=='
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_GT"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_GT</span> = '>'
|
||||
(line <span class="line-number">28</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_GTE"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_GTE</span> = '>='
|
||||
(line <span class="line-number">29</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_INVALID_DATETIME"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_INVALID_DATETIME</span> = '?'
|
||||
(line <span class="line-number">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LITERAL"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LITERAL</span> = '""'
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LT"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LT</span> = '<'
|
||||
(line <span class="line-number">26</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_LTE"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_LTE</span> = '<='
|
||||
(line <span class="line-number">27</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_OR"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_OR</span> = 'or'
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find logical operator constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FileMaker_Command_Find.html#methodsetLogicalOperator">FileMaker_Command_Find::setLogicalOperator()</a> method.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_RANGE"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_RANGE</span> = '...'
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_RELAXED"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_RELAXED</span> = '~'
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_FIND_TODAY"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_FIND_TODAY</span> = '//'
|
||||
(line <span class="line-number">32</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Find constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_DEBUG"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_DEBUG</span> = 7
|
||||
(line <span class="line-number">78</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_ERR"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_ERR</span> = 3
|
||||
(line <span class="line-number">76</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_LOG_INFO"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_LOG_INFO</span> = 6
|
||||
(line <span class="line-number">77</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Logging level constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_DATE_FIELD"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_DATE_FIELD</span> = 7
|
||||
(line <span class="line-number">60</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_FOURDIGITYEAR"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_FOURDIGITYEAR</span> = 4
|
||||
(line <span class="line-number">57</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_MAXCHARACTERS"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_MAXCHARACTERS</span> = 3
|
||||
(line <span class="line-number">56</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_NOTEMPTY"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_NOTEMPTY</span> = 1
|
||||
(line <span class="line-number">54</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_NUMERICONLY"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_NUMERICONLY</span> = 2
|
||||
(line <span class="line-number">55</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIMEOFDAY"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIMEOFDAY</span> = 5
|
||||
(line <span class="line-number">58</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIMESTAMP_FIELD"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIMESTAMP_FIELD</span> = 6
|
||||
(line <span class="line-number">59</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_RULE_TIME_FIELD"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_RULE_TIME_FIELD</span> = 8
|
||||
(line <span class="line-number">61</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Pre-validation rule constants.</p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_SORT_ASCEND"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_SORT_ASCEND</span> = 'ascend'
|
||||
(line <span class="line-number">69</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sort direction constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FileMaker_Command_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a> and <a href="../FileMaker/FileMaker_Command_CompoundFind.html#methodaddSortRule">FileMaker_Command_CompoundFind::addSortRule()</a> methods.</p></p>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="defineFILEMAKER_SORT_DESCEND"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">FILEMAKER_SORT_DESCEND</span> = 'descend'
|
||||
(line <span class="line-number">70</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sort direction constants.</p>
|
||||
<p class="description"><p>Use with the <a href="../FileMaker/FileMaker_Command_Find.html#methodaddSortRule">FileMaker_Command_Find::addSortRule()</a> and <a href="../FileMaker/FileMaker_Command_CompoundFind.html#methodaddSortRule">FileMaker_Command_CompoundFind::addSortRule()</a> methods.</p></p>
|
||||
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,103 @@
|
||||
<?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 page Add.php</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="file-name">/FileMaker/Command/Add.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Add.html">FileMaker_Command_Add</a>
|
||||
</td>
|
||||
<td>
|
||||
Add a new record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:00 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page CompoundFind.php</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="file-name">/FileMaker/Command/CompoundFind.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_CompoundFind.html">FileMaker_Command_CompoundFind</a>
|
||||
</td>
|
||||
<td>
|
||||
A set of find requests, also known as a compound find set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:02 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page Delete.php</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="file-name">/FileMaker/Command/Delete.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Delete.html">FileMaker_Command_Delete</a>
|
||||
</td>
|
||||
<td>
|
||||
Delete a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:03 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page Duplicate.php</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="file-name">/FileMaker/Command/Duplicate.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Duplicate.html">FileMaker_Command_Duplicate</a>
|
||||
</td>
|
||||
<td>
|
||||
Duplicates a single record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:04 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,103 @@
|
||||
<?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 page Edit.php</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="file-name">/FileMaker/Command/Edit.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Edit.html">FileMaker_Command_Edit</a>
|
||||
</td>
|
||||
<td>
|
||||
Edit a single record and/or some of its child records.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:04 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page FindAll.php</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="file-name">/FileMaker/Command/FindAll.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindAll.html">FileMaker_Command_FindAll</a>
|
||||
</td>
|
||||
<td>
|
||||
Find all records in a layout.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:09 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page FindAny.php</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="file-name">/FileMaker/Command/FindAny.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindAny.html">FileMaker_Command_FindAny</a>
|
||||
</td>
|
||||
<td>
|
||||
Find a random record.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:10 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page FindRequest.php</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="file-name">/FileMaker/Command/FindRequest.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_FindRequest.html">FileMaker_Command_FindRequest</a>
|
||||
</td>
|
||||
<td>
|
||||
Individual find requests that belong to a compound find.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:11 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,103 @@
|
||||
<?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 page Find.php</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="file-name">/FileMaker/Command/Find.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_Find.html">FileMaker_Command_Find</a>
|
||||
</td>
|
||||
<td>
|
||||
Find records.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:08 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<?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 page PerformScript.php</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="file-name">/FileMaker/Command/PerformScript.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">FileMaker PHP API.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</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; vertical-align: top">
|
||||
<a href="../FileMaker/FMC_PerformScript.html">FileMaker_Command_PerformScript</a>
|
||||
</td>
|
||||
<td>
|
||||
Perform a script.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">19</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Include parent and delegate classesa.</p>
|
||||
|
||||
</div>
|
||||
<a name="___FILE__"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">__FILE__</span>)
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 11 May 2006 08:42:12 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user